@seamapi/types 1.152.0 → 1.153.1

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.
@@ -165,6 +165,190 @@ export default {
165
165
  ],
166
166
  type: 'object',
167
167
  },
168
+ acs_credential: {
169
+ properties: {
170
+ access_method: {
171
+ enum: ['code', 'card', 'mobile_key'],
172
+ type: 'string',
173
+ },
174
+ acs_credential_id: { format: 'uuid', type: 'string' },
175
+ acs_credential_pool_id: { format: 'uuid', type: 'string' },
176
+ acs_system_id: { format: 'uuid', type: 'string' },
177
+ acs_user_id: { format: 'uuid', type: 'string' },
178
+ code: { nullable: true, type: 'string' },
179
+ created_at: { format: 'date-time', type: 'string' },
180
+ display_name: { minLength: 1, type: 'string' },
181
+ ends_at: { type: 'string' },
182
+ errors: {
183
+ items: {
184
+ properties: {
185
+ error_code: { type: 'string' },
186
+ message: { type: 'string' },
187
+ },
188
+ required: ['error_code', 'message'],
189
+ type: 'object',
190
+ },
191
+ type: 'array',
192
+ },
193
+ external_type: {
194
+ enum: [
195
+ 'pti_card',
196
+ 'brivo_credential',
197
+ 'hid_credential',
198
+ 'visionline_card',
199
+ ],
200
+ type: 'string',
201
+ },
202
+ external_type_display_name: { type: 'string' },
203
+ is_multi_phone_sync_credential: { type: 'boolean' },
204
+ parent_acs_credential_id: { format: 'uuid', type: 'string' },
205
+ starts_at: { type: 'string' },
206
+ visionline_metadata: {
207
+ properties: {
208
+ common_acs_entrance_ids: {
209
+ items: { format: 'uuid', type: 'string' },
210
+ type: 'array',
211
+ },
212
+ guest_acs_entrance_ids: {
213
+ items: { format: 'uuid', type: 'string' },
214
+ type: 'array',
215
+ },
216
+ joiner_acs_credential_ids: {
217
+ items: { format: 'uuid', type: 'string' },
218
+ type: 'array',
219
+ },
220
+ },
221
+ type: 'object',
222
+ },
223
+ warnings: {
224
+ items: {
225
+ properties: {
226
+ message: { type: 'string' },
227
+ warning_code: { type: 'string' },
228
+ },
229
+ required: ['warning_code', 'message'],
230
+ type: 'object',
231
+ },
232
+ type: 'array',
233
+ },
234
+ workspace_id: { format: 'uuid', type: 'string' },
235
+ },
236
+ required: [
237
+ 'acs_credential_id',
238
+ 'acs_system_id',
239
+ 'display_name',
240
+ 'access_method',
241
+ 'created_at',
242
+ 'workspace_id',
243
+ 'errors',
244
+ 'warnings',
245
+ ],
246
+ type: 'object',
247
+ },
248
+ acs_credential_pool: {
249
+ properties: {
250
+ acs_credential_pool_id: { format: 'uuid', type: 'string' },
251
+ acs_system_id: { format: 'uuid', type: 'string' },
252
+ created_at: { format: 'date-time', type: 'string' },
253
+ display_name: { minLength: 1, type: 'string' },
254
+ external_type: { enum: ['hid_part_number'], type: 'string' },
255
+ external_type_display_name: { type: 'string' },
256
+ workspace_id: { format: 'uuid', type: 'string' },
257
+ },
258
+ required: [
259
+ 'acs_credential_pool_id',
260
+ 'acs_system_id',
261
+ 'display_name',
262
+ 'external_type',
263
+ 'external_type_display_name',
264
+ 'created_at',
265
+ 'workspace_id',
266
+ ],
267
+ type: 'object',
268
+ },
269
+ acs_credential_provisioning_automation: {
270
+ properties: {
271
+ acs_credential_provisioning_automation_id: {
272
+ format: 'uuid',
273
+ type: 'string',
274
+ },
275
+ created_at: { format: 'date-time', type: 'string' },
276
+ credential_manager_acs_system_id: { format: 'uuid', type: 'string' },
277
+ user_identity_id: { format: 'uuid', type: 'string' },
278
+ workspace_id: { format: 'uuid', type: 'string' },
279
+ },
280
+ required: [
281
+ 'acs_credential_provisioning_automation_id',
282
+ 'credential_manager_acs_system_id',
283
+ 'user_identity_id',
284
+ 'created_at',
285
+ 'workspace_id',
286
+ ],
287
+ type: 'object',
288
+ },
289
+ acs_entrance: {
290
+ properties: {
291
+ acs_entrance_id: { format: 'uuid', type: 'string' },
292
+ acs_system_id: { format: 'uuid', type: 'string' },
293
+ created_at: { format: 'date-time', type: 'string' },
294
+ display_name: { type: 'string' },
295
+ latch_metadata: {
296
+ nullable: true,
297
+ properties: {
298
+ accessibility_type: { type: 'string' },
299
+ is_connected: { type: 'boolean' },
300
+ name: { type: 'string' },
301
+ type: { type: 'string' },
302
+ },
303
+ required: ['accessibility_type', 'name', 'type', 'is_connected'],
304
+ type: 'object',
305
+ },
306
+ visionline_metadata: {
307
+ nullable: true,
308
+ properties: {
309
+ door_category: {
310
+ enum: [
311
+ 'entrance',
312
+ 'guest',
313
+ 'elevator reader',
314
+ 'common',
315
+ 'common (PMS)',
316
+ ],
317
+ type: 'string',
318
+ },
319
+ door_name: { type: 'string' },
320
+ profiles: {
321
+ items: {
322
+ properties: {
323
+ visionline_door_profile_id: { type: 'string' },
324
+ visionline_door_profile_type: {
325
+ enum: ['BLE', 'commonDoor', 'touch'],
326
+ type: 'string',
327
+ },
328
+ },
329
+ required: [
330
+ 'visionline_door_profile_id',
331
+ 'visionline_door_profile_type',
332
+ ],
333
+ type: 'object',
334
+ },
335
+ type: 'array',
336
+ },
337
+ },
338
+ required: ['door_name', 'door_category'],
339
+ type: 'object',
340
+ },
341
+ },
342
+ required: [
343
+ 'acs_entrance_id',
344
+ 'display_name',
345
+ 'acs_system_id',
346
+ 'created_at',
347
+ 'latch_metadata',
348
+ 'visionline_metadata',
349
+ ],
350
+ type: 'object',
351
+ },
168
352
  acs_system: {
169
353
  properties: {
170
354
  acs_system_id: { format: 'uuid', type: 'string' },
@@ -397,9 +581,16 @@ export default {
397
581
  },
398
582
  connect_webview: {
399
583
  properties: {
400
- accepted_devices: { items: { type: 'string' }, type: 'array' },
584
+ accepted_devices: {
585
+ description: '\n ---\n deprecated: Unused. Will be removed.\n ---\n ',
586
+ items: { type: 'string' },
587
+ type: 'array',
588
+ },
401
589
  accepted_providers: { items: { type: 'string' }, type: 'array' },
402
- any_device_allowed: { type: 'boolean' },
590
+ any_device_allowed: {
591
+ description: '\n ---\n deprecated: Unused. Will be removed.\n ---\n ',
592
+ type: 'boolean',
593
+ },
403
594
  any_provider_allowed: { type: 'boolean' },
404
595
  authorized_at: {
405
596
  format: 'date-time',
@@ -450,8 +641,8 @@ export default {
450
641
  'device_selection_mode',
451
642
  'accepted_providers',
452
643
  'accepted_devices',
453
- 'any_provider_allowed',
454
644
  'any_device_allowed',
645
+ 'any_provider_allowed',
455
646
  'login_successful',
456
647
  'status',
457
648
  'custom_redirect_url',
@@ -1837,6 +2028,16 @@ export default {
1837
2028
  ],
1838
2029
  type: 'object',
1839
2030
  },
2031
+ network: {
2032
+ properties: {
2033
+ created_at: { format: 'date-time', type: 'string' },
2034
+ display_name: { type: 'string' },
2035
+ network_id: { format: 'uuid', type: 'string' },
2036
+ workspace_id: { format: 'uuid', type: 'string' },
2037
+ },
2038
+ required: ['network_id', 'workspace_id', 'display_name', 'created_at'],
2039
+ type: 'object',
2040
+ },
1840
2041
  noise_threshold: {
1841
2042
  properties: {
1842
2043
  device_id: { format: 'uuid', type: 'string' },
@@ -2304,6 +2505,29 @@ export default {
2304
2505
  ],
2305
2506
  type: 'object',
2306
2507
  },
2508
+ user_identity: {
2509
+ properties: {
2510
+ created_at: { format: 'date-time', type: 'string' },
2511
+ display_name: { minLength: 1, type: 'string' },
2512
+ email_address: { format: 'email', nullable: true, type: 'string' },
2513
+ full_name: { minLength: 1, nullable: true, type: 'string' },
2514
+ phone_number: { nullable: true, type: 'string' },
2515
+ user_identity_id: { format: 'uuid', type: 'string' },
2516
+ user_identity_key: { minLength: 1, nullable: true, type: 'string' },
2517
+ workspace_id: { format: 'uuid', type: 'string' },
2518
+ },
2519
+ required: [
2520
+ 'user_identity_id',
2521
+ 'user_identity_key',
2522
+ 'email_address',
2523
+ 'phone_number',
2524
+ 'display_name',
2525
+ 'full_name',
2526
+ 'created_at',
2527
+ 'workspace_id',
2528
+ ],
2529
+ type: 'object',
2530
+ },
2307
2531
  webhook: {
2308
2532
  properties: {
2309
2533
  event_types: { items: { type: 'string' }, type: 'array' },
@@ -3643,6 +3867,7 @@ export default {
3643
3867
  tags: ['/acs'],
3644
3868
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
3645
3869
  'x-fern-sdk-method-name': 'get',
3870
+ 'x-fern-sdk-return-value': 'acs_access_group',
3646
3871
  },
3647
3872
  },
3648
3873
  '/acs/access_groups/list': {
@@ -3692,6 +3917,7 @@ export default {
3692
3917
  tags: ['/acs'],
3693
3918
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
3694
3919
  'x-fern-sdk-method-name': 'list',
3920
+ 'x-fern-sdk-return-value': 'acs_access_groups',
3695
3921
  },
3696
3922
  },
3697
3923
  '/acs/access_groups/list_users': {
@@ -3742,6 +3968,7 @@ export default {
3742
3968
  tags: ['/acs'],
3743
3969
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
3744
3970
  'x-fern-sdk-method-name': 'list_users',
3971
+ 'x-fern-sdk-return-value': 'acs_users',
3745
3972
  },
3746
3973
  },
3747
3974
  '/acs/access_groups/remove_user': {
@@ -3812,31 +4039,7 @@ export default {
3812
4039
  properties: {
3813
4040
  acs_credential_pools: {
3814
4041
  items: {
3815
- properties: {
3816
- acs_credential_pool_id: {
3817
- format: 'uuid',
3818
- type: 'string',
3819
- },
3820
- acs_system_id: { format: 'uuid', type: 'string' },
3821
- created_at: { format: 'date-time', type: 'string' },
3822
- display_name: { minLength: 1, type: 'string' },
3823
- external_type: {
3824
- enum: ['hid_part_number'],
3825
- type: 'string',
3826
- },
3827
- external_type_display_name: { type: 'string' },
3828
- workspace_id: { format: 'uuid', type: 'string' },
3829
- },
3830
- required: [
3831
- 'acs_credential_pool_id',
3832
- 'acs_system_id',
3833
- 'display_name',
3834
- 'external_type',
3835
- 'external_type_display_name',
3836
- 'created_at',
3837
- 'workspace_id',
3838
- ],
3839
- type: 'object',
4042
+ $ref: '#/components/schemas/acs_credential_pool',
3840
4043
  },
3841
4044
  type: 'array',
3842
4045
  },
@@ -3861,6 +4064,7 @@ export default {
3861
4064
  tags: ['/acs'],
3862
4065
  'x-fern-sdk-group-name': ['acs', 'credential_pools'],
3863
4066
  'x-fern-sdk-method-name': 'list',
4067
+ 'x-fern-sdk-return-value': 'acs_credential_pools',
3864
4068
  },
3865
4069
  },
3866
4070
  '/acs/credential_provisioning_automations/launch': {
@@ -3899,27 +4103,7 @@ export default {
3899
4103
  schema: {
3900
4104
  properties: {
3901
4105
  acs_credential_provisioning_automation: {
3902
- properties: {
3903
- acs_credential_provisioning_automation_id: {
3904
- format: 'uuid',
3905
- type: 'string',
3906
- },
3907
- created_at: { format: 'date-time', type: 'string' },
3908
- credential_manager_acs_system_id: {
3909
- format: 'uuid',
3910
- type: 'string',
3911
- },
3912
- user_identity_id: { format: 'uuid', type: 'string' },
3913
- workspace_id: { format: 'uuid', type: 'string' },
3914
- },
3915
- required: [
3916
- 'acs_credential_provisioning_automation_id',
3917
- 'credential_manager_acs_system_id',
3918
- 'user_identity_id',
3919
- 'created_at',
3920
- 'workspace_id',
3921
- ],
3922
- type: 'object',
4106
+ $ref: '#/components/schemas/acs_credential_provisioning_automation',
3923
4107
  },
3924
4108
  ok: { type: 'boolean' },
3925
4109
  },
@@ -3942,6 +4126,7 @@ export default {
3942
4126
  tags: ['/acs'],
3943
4127
  'x-fern-sdk-group-name': ['acs', 'credential_provisioning_automations'],
3944
4128
  'x-fern-sdk-method-name': 'launch',
4129
+ 'x-fern-sdk-return-value': 'acs_credential_provisioning_automation',
3945
4130
  },
3946
4131
  },
3947
4132
  '/acs/credentials/assign': {
@@ -3968,90 +4153,7 @@ export default {
3968
4153
  schema: {
3969
4154
  properties: {
3970
4155
  acs_credential: {
3971
- properties: {
3972
- access_method: {
3973
- enum: ['code', 'card', 'mobile_key'],
3974
- type: 'string',
3975
- },
3976
- acs_credential_id: { format: 'uuid', type: 'string' },
3977
- acs_credential_pool_id: {
3978
- format: 'uuid',
3979
- type: 'string',
3980
- },
3981
- acs_system_id: { format: 'uuid', type: 'string' },
3982
- acs_user_id: { format: 'uuid', type: 'string' },
3983
- code: { nullable: true, type: 'string' },
3984
- created_at: { format: 'date-time', type: 'string' },
3985
- display_name: { minLength: 1, type: 'string' },
3986
- ends_at: { type: 'string' },
3987
- errors: {
3988
- items: {
3989
- properties: {
3990
- error_code: { type: 'string' },
3991
- message: { type: 'string' },
3992
- },
3993
- required: ['error_code', 'message'],
3994
- type: 'object',
3995
- },
3996
- type: 'array',
3997
- },
3998
- external_type: {
3999
- enum: [
4000
- 'pti_card',
4001
- 'brivo_credential',
4002
- 'hid_credential',
4003
- 'visionline_card',
4004
- ],
4005
- type: 'string',
4006
- },
4007
- external_type_display_name: { type: 'string' },
4008
- is_multi_phone_sync_credential: { type: 'boolean' },
4009
- parent_acs_credential_id: {
4010
- format: 'uuid',
4011
- type: 'string',
4012
- },
4013
- starts_at: { type: 'string' },
4014
- visionline_metadata: {
4015
- properties: {
4016
- common_acs_entrance_ids: {
4017
- items: { format: 'uuid', type: 'string' },
4018
- type: 'array',
4019
- },
4020
- guest_acs_entrance_ids: {
4021
- items: { format: 'uuid', type: 'string' },
4022
- type: 'array',
4023
- },
4024
- joiner_acs_credential_ids: {
4025
- items: { format: 'uuid', type: 'string' },
4026
- type: 'array',
4027
- },
4028
- },
4029
- type: 'object',
4030
- },
4031
- warnings: {
4032
- items: {
4033
- properties: {
4034
- message: { type: 'string' },
4035
- warning_code: { type: 'string' },
4036
- },
4037
- required: ['warning_code', 'message'],
4038
- type: 'object',
4039
- },
4040
- type: 'array',
4041
- },
4042
- workspace_id: { format: 'uuid', type: 'string' },
4043
- },
4044
- required: [
4045
- 'acs_credential_id',
4046
- 'acs_system_id',
4047
- 'display_name',
4048
- 'access_method',
4049
- 'created_at',
4050
- 'workspace_id',
4051
- 'errors',
4052
- 'warnings',
4053
- ],
4054
- type: 'object',
4156
+ $ref: '#/components/schemas/acs_credential',
4055
4157
  },
4056
4158
  ok: { type: 'boolean' },
4057
4159
  },
@@ -4097,90 +4199,7 @@ export default {
4097
4199
  schema: {
4098
4200
  properties: {
4099
4201
  acs_credential: {
4100
- properties: {
4101
- access_method: {
4102
- enum: ['code', 'card', 'mobile_key'],
4103
- type: 'string',
4104
- },
4105
- acs_credential_id: { format: 'uuid', type: 'string' },
4106
- acs_credential_pool_id: {
4107
- format: 'uuid',
4108
- type: 'string',
4109
- },
4110
- acs_system_id: { format: 'uuid', type: 'string' },
4111
- acs_user_id: { format: 'uuid', type: 'string' },
4112
- code: { nullable: true, type: 'string' },
4113
- created_at: { format: 'date-time', type: 'string' },
4114
- display_name: { minLength: 1, type: 'string' },
4115
- ends_at: { type: 'string' },
4116
- errors: {
4117
- items: {
4118
- properties: {
4119
- error_code: { type: 'string' },
4120
- message: { type: 'string' },
4121
- },
4122
- required: ['error_code', 'message'],
4123
- type: 'object',
4124
- },
4125
- type: 'array',
4126
- },
4127
- external_type: {
4128
- enum: [
4129
- 'pti_card',
4130
- 'brivo_credential',
4131
- 'hid_credential',
4132
- 'visionline_card',
4133
- ],
4134
- type: 'string',
4135
- },
4136
- external_type_display_name: { type: 'string' },
4137
- is_multi_phone_sync_credential: { type: 'boolean' },
4138
- parent_acs_credential_id: {
4139
- format: 'uuid',
4140
- type: 'string',
4141
- },
4142
- starts_at: { type: 'string' },
4143
- visionline_metadata: {
4144
- properties: {
4145
- common_acs_entrance_ids: {
4146
- items: { format: 'uuid', type: 'string' },
4147
- type: 'array',
4148
- },
4149
- guest_acs_entrance_ids: {
4150
- items: { format: 'uuid', type: 'string' },
4151
- type: 'array',
4152
- },
4153
- joiner_acs_credential_ids: {
4154
- items: { format: 'uuid', type: 'string' },
4155
- type: 'array',
4156
- },
4157
- },
4158
- type: 'object',
4159
- },
4160
- warnings: {
4161
- items: {
4162
- properties: {
4163
- message: { type: 'string' },
4164
- warning_code: { type: 'string' },
4165
- },
4166
- required: ['warning_code', 'message'],
4167
- type: 'object',
4168
- },
4169
- type: 'array',
4170
- },
4171
- workspace_id: { format: 'uuid', type: 'string' },
4172
- },
4173
- required: [
4174
- 'acs_credential_id',
4175
- 'acs_system_id',
4176
- 'display_name',
4177
- 'access_method',
4178
- 'created_at',
4179
- 'workspace_id',
4180
- 'errors',
4181
- 'warnings',
4182
- ],
4183
- type: 'object',
4202
+ $ref: '#/components/schemas/acs_credential',
4184
4203
  },
4185
4204
  ok: { type: 'boolean' },
4186
4205
  },
@@ -4266,90 +4285,7 @@ export default {
4266
4285
  schema: {
4267
4286
  properties: {
4268
4287
  acs_credential: {
4269
- properties: {
4270
- access_method: {
4271
- enum: ['code', 'card', 'mobile_key'],
4272
- type: 'string',
4273
- },
4274
- acs_credential_id: { format: 'uuid', type: 'string' },
4275
- acs_credential_pool_id: {
4276
- format: 'uuid',
4277
- type: 'string',
4278
- },
4279
- acs_system_id: { format: 'uuid', type: 'string' },
4280
- acs_user_id: { format: 'uuid', type: 'string' },
4281
- code: { nullable: true, type: 'string' },
4282
- created_at: { format: 'date-time', type: 'string' },
4283
- display_name: { minLength: 1, type: 'string' },
4284
- ends_at: { type: 'string' },
4285
- errors: {
4286
- items: {
4287
- properties: {
4288
- error_code: { type: 'string' },
4289
- message: { type: 'string' },
4290
- },
4291
- required: ['error_code', 'message'],
4292
- type: 'object',
4293
- },
4294
- type: 'array',
4295
- },
4296
- external_type: {
4297
- enum: [
4298
- 'pti_card',
4299
- 'brivo_credential',
4300
- 'hid_credential',
4301
- 'visionline_card',
4302
- ],
4303
- type: 'string',
4304
- },
4305
- external_type_display_name: { type: 'string' },
4306
- is_multi_phone_sync_credential: { type: 'boolean' },
4307
- parent_acs_credential_id: {
4308
- format: 'uuid',
4309
- type: 'string',
4310
- },
4311
- starts_at: { type: 'string' },
4312
- visionline_metadata: {
4313
- properties: {
4314
- common_acs_entrance_ids: {
4315
- items: { format: 'uuid', type: 'string' },
4316
- type: 'array',
4317
- },
4318
- guest_acs_entrance_ids: {
4319
- items: { format: 'uuid', type: 'string' },
4320
- type: 'array',
4321
- },
4322
- joiner_acs_credential_ids: {
4323
- items: { format: 'uuid', type: 'string' },
4324
- type: 'array',
4325
- },
4326
- },
4327
- type: 'object',
4328
- },
4329
- warnings: {
4330
- items: {
4331
- properties: {
4332
- message: { type: 'string' },
4333
- warning_code: { type: 'string' },
4334
- },
4335
- required: ['warning_code', 'message'],
4336
- type: 'object',
4337
- },
4338
- type: 'array',
4339
- },
4340
- workspace_id: { format: 'uuid', type: 'string' },
4341
- },
4342
- required: [
4343
- 'acs_credential_id',
4344
- 'acs_system_id',
4345
- 'display_name',
4346
- 'access_method',
4347
- 'created_at',
4348
- 'workspace_id',
4349
- 'errors',
4350
- 'warnings',
4351
- ],
4352
- type: 'object',
4288
+ $ref: '#/components/schemas/acs_credential',
4353
4289
  },
4354
4290
  ok: { type: 'boolean' },
4355
4291
  },
@@ -4372,6 +4308,7 @@ export default {
4372
4308
  tags: ['/acs'],
4373
4309
  'x-fern-sdk-group-name': ['acs', 'credentials'],
4374
4310
  'x-fern-sdk-method-name': 'create',
4311
+ 'x-fern-sdk-return-value': 'acs_credential',
4375
4312
  },
4376
4313
  },
4377
4314
  '/acs/credentials/delete': {
@@ -4440,90 +4377,7 @@ export default {
4440
4377
  schema: {
4441
4378
  properties: {
4442
4379
  acs_credential: {
4443
- properties: {
4444
- access_method: {
4445
- enum: ['code', 'card', 'mobile_key'],
4446
- type: 'string',
4447
- },
4448
- acs_credential_id: { format: 'uuid', type: 'string' },
4449
- acs_credential_pool_id: {
4450
- format: 'uuid',
4451
- type: 'string',
4452
- },
4453
- acs_system_id: { format: 'uuid', type: 'string' },
4454
- acs_user_id: { format: 'uuid', type: 'string' },
4455
- code: { nullable: true, type: 'string' },
4456
- created_at: { format: 'date-time', type: 'string' },
4457
- display_name: { minLength: 1, type: 'string' },
4458
- ends_at: { type: 'string' },
4459
- errors: {
4460
- items: {
4461
- properties: {
4462
- error_code: { type: 'string' },
4463
- message: { type: 'string' },
4464
- },
4465
- required: ['error_code', 'message'],
4466
- type: 'object',
4467
- },
4468
- type: 'array',
4469
- },
4470
- external_type: {
4471
- enum: [
4472
- 'pti_card',
4473
- 'brivo_credential',
4474
- 'hid_credential',
4475
- 'visionline_card',
4476
- ],
4477
- type: 'string',
4478
- },
4479
- external_type_display_name: { type: 'string' },
4480
- is_multi_phone_sync_credential: { type: 'boolean' },
4481
- parent_acs_credential_id: {
4482
- format: 'uuid',
4483
- type: 'string',
4484
- },
4485
- starts_at: { type: 'string' },
4486
- visionline_metadata: {
4487
- properties: {
4488
- common_acs_entrance_ids: {
4489
- items: { format: 'uuid', type: 'string' },
4490
- type: 'array',
4491
- },
4492
- guest_acs_entrance_ids: {
4493
- items: { format: 'uuid', type: 'string' },
4494
- type: 'array',
4495
- },
4496
- joiner_acs_credential_ids: {
4497
- items: { format: 'uuid', type: 'string' },
4498
- type: 'array',
4499
- },
4500
- },
4501
- type: 'object',
4502
- },
4503
- warnings: {
4504
- items: {
4505
- properties: {
4506
- message: { type: 'string' },
4507
- warning_code: { type: 'string' },
4508
- },
4509
- required: ['warning_code', 'message'],
4510
- type: 'object',
4511
- },
4512
- type: 'array',
4513
- },
4514
- workspace_id: { format: 'uuid', type: 'string' },
4515
- },
4516
- required: [
4517
- 'acs_credential_id',
4518
- 'acs_system_id',
4519
- 'display_name',
4520
- 'access_method',
4521
- 'created_at',
4522
- 'workspace_id',
4523
- 'errors',
4524
- 'warnings',
4525
- ],
4526
- type: 'object',
4380
+ $ref: '#/components/schemas/acs_credential',
4527
4381
  },
4528
4382
  ok: { type: 'boolean' },
4529
4383
  },
@@ -4546,6 +4400,7 @@ export default {
4546
4400
  tags: ['/acs'],
4547
4401
  'x-fern-sdk-group-name': ['acs', 'credentials'],
4548
4402
  'x-fern-sdk-method-name': 'get',
4403
+ 'x-fern-sdk-return-value': 'acs_credential',
4549
4404
  },
4550
4405
  },
4551
4406
  '/acs/credentials/list': {
@@ -4607,92 +4462,7 @@ export default {
4607
4462
  schema: {
4608
4463
  properties: {
4609
4464
  acs_credentials: {
4610
- items: {
4611
- properties: {
4612
- access_method: {
4613
- enum: ['code', 'card', 'mobile_key'],
4614
- type: 'string',
4615
- },
4616
- acs_credential_id: { format: 'uuid', type: 'string' },
4617
- acs_credential_pool_id: {
4618
- format: 'uuid',
4619
- type: 'string',
4620
- },
4621
- acs_system_id: { format: 'uuid', type: 'string' },
4622
- acs_user_id: { format: 'uuid', type: 'string' },
4623
- code: { nullable: true, type: 'string' },
4624
- created_at: { format: 'date-time', type: 'string' },
4625
- display_name: { minLength: 1, type: 'string' },
4626
- ends_at: { type: 'string' },
4627
- errors: {
4628
- items: {
4629
- properties: {
4630
- error_code: { type: 'string' },
4631
- message: { type: 'string' },
4632
- },
4633
- required: ['error_code', 'message'],
4634
- type: 'object',
4635
- },
4636
- type: 'array',
4637
- },
4638
- external_type: {
4639
- enum: [
4640
- 'pti_card',
4641
- 'brivo_credential',
4642
- 'hid_credential',
4643
- 'visionline_card',
4644
- ],
4645
- type: 'string',
4646
- },
4647
- external_type_display_name: { type: 'string' },
4648
- is_multi_phone_sync_credential: { type: 'boolean' },
4649
- parent_acs_credential_id: {
4650
- format: 'uuid',
4651
- type: 'string',
4652
- },
4653
- starts_at: { type: 'string' },
4654
- visionline_metadata: {
4655
- properties: {
4656
- common_acs_entrance_ids: {
4657
- items: { format: 'uuid', type: 'string' },
4658
- type: 'array',
4659
- },
4660
- guest_acs_entrance_ids: {
4661
- items: { format: 'uuid', type: 'string' },
4662
- type: 'array',
4663
- },
4664
- joiner_acs_credential_ids: {
4665
- items: { format: 'uuid', type: 'string' },
4666
- type: 'array',
4667
- },
4668
- },
4669
- type: 'object',
4670
- },
4671
- warnings: {
4672
- items: {
4673
- properties: {
4674
- message: { type: 'string' },
4675
- warning_code: { type: 'string' },
4676
- },
4677
- required: ['warning_code', 'message'],
4678
- type: 'object',
4679
- },
4680
- type: 'array',
4681
- },
4682
- workspace_id: { format: 'uuid', type: 'string' },
4683
- },
4684
- required: [
4685
- 'acs_credential_id',
4686
- 'acs_system_id',
4687
- 'display_name',
4688
- 'access_method',
4689
- 'created_at',
4690
- 'workspace_id',
4691
- 'errors',
4692
- 'warnings',
4693
- ],
4694
- type: 'object',
4695
- },
4465
+ items: { $ref: '#/components/schemas/acs_credential' },
4696
4466
  type: 'array',
4697
4467
  },
4698
4468
  ok: { type: 'boolean' },
@@ -4717,6 +4487,7 @@ export default {
4717
4487
  tags: ['/acs'],
4718
4488
  'x-fern-sdk-group-name': ['acs', 'credentials'],
4719
4489
  'x-fern-sdk-method-name': 'list',
4490
+ 'x-fern-sdk-return-value': 'acs_credentials',
4720
4491
  },
4721
4492
  },
4722
4493
  '/acs/credentials/unassign': {
@@ -4743,90 +4514,7 @@ export default {
4743
4514
  schema: {
4744
4515
  properties: {
4745
4516
  acs_credential: {
4746
- properties: {
4747
- access_method: {
4748
- enum: ['code', 'card', 'mobile_key'],
4749
- type: 'string',
4750
- },
4751
- acs_credential_id: { format: 'uuid', type: 'string' },
4752
- acs_credential_pool_id: {
4753
- format: 'uuid',
4754
- type: 'string',
4755
- },
4756
- acs_system_id: { format: 'uuid', type: 'string' },
4757
- acs_user_id: { format: 'uuid', type: 'string' },
4758
- code: { nullable: true, type: 'string' },
4759
- created_at: { format: 'date-time', type: 'string' },
4760
- display_name: { minLength: 1, type: 'string' },
4761
- ends_at: { type: 'string' },
4762
- errors: {
4763
- items: {
4764
- properties: {
4765
- error_code: { type: 'string' },
4766
- message: { type: 'string' },
4767
- },
4768
- required: ['error_code', 'message'],
4769
- type: 'object',
4770
- },
4771
- type: 'array',
4772
- },
4773
- external_type: {
4774
- enum: [
4775
- 'pti_card',
4776
- 'brivo_credential',
4777
- 'hid_credential',
4778
- 'visionline_card',
4779
- ],
4780
- type: 'string',
4781
- },
4782
- external_type_display_name: { type: 'string' },
4783
- is_multi_phone_sync_credential: { type: 'boolean' },
4784
- parent_acs_credential_id: {
4785
- format: 'uuid',
4786
- type: 'string',
4787
- },
4788
- starts_at: { type: 'string' },
4789
- visionline_metadata: {
4790
- properties: {
4791
- common_acs_entrance_ids: {
4792
- items: { format: 'uuid', type: 'string' },
4793
- type: 'array',
4794
- },
4795
- guest_acs_entrance_ids: {
4796
- items: { format: 'uuid', type: 'string' },
4797
- type: 'array',
4798
- },
4799
- joiner_acs_credential_ids: {
4800
- items: { format: 'uuid', type: 'string' },
4801
- type: 'array',
4802
- },
4803
- },
4804
- type: 'object',
4805
- },
4806
- warnings: {
4807
- items: {
4808
- properties: {
4809
- message: { type: 'string' },
4810
- warning_code: { type: 'string' },
4811
- },
4812
- required: ['warning_code', 'message'],
4813
- type: 'object',
4814
- },
4815
- type: 'array',
4816
- },
4817
- workspace_id: { format: 'uuid', type: 'string' },
4818
- },
4819
- required: [
4820
- 'acs_credential_id',
4821
- 'acs_system_id',
4822
- 'display_name',
4823
- 'access_method',
4824
- 'created_at',
4825
- 'workspace_id',
4826
- 'errors',
4827
- 'warnings',
4828
- ],
4829
- type: 'object',
4517
+ $ref: '#/components/schemas/acs_credential',
4830
4518
  },
4831
4519
  ok: { type: 'boolean' },
4832
4520
  },
@@ -4872,90 +4560,7 @@ export default {
4872
4560
  schema: {
4873
4561
  properties: {
4874
4562
  acs_credential: {
4875
- properties: {
4876
- access_method: {
4877
- enum: ['code', 'card', 'mobile_key'],
4878
- type: 'string',
4879
- },
4880
- acs_credential_id: { format: 'uuid', type: 'string' },
4881
- acs_credential_pool_id: {
4882
- format: 'uuid',
4883
- type: 'string',
4884
- },
4885
- acs_system_id: { format: 'uuid', type: 'string' },
4886
- acs_user_id: { format: 'uuid', type: 'string' },
4887
- code: { nullable: true, type: 'string' },
4888
- created_at: { format: 'date-time', type: 'string' },
4889
- display_name: { minLength: 1, type: 'string' },
4890
- ends_at: { type: 'string' },
4891
- errors: {
4892
- items: {
4893
- properties: {
4894
- error_code: { type: 'string' },
4895
- message: { type: 'string' },
4896
- },
4897
- required: ['error_code', 'message'],
4898
- type: 'object',
4899
- },
4900
- type: 'array',
4901
- },
4902
- external_type: {
4903
- enum: [
4904
- 'pti_card',
4905
- 'brivo_credential',
4906
- 'hid_credential',
4907
- 'visionline_card',
4908
- ],
4909
- type: 'string',
4910
- },
4911
- external_type_display_name: { type: 'string' },
4912
- is_multi_phone_sync_credential: { type: 'boolean' },
4913
- parent_acs_credential_id: {
4914
- format: 'uuid',
4915
- type: 'string',
4916
- },
4917
- starts_at: { type: 'string' },
4918
- visionline_metadata: {
4919
- properties: {
4920
- common_acs_entrance_ids: {
4921
- items: { format: 'uuid', type: 'string' },
4922
- type: 'array',
4923
- },
4924
- guest_acs_entrance_ids: {
4925
- items: { format: 'uuid', type: 'string' },
4926
- type: 'array',
4927
- },
4928
- joiner_acs_credential_ids: {
4929
- items: { format: 'uuid', type: 'string' },
4930
- type: 'array',
4931
- },
4932
- },
4933
- type: 'object',
4934
- },
4935
- warnings: {
4936
- items: {
4937
- properties: {
4938
- message: { type: 'string' },
4939
- warning_code: { type: 'string' },
4940
- },
4941
- required: ['warning_code', 'message'],
4942
- type: 'object',
4943
- },
4944
- type: 'array',
4945
- },
4946
- workspace_id: { format: 'uuid', type: 'string' },
4947
- },
4948
- required: [
4949
- 'acs_credential_id',
4950
- 'acs_system_id',
4951
- 'display_name',
4952
- 'access_method',
4953
- 'created_at',
4954
- 'workspace_id',
4955
- 'errors',
4956
- 'warnings',
4957
- ],
4958
- type: 'object',
4563
+ $ref: '#/components/schemas/acs_credential',
4959
4564
  },
4960
4565
  ok: { type: 'boolean' },
4961
4566
  },
@@ -4985,109 +4590,26 @@ export default {
4985
4590
  operationId: 'acsCredentialsUpdatePatch',
4986
4591
  requestBody: {
4987
4592
  content: {
4988
- 'application/json': {
4989
- schema: {
4990
- properties: {
4991
- acs_credential_id: { type: 'string' },
4992
- code: { pattern: '^\\d+$', type: 'string' },
4993
- },
4994
- required: ['acs_credential_id', 'code'],
4995
- type: 'object',
4996
- },
4997
- },
4998
- },
4999
- },
5000
- responses: {
5001
- 200: {
5002
- content: {
5003
- 'application/json': {
5004
- schema: {
5005
- properties: {
5006
- acs_credential: {
5007
- properties: {
5008
- access_method: {
5009
- enum: ['code', 'card', 'mobile_key'],
5010
- type: 'string',
5011
- },
5012
- acs_credential_id: { format: 'uuid', type: 'string' },
5013
- acs_credential_pool_id: {
5014
- format: 'uuid',
5015
- type: 'string',
5016
- },
5017
- acs_system_id: { format: 'uuid', type: 'string' },
5018
- acs_user_id: { format: 'uuid', type: 'string' },
5019
- code: { nullable: true, type: 'string' },
5020
- created_at: { format: 'date-time', type: 'string' },
5021
- display_name: { minLength: 1, type: 'string' },
5022
- ends_at: { type: 'string' },
5023
- errors: {
5024
- items: {
5025
- properties: {
5026
- error_code: { type: 'string' },
5027
- message: { type: 'string' },
5028
- },
5029
- required: ['error_code', 'message'],
5030
- type: 'object',
5031
- },
5032
- type: 'array',
5033
- },
5034
- external_type: {
5035
- enum: [
5036
- 'pti_card',
5037
- 'brivo_credential',
5038
- 'hid_credential',
5039
- 'visionline_card',
5040
- ],
5041
- type: 'string',
5042
- },
5043
- external_type_display_name: { type: 'string' },
5044
- is_multi_phone_sync_credential: { type: 'boolean' },
5045
- parent_acs_credential_id: {
5046
- format: 'uuid',
5047
- type: 'string',
5048
- },
5049
- starts_at: { type: 'string' },
5050
- visionline_metadata: {
5051
- properties: {
5052
- common_acs_entrance_ids: {
5053
- items: { format: 'uuid', type: 'string' },
5054
- type: 'array',
5055
- },
5056
- guest_acs_entrance_ids: {
5057
- items: { format: 'uuid', type: 'string' },
5058
- type: 'array',
5059
- },
5060
- joiner_acs_credential_ids: {
5061
- items: { format: 'uuid', type: 'string' },
5062
- type: 'array',
5063
- },
5064
- },
5065
- type: 'object',
5066
- },
5067
- warnings: {
5068
- items: {
5069
- properties: {
5070
- message: { type: 'string' },
5071
- warning_code: { type: 'string' },
5072
- },
5073
- required: ['warning_code', 'message'],
5074
- type: 'object',
5075
- },
5076
- type: 'array',
5077
- },
5078
- workspace_id: { format: 'uuid', type: 'string' },
5079
- },
5080
- required: [
5081
- 'acs_credential_id',
5082
- 'acs_system_id',
5083
- 'display_name',
5084
- 'access_method',
5085
- 'created_at',
5086
- 'workspace_id',
5087
- 'errors',
5088
- 'warnings',
5089
- ],
5090
- type: 'object',
4593
+ 'application/json': {
4594
+ schema: {
4595
+ properties: {
4596
+ acs_credential_id: { type: 'string' },
4597
+ code: { pattern: '^\\d+$', type: 'string' },
4598
+ },
4599
+ required: ['acs_credential_id', 'code'],
4600
+ type: 'object',
4601
+ },
4602
+ },
4603
+ },
4604
+ },
4605
+ responses: {
4606
+ 200: {
4607
+ content: {
4608
+ 'application/json': {
4609
+ schema: {
4610
+ properties: {
4611
+ acs_credential: {
4612
+ $ref: '#/components/schemas/acs_credential',
5091
4613
  },
5092
4614
  ok: { type: 'boolean' },
5093
4615
  },
@@ -5133,90 +4655,7 @@ export default {
5133
4655
  schema: {
5134
4656
  properties: {
5135
4657
  acs_credential: {
5136
- properties: {
5137
- access_method: {
5138
- enum: ['code', 'card', 'mobile_key'],
5139
- type: 'string',
5140
- },
5141
- acs_credential_id: { format: 'uuid', type: 'string' },
5142
- acs_credential_pool_id: {
5143
- format: 'uuid',
5144
- type: 'string',
5145
- },
5146
- acs_system_id: { format: 'uuid', type: 'string' },
5147
- acs_user_id: { format: 'uuid', type: 'string' },
5148
- code: { nullable: true, type: 'string' },
5149
- created_at: { format: 'date-time', type: 'string' },
5150
- display_name: { minLength: 1, type: 'string' },
5151
- ends_at: { type: 'string' },
5152
- errors: {
5153
- items: {
5154
- properties: {
5155
- error_code: { type: 'string' },
5156
- message: { type: 'string' },
5157
- },
5158
- required: ['error_code', 'message'],
5159
- type: 'object',
5160
- },
5161
- type: 'array',
5162
- },
5163
- external_type: {
5164
- enum: [
5165
- 'pti_card',
5166
- 'brivo_credential',
5167
- 'hid_credential',
5168
- 'visionline_card',
5169
- ],
5170
- type: 'string',
5171
- },
5172
- external_type_display_name: { type: 'string' },
5173
- is_multi_phone_sync_credential: { type: 'boolean' },
5174
- parent_acs_credential_id: {
5175
- format: 'uuid',
5176
- type: 'string',
5177
- },
5178
- starts_at: { type: 'string' },
5179
- visionline_metadata: {
5180
- properties: {
5181
- common_acs_entrance_ids: {
5182
- items: { format: 'uuid', type: 'string' },
5183
- type: 'array',
5184
- },
5185
- guest_acs_entrance_ids: {
5186
- items: { format: 'uuid', type: 'string' },
5187
- type: 'array',
5188
- },
5189
- joiner_acs_credential_ids: {
5190
- items: { format: 'uuid', type: 'string' },
5191
- type: 'array',
5192
- },
5193
- },
5194
- type: 'object',
5195
- },
5196
- warnings: {
5197
- items: {
5198
- properties: {
5199
- message: { type: 'string' },
5200
- warning_code: { type: 'string' },
5201
- },
5202
- required: ['warning_code', 'message'],
5203
- type: 'object',
5204
- },
5205
- type: 'array',
5206
- },
5207
- workspace_id: { format: 'uuid', type: 'string' },
5208
- },
5209
- required: [
5210
- 'acs_credential_id',
5211
- 'acs_system_id',
5212
- 'display_name',
5213
- 'access_method',
5214
- 'created_at',
5215
- 'workspace_id',
5216
- 'errors',
5217
- 'warnings',
5218
- ],
5219
- type: 'object',
4658
+ $ref: '#/components/schemas/acs_credential',
5220
4659
  },
5221
4660
  ok: { type: 'boolean' },
5222
4661
  },
@@ -5263,76 +4702,7 @@ export default {
5263
4702
  'application/json': {
5264
4703
  schema: {
5265
4704
  properties: {
5266
- acs_entrance: {
5267
- properties: {
5268
- acs_entrance_id: { format: 'uuid', type: 'string' },
5269
- acs_system_id: { format: 'uuid', type: 'string' },
5270
- created_at: { format: 'date-time', type: 'string' },
5271
- display_name: { type: 'string' },
5272
- latch_metadata: {
5273
- nullable: true,
5274
- properties: {
5275
- accessibility_type: { type: 'string' },
5276
- is_connected: { type: 'boolean' },
5277
- name: { type: 'string' },
5278
- type: { type: 'string' },
5279
- },
5280
- required: [
5281
- 'accessibility_type',
5282
- 'name',
5283
- 'type',
5284
- 'is_connected',
5285
- ],
5286
- type: 'object',
5287
- },
5288
- visionline_metadata: {
5289
- nullable: true,
5290
- properties: {
5291
- door_category: {
5292
- enum: [
5293
- 'entrance',
5294
- 'guest',
5295
- 'elevator reader',
5296
- 'common',
5297
- 'common (PMS)',
5298
- ],
5299
- type: 'string',
5300
- },
5301
- door_name: { type: 'string' },
5302
- profiles: {
5303
- items: {
5304
- properties: {
5305
- visionline_door_profile_id: {
5306
- type: 'string',
5307
- },
5308
- visionline_door_profile_type: {
5309
- enum: ['BLE', 'commonDoor', 'touch'],
5310
- type: 'string',
5311
- },
5312
- },
5313
- required: [
5314
- 'visionline_door_profile_id',
5315
- 'visionline_door_profile_type',
5316
- ],
5317
- type: 'object',
5318
- },
5319
- type: 'array',
5320
- },
5321
- },
5322
- required: ['door_name', 'door_category'],
5323
- type: 'object',
5324
- },
5325
- },
5326
- required: [
5327
- 'acs_entrance_id',
5328
- 'display_name',
5329
- 'acs_system_id',
5330
- 'created_at',
5331
- 'latch_metadata',
5332
- 'visionline_metadata',
5333
- ],
5334
- type: 'object',
5335
- },
4705
+ acs_entrance: { $ref: '#/components/schemas/acs_entrance' },
5336
4706
  ok: { type: 'boolean' },
5337
4707
  },
5338
4708
  required: ['acs_entrance', 'ok'],
@@ -5355,6 +4725,7 @@ export default {
5355
4725
  tags: ['/acs'],
5356
4726
  'x-fern-sdk-group-name': ['acs', 'entrances'],
5357
4727
  'x-fern-sdk-method-name': 'get',
4728
+ 'x-fern-sdk-return-value': 'acs_entrance',
5358
4729
  },
5359
4730
  },
5360
4731
  '/acs/entrances/grant_access': {
@@ -5425,76 +4796,7 @@ export default {
5425
4796
  schema: {
5426
4797
  properties: {
5427
4798
  acs_entrances: {
5428
- items: {
5429
- properties: {
5430
- acs_entrance_id: { format: 'uuid', type: 'string' },
5431
- acs_system_id: { format: 'uuid', type: 'string' },
5432
- created_at: { format: 'date-time', type: 'string' },
5433
- display_name: { type: 'string' },
5434
- latch_metadata: {
5435
- nullable: true,
5436
- properties: {
5437
- accessibility_type: { type: 'string' },
5438
- is_connected: { type: 'boolean' },
5439
- name: { type: 'string' },
5440
- type: { type: 'string' },
5441
- },
5442
- required: [
5443
- 'accessibility_type',
5444
- 'name',
5445
- 'type',
5446
- 'is_connected',
5447
- ],
5448
- type: 'object',
5449
- },
5450
- visionline_metadata: {
5451
- nullable: true,
5452
- properties: {
5453
- door_category: {
5454
- enum: [
5455
- 'entrance',
5456
- 'guest',
5457
- 'elevator reader',
5458
- 'common',
5459
- 'common (PMS)',
5460
- ],
5461
- type: 'string',
5462
- },
5463
- door_name: { type: 'string' },
5464
- profiles: {
5465
- items: {
5466
- properties: {
5467
- visionline_door_profile_id: {
5468
- type: 'string',
5469
- },
5470
- visionline_door_profile_type: {
5471
- enum: ['BLE', 'commonDoor', 'touch'],
5472
- type: 'string',
5473
- },
5474
- },
5475
- required: [
5476
- 'visionline_door_profile_id',
5477
- 'visionline_door_profile_type',
5478
- ],
5479
- type: 'object',
5480
- },
5481
- type: 'array',
5482
- },
5483
- },
5484
- required: ['door_name', 'door_category'],
5485
- type: 'object',
5486
- },
5487
- },
5488
- required: [
5489
- 'acs_entrance_id',
5490
- 'display_name',
5491
- 'acs_system_id',
5492
- 'created_at',
5493
- 'latch_metadata',
5494
- 'visionline_metadata',
5495
- ],
5496
- type: 'object',
5497
- },
4799
+ items: { $ref: '#/components/schemas/acs_entrance' },
5498
4800
  type: 'array',
5499
4801
  },
5500
4802
  ok: { type: 'boolean' },
@@ -5519,6 +4821,7 @@ export default {
5519
4821
  tags: ['/acs'],
5520
4822
  'x-fern-sdk-group-name': ['acs', 'entrances'],
5521
4823
  'x-fern-sdk-method-name': 'list',
4824
+ 'x-fern-sdk-return-value': 'acs_entrances',
5522
4825
  },
5523
4826
  },
5524
4827
  '/acs/entrances/list_credentials_with_access': {
@@ -5551,92 +4854,7 @@ export default {
5551
4854
  schema: {
5552
4855
  properties: {
5553
4856
  acs_credentials: {
5554
- items: {
5555
- properties: {
5556
- access_method: {
5557
- enum: ['code', 'card', 'mobile_key'],
5558
- type: 'string',
5559
- },
5560
- acs_credential_id: { format: 'uuid', type: 'string' },
5561
- acs_credential_pool_id: {
5562
- format: 'uuid',
5563
- type: 'string',
5564
- },
5565
- acs_system_id: { format: 'uuid', type: 'string' },
5566
- acs_user_id: { format: 'uuid', type: 'string' },
5567
- code: { nullable: true, type: 'string' },
5568
- created_at: { format: 'date-time', type: 'string' },
5569
- display_name: { minLength: 1, type: 'string' },
5570
- ends_at: { type: 'string' },
5571
- errors: {
5572
- items: {
5573
- properties: {
5574
- error_code: { type: 'string' },
5575
- message: { type: 'string' },
5576
- },
5577
- required: ['error_code', 'message'],
5578
- type: 'object',
5579
- },
5580
- type: 'array',
5581
- },
5582
- external_type: {
5583
- enum: [
5584
- 'pti_card',
5585
- 'brivo_credential',
5586
- 'hid_credential',
5587
- 'visionline_card',
5588
- ],
5589
- type: 'string',
5590
- },
5591
- external_type_display_name: { type: 'string' },
5592
- is_multi_phone_sync_credential: { type: 'boolean' },
5593
- parent_acs_credential_id: {
5594
- format: 'uuid',
5595
- type: 'string',
5596
- },
5597
- starts_at: { type: 'string' },
5598
- visionline_metadata: {
5599
- properties: {
5600
- common_acs_entrance_ids: {
5601
- items: { format: 'uuid', type: 'string' },
5602
- type: 'array',
5603
- },
5604
- guest_acs_entrance_ids: {
5605
- items: { format: 'uuid', type: 'string' },
5606
- type: 'array',
5607
- },
5608
- joiner_acs_credential_ids: {
5609
- items: { format: 'uuid', type: 'string' },
5610
- type: 'array',
5611
- },
5612
- },
5613
- type: 'object',
5614
- },
5615
- warnings: {
5616
- items: {
5617
- properties: {
5618
- message: { type: 'string' },
5619
- warning_code: { type: 'string' },
5620
- },
5621
- required: ['warning_code', 'message'],
5622
- type: 'object',
5623
- },
5624
- type: 'array',
5625
- },
5626
- workspace_id: { format: 'uuid', type: 'string' },
5627
- },
5628
- required: [
5629
- 'acs_credential_id',
5630
- 'acs_system_id',
5631
- 'display_name',
5632
- 'access_method',
5633
- 'created_at',
5634
- 'workspace_id',
5635
- 'errors',
5636
- 'warnings',
5637
- ],
5638
- type: 'object',
5639
- },
4857
+ items: { $ref: '#/components/schemas/acs_credential' },
5640
4858
  type: 'array',
5641
4859
  },
5642
4860
  ok: { type: 'boolean' },
@@ -5661,6 +4879,7 @@ export default {
5661
4879
  tags: ['/acs'],
5662
4880
  'x-fern-sdk-group-name': ['acs', 'entrances'],
5663
4881
  'x-fern-sdk-method-name': 'list_credentials_with_access',
4882
+ 'x-fern-sdk-return-value': 'acs_credentials',
5664
4883
  },
5665
4884
  },
5666
4885
  '/acs/systems/get': {
@@ -5707,6 +4926,7 @@ export default {
5707
4926
  tags: ['/acs'],
5708
4927
  'x-fern-sdk-group-name': ['acs', 'systems'],
5709
4928
  'x-fern-sdk-method-name': 'get',
4929
+ 'x-fern-sdk-return-value': 'acs_system',
5710
4930
  },
5711
4931
  },
5712
4932
  '/acs/systems/list': {
@@ -5756,6 +4976,7 @@ export default {
5756
4976
  tags: ['/acs'],
5757
4977
  'x-fern-sdk-group-name': ['acs', 'systems'],
5758
4978
  'x-fern-sdk-method-name': 'list',
4979
+ 'x-fern-sdk-return-value': 'acs_systems',
5759
4980
  },
5760
4981
  },
5761
4982
  '/acs/users/add_to_access_group': {
@@ -5909,6 +5130,7 @@ export default {
5909
5130
  tags: ['/acs'],
5910
5131
  'x-fern-sdk-group-name': ['acs', 'users'],
5911
5132
  'x-fern-sdk-method-name': 'create',
5133
+ 'x-fern-sdk-return-value': 'acs_user',
5912
5134
  },
5913
5135
  },
5914
5136
  '/acs/users/delete': {
@@ -5994,6 +5216,7 @@ export default {
5994
5216
  tags: ['/acs'],
5995
5217
  'x-fern-sdk-group-name': ['acs', 'users'],
5996
5218
  'x-fern-sdk-method-name': 'get',
5219
+ 'x-fern-sdk-return-value': 'acs_user',
5997
5220
  },
5998
5221
  },
5999
5222
  '/acs/users/list': {
@@ -6049,6 +5272,7 @@ export default {
6049
5272
  tags: ['/acs'],
6050
5273
  'x-fern-sdk-group-name': ['acs', 'users'],
6051
5274
  'x-fern-sdk-method-name': 'list',
5275
+ 'x-fern-sdk-return-value': 'acs_users',
6052
5276
  },
6053
5277
  },
6054
5278
  '/acs/users/list_accessible_entrances': {
@@ -6072,76 +5296,7 @@ export default {
6072
5296
  schema: {
6073
5297
  properties: {
6074
5298
  acs_entrances: {
6075
- items: {
6076
- properties: {
6077
- acs_entrance_id: { format: 'uuid', type: 'string' },
6078
- acs_system_id: { format: 'uuid', type: 'string' },
6079
- created_at: { format: 'date-time', type: 'string' },
6080
- display_name: { type: 'string' },
6081
- latch_metadata: {
6082
- nullable: true,
6083
- properties: {
6084
- accessibility_type: { type: 'string' },
6085
- is_connected: { type: 'boolean' },
6086
- name: { type: 'string' },
6087
- type: { type: 'string' },
6088
- },
6089
- required: [
6090
- 'accessibility_type',
6091
- 'name',
6092
- 'type',
6093
- 'is_connected',
6094
- ],
6095
- type: 'object',
6096
- },
6097
- visionline_metadata: {
6098
- nullable: true,
6099
- properties: {
6100
- door_category: {
6101
- enum: [
6102
- 'entrance',
6103
- 'guest',
6104
- 'elevator reader',
6105
- 'common',
6106
- 'common (PMS)',
6107
- ],
6108
- type: 'string',
6109
- },
6110
- door_name: { type: 'string' },
6111
- profiles: {
6112
- items: {
6113
- properties: {
6114
- visionline_door_profile_id: {
6115
- type: 'string',
6116
- },
6117
- visionline_door_profile_type: {
6118
- enum: ['BLE', 'commonDoor', 'touch'],
6119
- type: 'string',
6120
- },
6121
- },
6122
- required: [
6123
- 'visionline_door_profile_id',
6124
- 'visionline_door_profile_type',
6125
- ],
6126
- type: 'object',
6127
- },
6128
- type: 'array',
6129
- },
6130
- },
6131
- required: ['door_name', 'door_category'],
6132
- type: 'object',
6133
- },
6134
- },
6135
- required: [
6136
- 'acs_entrance_id',
6137
- 'display_name',
6138
- 'acs_system_id',
6139
- 'created_at',
6140
- 'latch_metadata',
6141
- 'visionline_metadata',
6142
- ],
6143
- type: 'object',
6144
- },
5299
+ items: { $ref: '#/components/schemas/acs_entrance' },
6145
5300
  type: 'array',
6146
5301
  },
6147
5302
  ok: { type: 'boolean' },
@@ -6166,6 +5321,7 @@ export default {
6166
5321
  tags: ['/acs'],
6167
5322
  'x-fern-sdk-group-name': ['acs', 'users'],
6168
5323
  'x-fern-sdk-method-name': 'list_accessible_entrances',
5324
+ 'x-fern-sdk-return-value': 'acs_entrances',
6169
5325
  },
6170
5326
  },
6171
5327
  '/acs/users/remove_from_access_group': {
@@ -9416,21 +8572,7 @@ export default {
9416
8572
  'application/json': {
9417
8573
  schema: {
9418
8574
  properties: {
9419
- network: {
9420
- properties: {
9421
- created_at: { format: 'date-time', type: 'string' },
9422
- display_name: { type: 'string' },
9423
- network_id: { format: 'uuid', type: 'string' },
9424
- workspace_id: { format: 'uuid', type: 'string' },
9425
- },
9426
- required: [
9427
- 'network_id',
9428
- 'workspace_id',
9429
- 'display_name',
9430
- 'created_at',
9431
- ],
9432
- type: 'object',
9433
- },
8575
+ network: { $ref: '#/components/schemas/network' },
9434
8576
  ok: { type: 'boolean' },
9435
8577
  },
9436
8578
  required: ['network', 'ok'],
@@ -9452,6 +8594,7 @@ export default {
9452
8594
  tags: ['/networks'],
9453
8595
  'x-fern-sdk-group-name': ['networks'],
9454
8596
  'x-fern-sdk-method-name': 'get',
8597
+ 'x-fern-sdk-return-value': 'network',
9455
8598
  },
9456
8599
  },
9457
8600
  '/networks/list': {
@@ -9469,21 +8612,7 @@ export default {
9469
8612
  schema: {
9470
8613
  properties: {
9471
8614
  networks: {
9472
- items: {
9473
- properties: {
9474
- created_at: { format: 'date-time', type: 'string' },
9475
- display_name: { type: 'string' },
9476
- network_id: { format: 'uuid', type: 'string' },
9477
- workspace_id: { format: 'uuid', type: 'string' },
9478
- },
9479
- required: [
9480
- 'network_id',
9481
- 'workspace_id',
9482
- 'display_name',
9483
- 'created_at',
9484
- ],
9485
- type: 'object',
9486
- },
8615
+ items: { $ref: '#/components/schemas/network' },
9487
8616
  type: 'array',
9488
8617
  },
9489
8618
  ok: { type: 'boolean' },
@@ -9507,6 +8636,7 @@ export default {
9507
8636
  tags: ['/networks'],
9508
8637
  'x-fern-sdk-group-name': ['networks'],
9509
8638
  'x-fern-sdk-method-name': 'list',
8639
+ 'x-fern-sdk-return-value': 'networks',
9510
8640
  },
9511
8641
  },
9512
8642
  '/noise_sensors/noise_thresholds/create': {
@@ -11359,39 +10489,7 @@ export default {
11359
10489
  properties: {
11360
10490
  ok: { type: 'boolean' },
11361
10491
  user_identity: {
11362
- properties: {
11363
- created_at: { format: 'date-time', type: 'string' },
11364
- display_name: { minLength: 1, type: 'string' },
11365
- email_address: {
11366
- format: 'email',
11367
- nullable: true,
11368
- type: 'string',
11369
- },
11370
- full_name: {
11371
- minLength: 1,
11372
- nullable: true,
11373
- type: 'string',
11374
- },
11375
- phone_number: { nullable: true, type: 'string' },
11376
- user_identity_id: { format: 'uuid', type: 'string' },
11377
- user_identity_key: {
11378
- minLength: 1,
11379
- nullable: true,
11380
- type: 'string',
11381
- },
11382
- workspace_id: { format: 'uuid', type: 'string' },
11383
- },
11384
- required: [
11385
- 'user_identity_id',
11386
- 'user_identity_key',
11387
- 'email_address',
11388
- 'phone_number',
11389
- 'display_name',
11390
- 'full_name',
11391
- 'created_at',
11392
- 'workspace_id',
11393
- ],
11394
- type: 'object',
10492
+ $ref: '#/components/schemas/user_identity',
11395
10493
  },
11396
10494
  },
11397
10495
  required: ['user_identity', 'ok'],
@@ -11413,6 +10511,7 @@ export default {
11413
10511
  tags: ['/user_identities'],
11414
10512
  'x-fern-sdk-group-name': ['user_identities'],
11415
10513
  'x-fern-sdk-method-name': 'create',
10514
+ 'x-fern-sdk-return-value': 'user_identity',
11416
10515
  },
11417
10516
  },
11418
10517
  '/user_identities/delete': {
@@ -11548,6 +10647,7 @@ export default {
11548
10647
  tags: ['/user_identities'],
11549
10648
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
11550
10649
  'x-fern-sdk-method-name': 'get',
10650
+ 'x-fern-sdk-return-value': 'enrollment_automation',
11551
10651
  },
11552
10652
  },
11553
10653
  '/user_identities/enrollment_automations/launch': {
@@ -11634,6 +10734,7 @@ export default {
11634
10734
  tags: ['/user_identities'],
11635
10735
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
11636
10736
  'x-fern-sdk-method-name': 'launch',
10737
+ 'x-fern-sdk-return-value': 'enrollment_automation',
11637
10738
  },
11638
10739
  },
11639
10740
  '/user_identities/enrollment_automations/list': {
@@ -11686,6 +10787,7 @@ export default {
11686
10787
  tags: ['/user_identities'],
11687
10788
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
11688
10789
  'x-fern-sdk-method-name': 'list',
10790
+ 'x-fern-sdk-return-value': 'enrollment_automations',
11689
10791
  },
11690
10792
  },
11691
10793
  '/user_identities/get': {
@@ -11721,39 +10823,7 @@ export default {
11721
10823
  properties: {
11722
10824
  ok: { type: 'boolean' },
11723
10825
  user_identity: {
11724
- properties: {
11725
- created_at: { format: 'date-time', type: 'string' },
11726
- display_name: { minLength: 1, type: 'string' },
11727
- email_address: {
11728
- format: 'email',
11729
- nullable: true,
11730
- type: 'string',
11731
- },
11732
- full_name: {
11733
- minLength: 1,
11734
- nullable: true,
11735
- type: 'string',
11736
- },
11737
- phone_number: { nullable: true, type: 'string' },
11738
- user_identity_id: { format: 'uuid', type: 'string' },
11739
- user_identity_key: {
11740
- minLength: 1,
11741
- nullable: true,
11742
- type: 'string',
11743
- },
11744
- workspace_id: { format: 'uuid', type: 'string' },
11745
- },
11746
- required: [
11747
- 'user_identity_id',
11748
- 'user_identity_key',
11749
- 'email_address',
11750
- 'phone_number',
11751
- 'display_name',
11752
- 'full_name',
11753
- 'created_at',
11754
- 'workspace_id',
11755
- ],
11756
- type: 'object',
10826
+ $ref: '#/components/schemas/user_identity',
11757
10827
  },
11758
10828
  },
11759
10829
  required: ['user_identity', 'ok'],
@@ -11775,6 +10845,7 @@ export default {
11775
10845
  tags: ['/user_identities'],
11776
10846
  'x-fern-sdk-group-name': ['user_identities'],
11777
10847
  'x-fern-sdk-method-name': 'get',
10848
+ 'x-fern-sdk-return-value': 'user_identity',
11778
10849
  },
11779
10850
  },
11780
10851
  '/user_identities/grant_access_to_device': {
@@ -11888,41 +10959,7 @@ export default {
11888
10959
  properties: {
11889
10960
  ok: { type: 'boolean' },
11890
10961
  user_identities: {
11891
- items: {
11892
- properties: {
11893
- created_at: { format: 'date-time', type: 'string' },
11894
- display_name: { minLength: 1, type: 'string' },
11895
- email_address: {
11896
- format: 'email',
11897
- nullable: true,
11898
- type: 'string',
11899
- },
11900
- full_name: {
11901
- minLength: 1,
11902
- nullable: true,
11903
- type: 'string',
11904
- },
11905
- phone_number: { nullable: true, type: 'string' },
11906
- user_identity_id: { format: 'uuid', type: 'string' },
11907
- user_identity_key: {
11908
- minLength: 1,
11909
- nullable: true,
11910
- type: 'string',
11911
- },
11912
- workspace_id: { format: 'uuid', type: 'string' },
11913
- },
11914
- required: [
11915
- 'user_identity_id',
11916
- 'user_identity_key',
11917
- 'email_address',
11918
- 'phone_number',
11919
- 'display_name',
11920
- 'full_name',
11921
- 'created_at',
11922
- 'workspace_id',
11923
- ],
11924
- type: 'object',
11925
- },
10962
+ items: { $ref: '#/components/schemas/user_identity' },
11926
10963
  type: 'array',
11927
10964
  },
11928
10965
  },
@@ -11972,12 +11009,17 @@ export default {
11972
11009
  schema: {
11973
11010
  properties: {
11974
11011
  accessible_devices: {
11012
+ description: '\n ---\n deprecated: use devices.\n ---\n ',
11013
+ items: { $ref: '#/components/schemas/device' },
11014
+ type: 'array',
11015
+ },
11016
+ devices: {
11975
11017
  items: { $ref: '#/components/schemas/device' },
11976
11018
  type: 'array',
11977
11019
  },
11978
11020
  ok: { type: 'boolean' },
11979
11021
  },
11980
- required: ['accessible_devices', 'ok'],
11022
+ required: ['devices', 'accessible_devices', 'ok'],
11981
11023
  type: 'object',
11982
11024
  },
11983
11025
  },
@@ -11996,6 +11038,7 @@ export default {
11996
11038
  tags: ['/user_identities'],
11997
11039
  'x-fern-sdk-group-name': ['user_identities'],
11998
11040
  'x-fern-sdk-method-name': 'list_accessible_devices',
11041
+ 'x-fern-sdk-return-value': 'devices',
11999
11042
  },
12000
11043
  },
12001
11044
  '/user_identities/list_acs_systems': {
@@ -12046,6 +11089,7 @@ export default {
12046
11089
  tags: ['/user_identities'],
12047
11090
  'x-fern-sdk-group-name': ['user_identities'],
12048
11091
  'x-fern-sdk-method-name': 'list_acs_systems',
11092
+ 'x-fern-sdk-return-value': 'acs_systems',
12049
11093
  },
12050
11094
  },
12051
11095
  '/user_identities/list_acs_users': {
@@ -12095,6 +11139,7 @@ export default {
12095
11139
  tags: ['/user_identities'],
12096
11140
  'x-fern-sdk-group-name': ['user_identities'],
12097
11141
  'x-fern-sdk-method-name': 'list_acs_users',
11142
+ 'x-fern-sdk-return-value': 'acs_users',
12098
11143
  },
12099
11144
  },
12100
11145
  '/user_identities/remove_acs_user': {
@@ -12635,6 +11680,7 @@ export default {
12635
11680
  tags: ['/workspaces'],
12636
11681
  'x-fern-sdk-group-name': ['workspaces'],
12637
11682
  'x-fern-sdk-method-name': 'create',
11683
+ 'x-fern-sdk-return-value': 'workspace',
12638
11684
  },
12639
11685
  },
12640
11686
  '/workspaces/get': {