@seamapi/types 1.48.0 → 1.50.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 +333 -38
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +477 -17
- package/lib/seam/connect/openapi.d.ts +269 -3
- package/lib/seam/connect/openapi.js +332 -37
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +208 -14
- package/lib/seam/connect/unstable/model-types.d.ts +1 -1
- package/lib/seam/connect/unstable/models/access-codes/managed-access-code.js +81 -21
- package/lib/seam/connect/unstable/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/unstable/models/acs/credential.d.ts +7 -4
- package/lib/seam/connect/unstable/models/acs/credential.js +2 -1
- package/lib/seam/connect/unstable/models/acs/credential.js.map +1 -1
- package/lib/seam/connect/unstable/models/acs/credential_pool.d.ts +29 -0
- package/lib/seam/connect/unstable/models/acs/credential_pool.js +12 -0
- package/lib/seam/connect/unstable/models/acs/credential_pool.js.map +1 -0
- package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.d.ts +21 -0
- package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.js +9 -0
- package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.js.map +1 -0
- package/lib/seam/connect/unstable/models/acs/index.d.ts +2 -0
- package/lib/seam/connect/unstable/models/acs/index.js +2 -0
- package/lib/seam/connect/unstable/models/acs/index.js.map +1 -1
- package/lib/seam/connect/unstable/models/devices/managed-device.d.ts +14 -14
- package/lib/seam/connect/unstable/models/devices/managed-device.js +1 -1
- package/lib/seam/connect/unstable/models/devices/managed-device.js.map +1 -1
- package/lib/seam/connect/unstable/schemas.d.ts +1 -1
- package/lib/seam/connect/unstable/schemas.js +1 -1
- package/lib/seam/connect/unstable/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +357 -37
- package/src/lib/seam/connect/route-types.ts +208 -14
- package/src/lib/seam/connect/unstable/model-types.ts +2 -0
- package/src/lib/seam/connect/unstable/models/access-codes/managed-access-code.ts +113 -21
- package/src/lib/seam/connect/unstable/models/acs/credential.ts +2 -1
- package/src/lib/seam/connect/unstable/models/acs/credential_pool.ts +19 -0
- package/src/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.ts +13 -0
- package/src/lib/seam/connect/unstable/models/acs/index.ts +2 -0
- package/src/lib/seam/connect/unstable/models/devices/managed-device.ts +1 -1
- package/src/lib/seam/connect/unstable/schemas.ts +3 -0
package/dist/connect.d.cts
CHANGED
|
@@ -81,81 +81,102 @@ declare const _default: {
|
|
|
81
81
|
access_code: {
|
|
82
82
|
properties: {
|
|
83
83
|
access_code_id: {
|
|
84
|
+
description: string;
|
|
84
85
|
format: string;
|
|
85
86
|
type: string;
|
|
86
87
|
};
|
|
87
88
|
code: {
|
|
89
|
+
description: string;
|
|
88
90
|
nullable: boolean;
|
|
89
91
|
type: string;
|
|
90
92
|
};
|
|
91
93
|
common_code_key: {
|
|
94
|
+
description: string;
|
|
92
95
|
nullable: boolean;
|
|
93
96
|
type: string;
|
|
94
97
|
};
|
|
95
98
|
created_at: {
|
|
99
|
+
description: string;
|
|
96
100
|
format: string;
|
|
97
101
|
type: string;
|
|
98
102
|
};
|
|
99
103
|
device_id: {
|
|
104
|
+
description: string;
|
|
100
105
|
format: string;
|
|
101
106
|
type: string;
|
|
102
107
|
};
|
|
103
108
|
ends_at: {
|
|
109
|
+
description: string;
|
|
104
110
|
format: string;
|
|
105
111
|
nullable: boolean;
|
|
106
112
|
type: string;
|
|
107
113
|
};
|
|
108
114
|
errors: {
|
|
115
|
+
description: string;
|
|
109
116
|
nullable: boolean;
|
|
110
117
|
};
|
|
111
118
|
is_backup: {
|
|
119
|
+
description: string;
|
|
112
120
|
type: string;
|
|
113
121
|
};
|
|
114
122
|
is_backup_access_code_available: {
|
|
123
|
+
description: string;
|
|
115
124
|
type: string;
|
|
116
125
|
};
|
|
117
126
|
is_external_modification_allowed: {
|
|
127
|
+
description: string;
|
|
118
128
|
type: string;
|
|
119
129
|
};
|
|
120
130
|
is_managed: {
|
|
131
|
+
description: string;
|
|
121
132
|
enum: boolean[];
|
|
122
133
|
type: string;
|
|
123
134
|
};
|
|
124
135
|
is_offline_access_code: {
|
|
136
|
+
description: string;
|
|
125
137
|
type: string;
|
|
126
138
|
};
|
|
127
139
|
is_one_time_use: {
|
|
140
|
+
description: string;
|
|
128
141
|
type: string;
|
|
129
142
|
};
|
|
130
143
|
is_scheduled_on_device: {
|
|
144
|
+
description: string;
|
|
131
145
|
type: string;
|
|
132
146
|
};
|
|
133
147
|
is_waiting_for_code_assignment: {
|
|
148
|
+
description: string;
|
|
134
149
|
type: string;
|
|
135
150
|
};
|
|
136
151
|
name: {
|
|
152
|
+
description: string;
|
|
137
153
|
nullable: boolean;
|
|
138
154
|
type: string;
|
|
139
155
|
};
|
|
140
156
|
pulled_backup_access_code_id: {
|
|
157
|
+
description: string;
|
|
141
158
|
format: string;
|
|
142
159
|
nullable: boolean;
|
|
143
160
|
type: string;
|
|
144
161
|
};
|
|
145
162
|
starts_at: {
|
|
163
|
+
description: string;
|
|
146
164
|
format: string;
|
|
147
165
|
nullable: boolean;
|
|
148
166
|
type: string;
|
|
149
167
|
};
|
|
150
168
|
status: {
|
|
169
|
+
description: string;
|
|
151
170
|
enum: string[];
|
|
152
171
|
type: string;
|
|
153
172
|
};
|
|
154
173
|
type: {
|
|
174
|
+
description: string;
|
|
155
175
|
enum: string[];
|
|
156
176
|
type: string;
|
|
157
177
|
};
|
|
158
178
|
warnings: {
|
|
179
|
+
description: string;
|
|
159
180
|
nullable: boolean;
|
|
160
181
|
};
|
|
161
182
|
};
|
|
@@ -754,9 +775,6 @@ declare const _default: {
|
|
|
754
775
|
};
|
|
755
776
|
model: {
|
|
756
777
|
properties: {
|
|
757
|
-
access_codes_supported: {
|
|
758
|
-
type: string;
|
|
759
|
-
};
|
|
760
778
|
accessory_keypad_supported: {
|
|
761
779
|
type: string;
|
|
762
780
|
};
|
|
@@ -769,6 +787,9 @@ declare const _default: {
|
|
|
769
787
|
offline_access_codes_supported: {
|
|
770
788
|
type: string;
|
|
771
789
|
};
|
|
790
|
+
online_access_codes_supported: {
|
|
791
|
+
type: string;
|
|
792
|
+
};
|
|
772
793
|
};
|
|
773
794
|
required: string[];
|
|
774
795
|
type: string;
|
|
@@ -2092,27 +2113,33 @@ declare const _default: {
|
|
|
2092
2113
|
unmanaged_access_code: {
|
|
2093
2114
|
properties: {
|
|
2094
2115
|
access_code_id: {
|
|
2116
|
+
description: string;
|
|
2095
2117
|
format: string;
|
|
2096
2118
|
type: string;
|
|
2097
2119
|
};
|
|
2098
2120
|
code: {
|
|
2121
|
+
description: string;
|
|
2099
2122
|
nullable: boolean;
|
|
2100
2123
|
type: string;
|
|
2101
2124
|
};
|
|
2102
2125
|
created_at: {
|
|
2126
|
+
description: string;
|
|
2103
2127
|
format: string;
|
|
2104
2128
|
type: string;
|
|
2105
2129
|
};
|
|
2106
2130
|
device_id: {
|
|
2131
|
+
description: string;
|
|
2107
2132
|
format: string;
|
|
2108
2133
|
type: string;
|
|
2109
2134
|
};
|
|
2110
2135
|
ends_at: {
|
|
2136
|
+
description: string;
|
|
2111
2137
|
format: string;
|
|
2112
2138
|
nullable: boolean;
|
|
2113
2139
|
type: string;
|
|
2114
2140
|
};
|
|
2115
2141
|
errors: {
|
|
2142
|
+
description: string;
|
|
2116
2143
|
nullable: boolean;
|
|
2117
2144
|
};
|
|
2118
2145
|
is_managed: {
|
|
@@ -2120,10 +2147,12 @@ declare const _default: {
|
|
|
2120
2147
|
type: string;
|
|
2121
2148
|
};
|
|
2122
2149
|
name: {
|
|
2150
|
+
description: string;
|
|
2123
2151
|
nullable: boolean;
|
|
2124
2152
|
type: string;
|
|
2125
2153
|
};
|
|
2126
2154
|
starts_at: {
|
|
2155
|
+
description: string;
|
|
2127
2156
|
format: string;
|
|
2128
2157
|
nullable: boolean;
|
|
2129
2158
|
type: string;
|
|
@@ -2133,10 +2162,12 @@ declare const _default: {
|
|
|
2133
2162
|
type: string;
|
|
2134
2163
|
};
|
|
2135
2164
|
type: {
|
|
2165
|
+
description: string;
|
|
2136
2166
|
enum: string[];
|
|
2137
2167
|
type: string;
|
|
2138
2168
|
};
|
|
2139
2169
|
warnings: {
|
|
2170
|
+
description: string;
|
|
2140
2171
|
nullable: boolean;
|
|
2141
2172
|
};
|
|
2142
2173
|
};
|
|
@@ -4472,6 +4503,213 @@ declare const _default: {
|
|
|
4472
4503
|
'x-fern-sdk-method-name': string;
|
|
4473
4504
|
};
|
|
4474
4505
|
};
|
|
4506
|
+
'/acs/credential_pools/list': {
|
|
4507
|
+
post: {
|
|
4508
|
+
operationId: string;
|
|
4509
|
+
requestBody: {
|
|
4510
|
+
content: {
|
|
4511
|
+
'application/json': {
|
|
4512
|
+
schema: {
|
|
4513
|
+
properties: {
|
|
4514
|
+
acs_system_id: {
|
|
4515
|
+
format: string;
|
|
4516
|
+
type: string;
|
|
4517
|
+
};
|
|
4518
|
+
};
|
|
4519
|
+
required: string[];
|
|
4520
|
+
type: string;
|
|
4521
|
+
};
|
|
4522
|
+
};
|
|
4523
|
+
};
|
|
4524
|
+
};
|
|
4525
|
+
responses: {
|
|
4526
|
+
200: {
|
|
4527
|
+
content: {
|
|
4528
|
+
'application/json': {
|
|
4529
|
+
schema: {
|
|
4530
|
+
properties: {
|
|
4531
|
+
acs_credential_pools: {
|
|
4532
|
+
items: {
|
|
4533
|
+
properties: {
|
|
4534
|
+
acs_credential_pool_id: {
|
|
4535
|
+
format: string;
|
|
4536
|
+
type: string;
|
|
4537
|
+
};
|
|
4538
|
+
acs_system_id: {
|
|
4539
|
+
format: string;
|
|
4540
|
+
type: string;
|
|
4541
|
+
};
|
|
4542
|
+
created_at: {
|
|
4543
|
+
format: string;
|
|
4544
|
+
type: string;
|
|
4545
|
+
};
|
|
4546
|
+
display_name: {
|
|
4547
|
+
minLength: number;
|
|
4548
|
+
type: string;
|
|
4549
|
+
};
|
|
4550
|
+
external_type: {
|
|
4551
|
+
enum: string[];
|
|
4552
|
+
type: string;
|
|
4553
|
+
};
|
|
4554
|
+
external_type_display_name: {
|
|
4555
|
+
type: string;
|
|
4556
|
+
};
|
|
4557
|
+
workspace_id: {
|
|
4558
|
+
format: string;
|
|
4559
|
+
type: string;
|
|
4560
|
+
};
|
|
4561
|
+
};
|
|
4562
|
+
required: string[];
|
|
4563
|
+
type: string;
|
|
4564
|
+
};
|
|
4565
|
+
type: string;
|
|
4566
|
+
};
|
|
4567
|
+
ok: {
|
|
4568
|
+
type: string;
|
|
4569
|
+
};
|
|
4570
|
+
};
|
|
4571
|
+
required: string[];
|
|
4572
|
+
type: string;
|
|
4573
|
+
};
|
|
4574
|
+
};
|
|
4575
|
+
};
|
|
4576
|
+
description: string;
|
|
4577
|
+
};
|
|
4578
|
+
400: {
|
|
4579
|
+
description: string;
|
|
4580
|
+
};
|
|
4581
|
+
401: {
|
|
4582
|
+
description: string;
|
|
4583
|
+
};
|
|
4584
|
+
};
|
|
4585
|
+
security: ({
|
|
4586
|
+
access_token: never[];
|
|
4587
|
+
seam_workspace: never[];
|
|
4588
|
+
seam_client_session_token?: never;
|
|
4589
|
+
client_session_token?: never;
|
|
4590
|
+
} | {
|
|
4591
|
+
seam_client_session_token: never[];
|
|
4592
|
+
access_token?: never;
|
|
4593
|
+
seam_workspace?: never;
|
|
4594
|
+
client_session_token?: never;
|
|
4595
|
+
} | {
|
|
4596
|
+
client_session_token: never[];
|
|
4597
|
+
access_token?: never;
|
|
4598
|
+
seam_workspace?: never;
|
|
4599
|
+
seam_client_session_token?: never;
|
|
4600
|
+
})[];
|
|
4601
|
+
summary: string;
|
|
4602
|
+
tags: never[];
|
|
4603
|
+
'x-fern-sdk-group-name': string[];
|
|
4604
|
+
'x-fern-sdk-method-name': string;
|
|
4605
|
+
};
|
|
4606
|
+
};
|
|
4607
|
+
'/acs/credential_provisioning_automations/launch': {
|
|
4608
|
+
post: {
|
|
4609
|
+
operationId: string;
|
|
4610
|
+
requestBody: {
|
|
4611
|
+
content: {
|
|
4612
|
+
'application/json': {
|
|
4613
|
+
schema: {
|
|
4614
|
+
properties: {
|
|
4615
|
+
acs_credential_pool_id: {
|
|
4616
|
+
format: string;
|
|
4617
|
+
type: string;
|
|
4618
|
+
};
|
|
4619
|
+
create_credential_manager_user: {
|
|
4620
|
+
type: string;
|
|
4621
|
+
};
|
|
4622
|
+
credential_manager_acs_system_id: {
|
|
4623
|
+
format: string;
|
|
4624
|
+
type: string;
|
|
4625
|
+
};
|
|
4626
|
+
credential_manager_acs_user_id: {
|
|
4627
|
+
format: string;
|
|
4628
|
+
type: string;
|
|
4629
|
+
};
|
|
4630
|
+
user_identity_id: {
|
|
4631
|
+
format: string;
|
|
4632
|
+
type: string;
|
|
4633
|
+
};
|
|
4634
|
+
};
|
|
4635
|
+
required: string[];
|
|
4636
|
+
type: string;
|
|
4637
|
+
};
|
|
4638
|
+
};
|
|
4639
|
+
};
|
|
4640
|
+
};
|
|
4641
|
+
responses: {
|
|
4642
|
+
200: {
|
|
4643
|
+
content: {
|
|
4644
|
+
'application/json': {
|
|
4645
|
+
schema: {
|
|
4646
|
+
properties: {
|
|
4647
|
+
acs_credential_provisioning_automation: {
|
|
4648
|
+
properties: {
|
|
4649
|
+
acs_credential_provisioning_automation_id: {
|
|
4650
|
+
format: string;
|
|
4651
|
+
type: string;
|
|
4652
|
+
};
|
|
4653
|
+
created_at: {
|
|
4654
|
+
format: string;
|
|
4655
|
+
type: string;
|
|
4656
|
+
};
|
|
4657
|
+
credential_manager_acs_system_id: {
|
|
4658
|
+
format: string;
|
|
4659
|
+
type: string;
|
|
4660
|
+
};
|
|
4661
|
+
user_identity_id: {
|
|
4662
|
+
format: string;
|
|
4663
|
+
type: string;
|
|
4664
|
+
};
|
|
4665
|
+
workspace_id: {
|
|
4666
|
+
format: string;
|
|
4667
|
+
type: string;
|
|
4668
|
+
};
|
|
4669
|
+
};
|
|
4670
|
+
required: string[];
|
|
4671
|
+
type: string;
|
|
4672
|
+
};
|
|
4673
|
+
ok: {
|
|
4674
|
+
type: string;
|
|
4675
|
+
};
|
|
4676
|
+
};
|
|
4677
|
+
required: string[];
|
|
4678
|
+
type: string;
|
|
4679
|
+
};
|
|
4680
|
+
};
|
|
4681
|
+
};
|
|
4682
|
+
description: string;
|
|
4683
|
+
};
|
|
4684
|
+
400: {
|
|
4685
|
+
description: string;
|
|
4686
|
+
};
|
|
4687
|
+
401: {
|
|
4688
|
+
description: string;
|
|
4689
|
+
};
|
|
4690
|
+
};
|
|
4691
|
+
security: ({
|
|
4692
|
+
access_token: never[];
|
|
4693
|
+
seam_workspace: never[];
|
|
4694
|
+
seam_client_session_token?: never;
|
|
4695
|
+
client_session_token?: never;
|
|
4696
|
+
} | {
|
|
4697
|
+
seam_client_session_token: never[];
|
|
4698
|
+
access_token?: never;
|
|
4699
|
+
seam_workspace?: never;
|
|
4700
|
+
client_session_token?: never;
|
|
4701
|
+
} | {
|
|
4702
|
+
client_session_token: never[];
|
|
4703
|
+
access_token?: never;
|
|
4704
|
+
seam_workspace?: never;
|
|
4705
|
+
seam_client_session_token?: never;
|
|
4706
|
+
})[];
|
|
4707
|
+
summary: string;
|
|
4708
|
+
tags: never[];
|
|
4709
|
+
'x-fern-sdk-group-name': string[];
|
|
4710
|
+
'x-fern-sdk-method-name': string;
|
|
4711
|
+
};
|
|
4712
|
+
};
|
|
4475
4713
|
'/acs/credentials/assign': {
|
|
4476
4714
|
patch: {
|
|
4477
4715
|
operationId: string;
|
|
@@ -4507,6 +4745,10 @@ declare const _default: {
|
|
|
4507
4745
|
format: string;
|
|
4508
4746
|
type: string;
|
|
4509
4747
|
};
|
|
4748
|
+
acs_credential_pool_id: {
|
|
4749
|
+
format: string;
|
|
4750
|
+
type: string;
|
|
4751
|
+
};
|
|
4510
4752
|
acs_system_id: {
|
|
4511
4753
|
format: string;
|
|
4512
4754
|
type: string;
|
|
@@ -4614,6 +4856,10 @@ declare const _default: {
|
|
|
4614
4856
|
format: string;
|
|
4615
4857
|
type: string;
|
|
4616
4858
|
};
|
|
4859
|
+
acs_credential_pool_id: {
|
|
4860
|
+
format: string;
|
|
4861
|
+
type: string;
|
|
4862
|
+
};
|
|
4617
4863
|
acs_system_id: {
|
|
4618
4864
|
format: string;
|
|
4619
4865
|
type: string;
|
|
@@ -4724,6 +4970,10 @@ declare const _default: {
|
|
|
4724
4970
|
format: string;
|
|
4725
4971
|
type: string;
|
|
4726
4972
|
};
|
|
4973
|
+
acs_credential_pool_id: {
|
|
4974
|
+
format: string;
|
|
4975
|
+
type: string;
|
|
4976
|
+
};
|
|
4727
4977
|
acs_system_id: {
|
|
4728
4978
|
format: string;
|
|
4729
4979
|
type: string;
|
|
@@ -4895,6 +5145,10 @@ declare const _default: {
|
|
|
4895
5145
|
format: string;
|
|
4896
5146
|
type: string;
|
|
4897
5147
|
};
|
|
5148
|
+
acs_credential_pool_id: {
|
|
5149
|
+
format: string;
|
|
5150
|
+
type: string;
|
|
5151
|
+
};
|
|
4898
5152
|
acs_system_id: {
|
|
4899
5153
|
format: string;
|
|
4900
5154
|
type: string;
|
|
@@ -5028,6 +5282,10 @@ declare const _default: {
|
|
|
5028
5282
|
format: string;
|
|
5029
5283
|
type: string;
|
|
5030
5284
|
};
|
|
5285
|
+
acs_credential_pool_id: {
|
|
5286
|
+
format: string;
|
|
5287
|
+
type: string;
|
|
5288
|
+
};
|
|
5031
5289
|
acs_system_id: {
|
|
5032
5290
|
format: string;
|
|
5033
5291
|
type: string;
|
|
@@ -5140,6 +5398,10 @@ declare const _default: {
|
|
|
5140
5398
|
format: string;
|
|
5141
5399
|
type: string;
|
|
5142
5400
|
};
|
|
5401
|
+
acs_credential_pool_id: {
|
|
5402
|
+
format: string;
|
|
5403
|
+
type: string;
|
|
5404
|
+
};
|
|
5143
5405
|
acs_system_id: {
|
|
5144
5406
|
format: string;
|
|
5145
5407
|
type: string;
|
|
@@ -5247,6 +5509,10 @@ declare const _default: {
|
|
|
5247
5509
|
format: string;
|
|
5248
5510
|
type: string;
|
|
5249
5511
|
};
|
|
5512
|
+
acs_credential_pool_id: {
|
|
5513
|
+
format: string;
|
|
5514
|
+
type: string;
|
|
5515
|
+
};
|
|
5250
5516
|
acs_system_id: {
|
|
5251
5517
|
format: string;
|
|
5252
5518
|
type: string;
|
|
@@ -12949,26 +13215,49 @@ interface Routes {
|
|
|
12949
13215
|
};
|
|
12950
13216
|
};
|
|
12951
13217
|
access_code: {
|
|
13218
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
12952
13219
|
common_code_key: string | null;
|
|
13220
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
12953
13221
|
is_scheduled_on_device?: boolean | undefined;
|
|
13222
|
+
/** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
|
|
12954
13223
|
type: 'time_bound' | 'ongoing';
|
|
13224
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
12955
13225
|
is_waiting_for_code_assignment?: boolean | undefined;
|
|
13226
|
+
/** Unique identifier for the access code. */
|
|
12956
13227
|
access_code_id: string;
|
|
13228
|
+
/** Unique identifier for the device associated with the access code. */
|
|
12957
13229
|
device_id: string;
|
|
13230
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
12958
13231
|
name: string | null;
|
|
13232
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
12959
13233
|
code: string | null;
|
|
13234
|
+
/** Date and time at which the access code was created. */
|
|
12960
13235
|
created_at: string;
|
|
13236
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
12961
13237
|
errors?: any;
|
|
13238
|
+
/** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
|
|
12962
13239
|
warnings?: any;
|
|
13240
|
+
/** Indicates whether Seam manages the access code. */
|
|
12963
13241
|
is_managed: true;
|
|
13242
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
12964
13243
|
starts_at?: (string | null) | undefined;
|
|
13244
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
12965
13245
|
ends_at?: (string | null) | undefined;
|
|
13246
|
+
/**
|
|
13247
|
+
Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
|
|
13248
|
+
*/
|
|
12966
13249
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
13250
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
12967
13251
|
is_backup_access_code_available: boolean;
|
|
13252
|
+
/** Indicates whether the access code is a backup code. */
|
|
12968
13253
|
is_backup?: boolean | undefined;
|
|
13254
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
12969
13255
|
pulled_backup_access_code_id?: (string | null) | undefined;
|
|
13256
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
12970
13257
|
is_external_modification_allowed: boolean;
|
|
13258
|
+
/** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
|
|
12971
13259
|
is_one_time_use: boolean;
|
|
13260
|
+
/** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
|
|
12972
13261
|
is_offline_access_code: boolean;
|
|
12973
13262
|
};
|
|
12974
13263
|
};
|
|
@@ -12998,26 +13287,49 @@ interface Routes {
|
|
|
12998
13287
|
formData: {};
|
|
12999
13288
|
jsonResponse: {
|
|
13000
13289
|
access_codes: Array<{
|
|
13290
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
13001
13291
|
common_code_key: string | null;
|
|
13292
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
13002
13293
|
is_scheduled_on_device?: boolean | undefined;
|
|
13294
|
+
/** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
|
|
13003
13295
|
type: 'time_bound' | 'ongoing';
|
|
13296
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
13004
13297
|
is_waiting_for_code_assignment?: boolean | undefined;
|
|
13298
|
+
/** Unique identifier for the access code. */
|
|
13005
13299
|
access_code_id: string;
|
|
13300
|
+
/** Unique identifier for the device associated with the access code. */
|
|
13006
13301
|
device_id: string;
|
|
13302
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
13007
13303
|
name: string | null;
|
|
13304
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
13008
13305
|
code: string | null;
|
|
13306
|
+
/** Date and time at which the access code was created. */
|
|
13009
13307
|
created_at: string;
|
|
13308
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
13010
13309
|
errors?: any;
|
|
13310
|
+
/** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
|
|
13011
13311
|
warnings?: any;
|
|
13312
|
+
/** Indicates whether Seam manages the access code. */
|
|
13012
13313
|
is_managed: true;
|
|
13314
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
13013
13315
|
starts_at?: (string | null) | undefined;
|
|
13316
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
13014
13317
|
ends_at?: (string | null) | undefined;
|
|
13318
|
+
/**
|
|
13319
|
+
Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
|
|
13320
|
+
*/
|
|
13015
13321
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
13322
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
13016
13323
|
is_backup_access_code_available: boolean;
|
|
13324
|
+
/** Indicates whether the access code is a backup code. */
|
|
13017
13325
|
is_backup?: boolean | undefined;
|
|
13326
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
13018
13327
|
pulled_backup_access_code_id?: (string | null) | undefined;
|
|
13328
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
13019
13329
|
is_external_modification_allowed: boolean;
|
|
13330
|
+
/** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
|
|
13020
13331
|
is_one_time_use: boolean;
|
|
13332
|
+
/** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
|
|
13021
13333
|
is_offline_access_code: boolean;
|
|
13022
13334
|
}>;
|
|
13023
13335
|
};
|
|
@@ -13087,26 +13399,49 @@ interface Routes {
|
|
|
13087
13399
|
formData: {};
|
|
13088
13400
|
jsonResponse: {
|
|
13089
13401
|
access_code: {
|
|
13402
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
13090
13403
|
common_code_key: string | null;
|
|
13404
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
13091
13405
|
is_scheduled_on_device?: boolean | undefined;
|
|
13406
|
+
/** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
|
|
13092
13407
|
type: 'time_bound' | 'ongoing';
|
|
13408
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
13093
13409
|
is_waiting_for_code_assignment?: boolean | undefined;
|
|
13410
|
+
/** Unique identifier for the access code. */
|
|
13094
13411
|
access_code_id: string;
|
|
13412
|
+
/** Unique identifier for the device associated with the access code. */
|
|
13095
13413
|
device_id: string;
|
|
13414
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
13096
13415
|
name: string | null;
|
|
13416
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
13097
13417
|
code: string | null;
|
|
13418
|
+
/** Date and time at which the access code was created. */
|
|
13098
13419
|
created_at: string;
|
|
13420
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
13099
13421
|
errors?: any;
|
|
13422
|
+
/** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
|
|
13100
13423
|
warnings?: any;
|
|
13424
|
+
/** Indicates whether Seam manages the access code. */
|
|
13101
13425
|
is_managed: true;
|
|
13426
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
13102
13427
|
starts_at?: (string | null) | undefined;
|
|
13428
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
13103
13429
|
ends_at?: (string | null) | undefined;
|
|
13430
|
+
/**
|
|
13431
|
+
Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
|
|
13432
|
+
*/
|
|
13104
13433
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
13434
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
13105
13435
|
is_backup_access_code_available: boolean;
|
|
13436
|
+
/** Indicates whether the access code is a backup code. */
|
|
13106
13437
|
is_backup?: boolean | undefined;
|
|
13438
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
13107
13439
|
pulled_backup_access_code_id?: (string | null) | undefined;
|
|
13440
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
13108
13441
|
is_external_modification_allowed: boolean;
|
|
13442
|
+
/** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
|
|
13109
13443
|
is_one_time_use: boolean;
|
|
13444
|
+
/** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
|
|
13110
13445
|
is_offline_access_code: boolean;
|
|
13111
13446
|
};
|
|
13112
13447
|
};
|
|
@@ -13124,26 +13459,49 @@ interface Routes {
|
|
|
13124
13459
|
formData: {};
|
|
13125
13460
|
jsonResponse: {
|
|
13126
13461
|
access_codes: Array<{
|
|
13462
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
13127
13463
|
common_code_key: string | null;
|
|
13464
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
13128
13465
|
is_scheduled_on_device?: boolean | undefined;
|
|
13466
|
+
/** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
|
|
13129
13467
|
type: 'time_bound' | 'ongoing';
|
|
13468
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
13130
13469
|
is_waiting_for_code_assignment?: boolean | undefined;
|
|
13470
|
+
/** Unique identifier for the access code. */
|
|
13131
13471
|
access_code_id: string;
|
|
13472
|
+
/** Unique identifier for the device associated with the access code. */
|
|
13132
13473
|
device_id: string;
|
|
13474
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
13133
13475
|
name: string | null;
|
|
13476
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
13134
13477
|
code: string | null;
|
|
13478
|
+
/** Date and time at which the access code was created. */
|
|
13135
13479
|
created_at: string;
|
|
13480
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
13136
13481
|
errors?: any;
|
|
13482
|
+
/** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
|
|
13137
13483
|
warnings?: any;
|
|
13484
|
+
/** Indicates whether Seam manages the access code. */
|
|
13138
13485
|
is_managed: true;
|
|
13486
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
13139
13487
|
starts_at?: (string | null) | undefined;
|
|
13488
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
13140
13489
|
ends_at?: (string | null) | undefined;
|
|
13490
|
+
/**
|
|
13491
|
+
Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
|
|
13492
|
+
*/
|
|
13141
13493
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
13494
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
13142
13495
|
is_backup_access_code_available: boolean;
|
|
13496
|
+
/** Indicates whether the access code is a backup code. */
|
|
13143
13497
|
is_backup?: boolean | undefined;
|
|
13498
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
13144
13499
|
pulled_backup_access_code_id?: (string | null) | undefined;
|
|
13500
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
13145
13501
|
is_external_modification_allowed: boolean;
|
|
13502
|
+
/** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
|
|
13146
13503
|
is_one_time_use: boolean;
|
|
13504
|
+
/** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
|
|
13147
13505
|
is_offline_access_code: boolean;
|
|
13148
13506
|
}>;
|
|
13149
13507
|
};
|
|
@@ -13159,26 +13517,49 @@ interface Routes {
|
|
|
13159
13517
|
formData: {};
|
|
13160
13518
|
jsonResponse: {
|
|
13161
13519
|
backup_access_code: {
|
|
13520
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
13162
13521
|
common_code_key: string | null;
|
|
13522
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
13163
13523
|
is_scheduled_on_device?: boolean | undefined;
|
|
13524
|
+
/** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
|
|
13164
13525
|
type: 'time_bound' | 'ongoing';
|
|
13526
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
13165
13527
|
is_waiting_for_code_assignment?: boolean | undefined;
|
|
13528
|
+
/** Unique identifier for the access code. */
|
|
13166
13529
|
access_code_id: string;
|
|
13530
|
+
/** Unique identifier for the device associated with the access code. */
|
|
13167
13531
|
device_id: string;
|
|
13532
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
13168
13533
|
name: string | null;
|
|
13534
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
13169
13535
|
code: string | null;
|
|
13536
|
+
/** Date and time at which the access code was created. */
|
|
13170
13537
|
created_at: string;
|
|
13538
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
13171
13539
|
errors?: any;
|
|
13540
|
+
/** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
|
|
13172
13541
|
warnings?: any;
|
|
13542
|
+
/** Indicates whether Seam manages the access code. */
|
|
13173
13543
|
is_managed: true;
|
|
13544
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
13174
13545
|
starts_at?: (string | null) | undefined;
|
|
13546
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
13175
13547
|
ends_at?: (string | null) | undefined;
|
|
13548
|
+
/**
|
|
13549
|
+
Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
|
|
13550
|
+
*/
|
|
13176
13551
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
13552
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
13177
13553
|
is_backup_access_code_available: boolean;
|
|
13554
|
+
/** Indicates whether the access code is a backup code. */
|
|
13178
13555
|
is_backup?: boolean | undefined;
|
|
13556
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
13179
13557
|
pulled_backup_access_code_id?: (string | null) | undefined;
|
|
13558
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
13180
13559
|
is_external_modification_allowed: boolean;
|
|
13560
|
+
/** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
|
|
13181
13561
|
is_one_time_use: boolean;
|
|
13562
|
+
/** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
|
|
13182
13563
|
is_offline_access_code: boolean;
|
|
13183
13564
|
};
|
|
13184
13565
|
};
|
|
@@ -13196,16 +13577,26 @@ interface Routes {
|
|
|
13196
13577
|
formData: {};
|
|
13197
13578
|
jsonResponse: {
|
|
13198
13579
|
access_code: {
|
|
13580
|
+
/** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
|
|
13199
13581
|
type: 'time_bound' | 'ongoing';
|
|
13582
|
+
/** Unique identifier for the access code. */
|
|
13200
13583
|
access_code_id: string;
|
|
13584
|
+
/** Unique identifier for the device associated with the access code. */
|
|
13201
13585
|
device_id: string;
|
|
13586
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
13202
13587
|
name: string | null;
|
|
13588
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
13203
13589
|
code: string | null;
|
|
13590
|
+
/** Date and time at which the access code was created. */
|
|
13204
13591
|
created_at: string;
|
|
13592
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
13205
13593
|
errors?: any;
|
|
13594
|
+
/** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
|
|
13206
13595
|
warnings?: any;
|
|
13207
13596
|
is_managed: false;
|
|
13597
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
13208
13598
|
starts_at?: (string | null) | undefined;
|
|
13599
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
13209
13600
|
ends_at?: (string | null) | undefined;
|
|
13210
13601
|
status: 'set';
|
|
13211
13602
|
};
|
|
@@ -13274,16 +13665,26 @@ interface Routes {
|
|
|
13274
13665
|
formData: {};
|
|
13275
13666
|
jsonResponse: {
|
|
13276
13667
|
access_code: {
|
|
13668
|
+
/** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
|
|
13277
13669
|
type: 'time_bound' | 'ongoing';
|
|
13670
|
+
/** Unique identifier for the access code. */
|
|
13278
13671
|
access_code_id: string;
|
|
13672
|
+
/** Unique identifier for the device associated with the access code. */
|
|
13279
13673
|
device_id: string;
|
|
13674
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
13280
13675
|
name: string | null;
|
|
13676
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
13281
13677
|
code: string | null;
|
|
13678
|
+
/** Date and time at which the access code was created. */
|
|
13282
13679
|
created_at: string;
|
|
13680
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
13283
13681
|
errors?: any;
|
|
13682
|
+
/** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
|
|
13284
13683
|
warnings?: any;
|
|
13285
13684
|
is_managed: false;
|
|
13685
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
13286
13686
|
starts_at?: (string | null) | undefined;
|
|
13687
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
13287
13688
|
ends_at?: (string | null) | undefined;
|
|
13288
13689
|
status: 'set';
|
|
13289
13690
|
};
|
|
@@ -13301,16 +13702,26 @@ interface Routes {
|
|
|
13301
13702
|
formData: {};
|
|
13302
13703
|
jsonResponse: {
|
|
13303
13704
|
access_codes: Array<{
|
|
13705
|
+
/** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
|
|
13304
13706
|
type: 'time_bound' | 'ongoing';
|
|
13707
|
+
/** Unique identifier for the access code. */
|
|
13305
13708
|
access_code_id: string;
|
|
13709
|
+
/** Unique identifier for the device associated with the access code. */
|
|
13306
13710
|
device_id: string;
|
|
13711
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
13307
13712
|
name: string | null;
|
|
13713
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
13308
13714
|
code: string | null;
|
|
13715
|
+
/** Date and time at which the access code was created. */
|
|
13309
13716
|
created_at: string;
|
|
13717
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
13310
13718
|
errors?: any;
|
|
13719
|
+
/** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
|
|
13311
13720
|
warnings?: any;
|
|
13312
13721
|
is_managed: false;
|
|
13722
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
13313
13723
|
starts_at?: (string | null) | undefined;
|
|
13724
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
13314
13725
|
ends_at?: (string | null) | undefined;
|
|
13315
13726
|
status: 'set';
|
|
13316
13727
|
}>;
|
|
@@ -13484,6 +13895,50 @@ interface Routes {
|
|
|
13484
13895
|
formData: {};
|
|
13485
13896
|
jsonResponse: {};
|
|
13486
13897
|
};
|
|
13898
|
+
'/acs/credential_pools/list': {
|
|
13899
|
+
route: '/acs/credential_pools/list';
|
|
13900
|
+
method: 'GET' | 'POST';
|
|
13901
|
+
queryParams: {};
|
|
13902
|
+
jsonBody: {};
|
|
13903
|
+
commonParams: {
|
|
13904
|
+
acs_system_id: string;
|
|
13905
|
+
};
|
|
13906
|
+
formData: {};
|
|
13907
|
+
jsonResponse: {
|
|
13908
|
+
acs_credential_pools: Array<{
|
|
13909
|
+
acs_credential_pool_id: string;
|
|
13910
|
+
acs_system_id: string;
|
|
13911
|
+
display_name: string;
|
|
13912
|
+
external_type: 'hid_part_number';
|
|
13913
|
+
external_type_display_name: string;
|
|
13914
|
+
created_at: string;
|
|
13915
|
+
workspace_id: string;
|
|
13916
|
+
}>;
|
|
13917
|
+
};
|
|
13918
|
+
};
|
|
13919
|
+
'/acs/credential_provisioning_automations/launch': {
|
|
13920
|
+
route: '/acs/credential_provisioning_automations/launch';
|
|
13921
|
+
method: 'POST';
|
|
13922
|
+
queryParams: {};
|
|
13923
|
+
jsonBody: {};
|
|
13924
|
+
commonParams: {
|
|
13925
|
+
user_identity_id: string;
|
|
13926
|
+
credential_manager_acs_system_id: string;
|
|
13927
|
+
acs_credential_pool_id?: string | undefined;
|
|
13928
|
+
create_credential_manager_user?: boolean | undefined;
|
|
13929
|
+
credential_manager_acs_user_id?: string | undefined;
|
|
13930
|
+
};
|
|
13931
|
+
formData: {};
|
|
13932
|
+
jsonResponse: {
|
|
13933
|
+
acs_credential_provisioning_automation: {
|
|
13934
|
+
acs_credential_provisioning_automation_id: string;
|
|
13935
|
+
credential_manager_acs_system_id: string;
|
|
13936
|
+
user_identity_id: string;
|
|
13937
|
+
created_at: string;
|
|
13938
|
+
workspace_id: string;
|
|
13939
|
+
};
|
|
13940
|
+
};
|
|
13941
|
+
};
|
|
13487
13942
|
'/acs/credentials/assign': {
|
|
13488
13943
|
route: '/acs/credentials/assign';
|
|
13489
13944
|
method: 'PATCH' | 'POST';
|
|
@@ -13498,10 +13953,11 @@ interface Routes {
|
|
|
13498
13953
|
acs_credential: {
|
|
13499
13954
|
acs_credential_id: string;
|
|
13500
13955
|
acs_user_id?: string | undefined;
|
|
13956
|
+
acs_credential_pool_id?: string | undefined;
|
|
13501
13957
|
acs_system_id: string;
|
|
13502
13958
|
display_name: string;
|
|
13503
13959
|
code: string | null;
|
|
13504
|
-
external_type: 'pti_card' | 'brivo_credential' | '
|
|
13960
|
+
external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
|
|
13505
13961
|
external_type_display_name: string;
|
|
13506
13962
|
created_at: string;
|
|
13507
13963
|
workspace_id: string;
|
|
@@ -13522,10 +13978,11 @@ interface Routes {
|
|
|
13522
13978
|
acs_credential: {
|
|
13523
13979
|
acs_credential_id: string;
|
|
13524
13980
|
acs_user_id?: string | undefined;
|
|
13981
|
+
acs_credential_pool_id?: string | undefined;
|
|
13525
13982
|
acs_system_id: string;
|
|
13526
13983
|
display_name: string;
|
|
13527
13984
|
code: string | null;
|
|
13528
|
-
external_type: 'pti_card' | 'brivo_credential' | '
|
|
13985
|
+
external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
|
|
13529
13986
|
external_type_display_name: string;
|
|
13530
13987
|
created_at: string;
|
|
13531
13988
|
workspace_id: string;
|
|
@@ -13556,10 +14013,11 @@ interface Routes {
|
|
|
13556
14013
|
acs_credential: {
|
|
13557
14014
|
acs_credential_id: string;
|
|
13558
14015
|
acs_user_id?: string | undefined;
|
|
14016
|
+
acs_credential_pool_id?: string | undefined;
|
|
13559
14017
|
acs_system_id: string;
|
|
13560
14018
|
display_name: string;
|
|
13561
14019
|
code: string | null;
|
|
13562
|
-
external_type: 'pti_card' | 'brivo_credential' | '
|
|
14020
|
+
external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
|
|
13563
14021
|
external_type_display_name: string;
|
|
13564
14022
|
created_at: string;
|
|
13565
14023
|
workspace_id: string;
|
|
@@ -13584,10 +14042,11 @@ interface Routes {
|
|
|
13584
14042
|
acs_credentials: Array<{
|
|
13585
14043
|
acs_credential_id: string;
|
|
13586
14044
|
acs_user_id?: string | undefined;
|
|
14045
|
+
acs_credential_pool_id?: string | undefined;
|
|
13587
14046
|
acs_system_id: string;
|
|
13588
14047
|
display_name: string;
|
|
13589
14048
|
code: string | null;
|
|
13590
|
-
external_type: 'pti_card' | 'brivo_credential' | '
|
|
14049
|
+
external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
|
|
13591
14050
|
external_type_display_name: string;
|
|
13592
14051
|
created_at: string;
|
|
13593
14052
|
workspace_id: string;
|
|
@@ -13608,10 +14067,11 @@ interface Routes {
|
|
|
13608
14067
|
acs_credential: {
|
|
13609
14068
|
acs_credential_id: string;
|
|
13610
14069
|
acs_user_id?: string | undefined;
|
|
14070
|
+
acs_credential_pool_id?: string | undefined;
|
|
13611
14071
|
acs_system_id: string;
|
|
13612
14072
|
display_name: string;
|
|
13613
14073
|
code: string | null;
|
|
13614
|
-
external_type: 'pti_card' | 'brivo_credential' | '
|
|
14074
|
+
external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
|
|
13615
14075
|
external_type_display_name: string;
|
|
13616
14076
|
created_at: string;
|
|
13617
14077
|
workspace_id: string;
|
|
@@ -14304,7 +14764,7 @@ interface Routes {
|
|
|
14304
14764
|
display_name: string;
|
|
14305
14765
|
manufacturer_display_name: string;
|
|
14306
14766
|
offline_access_codes_supported?: boolean | undefined;
|
|
14307
|
-
|
|
14767
|
+
online_access_codes_supported?: boolean | undefined;
|
|
14308
14768
|
accessory_keypad_supported?: boolean | undefined;
|
|
14309
14769
|
};
|
|
14310
14770
|
has_direct_power?: boolean | undefined;
|
|
@@ -14723,7 +15183,7 @@ interface Routes {
|
|
|
14723
15183
|
display_name: string;
|
|
14724
15184
|
manufacturer_display_name: string;
|
|
14725
15185
|
offline_access_codes_supported?: boolean | undefined;
|
|
14726
|
-
|
|
15186
|
+
online_access_codes_supported?: boolean | undefined;
|
|
14727
15187
|
accessory_keypad_supported?: boolean | undefined;
|
|
14728
15188
|
};
|
|
14729
15189
|
has_direct_power?: boolean | undefined;
|
|
@@ -15397,7 +15857,7 @@ interface Routes {
|
|
|
15397
15857
|
display_name: string;
|
|
15398
15858
|
manufacturer_display_name: string;
|
|
15399
15859
|
offline_access_codes_supported?: boolean | undefined;
|
|
15400
|
-
|
|
15860
|
+
online_access_codes_supported?: boolean | undefined;
|
|
15401
15861
|
accessory_keypad_supported?: boolean | undefined;
|
|
15402
15862
|
};
|
|
15403
15863
|
has_direct_power?: boolean | undefined;
|
|
@@ -15794,7 +16254,7 @@ interface Routes {
|
|
|
15794
16254
|
display_name: string;
|
|
15795
16255
|
manufacturer_display_name: string;
|
|
15796
16256
|
offline_access_codes_supported?: boolean | undefined;
|
|
15797
|
-
|
|
16257
|
+
online_access_codes_supported?: boolean | undefined;
|
|
15798
16258
|
accessory_keypad_supported?: boolean | undefined;
|
|
15799
16259
|
};
|
|
15800
16260
|
has_direct_power?: boolean | undefined;
|
|
@@ -16213,7 +16673,7 @@ interface Routes {
|
|
|
16213
16673
|
display_name: string;
|
|
16214
16674
|
manufacturer_display_name: string;
|
|
16215
16675
|
offline_access_codes_supported?: boolean | undefined;
|
|
16216
|
-
|
|
16676
|
+
online_access_codes_supported?: boolean | undefined;
|
|
16217
16677
|
accessory_keypad_supported?: boolean | undefined;
|
|
16218
16678
|
};
|
|
16219
16679
|
has_direct_power?: boolean | undefined;
|
|
@@ -16610,7 +17070,7 @@ interface Routes {
|
|
|
16610
17070
|
display_name: string;
|
|
16611
17071
|
manufacturer_display_name: string;
|
|
16612
17072
|
offline_access_codes_supported?: boolean | undefined;
|
|
16613
|
-
|
|
17073
|
+
online_access_codes_supported?: boolean | undefined;
|
|
16614
17074
|
accessory_keypad_supported?: boolean | undefined;
|
|
16615
17075
|
};
|
|
16616
17076
|
has_direct_power?: boolean | undefined;
|
|
@@ -17427,7 +17887,7 @@ interface Routes {
|
|
|
17427
17887
|
display_name: string;
|
|
17428
17888
|
manufacturer_display_name: string;
|
|
17429
17889
|
offline_access_codes_supported?: boolean | undefined;
|
|
17430
|
-
|
|
17890
|
+
online_access_codes_supported?: boolean | undefined;
|
|
17431
17891
|
accessory_keypad_supported?: boolean | undefined;
|
|
17432
17892
|
};
|
|
17433
17893
|
has_direct_power?: boolean | undefined;
|
|
@@ -17876,7 +18336,7 @@ interface Routes {
|
|
|
17876
18336
|
display_name: string;
|
|
17877
18337
|
manufacturer_display_name: string;
|
|
17878
18338
|
offline_access_codes_supported?: boolean | undefined;
|
|
17879
|
-
|
|
18339
|
+
online_access_codes_supported?: boolean | undefined;
|
|
17880
18340
|
accessory_keypad_supported?: boolean | undefined;
|
|
17881
18341
|
};
|
|
17882
18342
|
has_direct_power?: boolean | undefined;
|
|
@@ -18397,7 +18857,7 @@ interface Routes {
|
|
|
18397
18857
|
display_name: string;
|
|
18398
18858
|
manufacturer_display_name: string;
|
|
18399
18859
|
offline_access_codes_supported?: boolean | undefined;
|
|
18400
|
-
|
|
18860
|
+
online_access_codes_supported?: boolean | undefined;
|
|
18401
18861
|
accessory_keypad_supported?: boolean | undefined;
|
|
18402
18862
|
};
|
|
18403
18863
|
has_direct_power?: boolean | undefined;
|