@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.
@@ -184,6 +184,190 @@ export default {
184
184
  ],
185
185
  type: 'object',
186
186
  },
187
+ acs_credential: {
188
+ properties: {
189
+ access_method: {
190
+ enum: ['code', 'card', 'mobile_key'],
191
+ type: 'string',
192
+ },
193
+ acs_credential_id: { format: 'uuid', type: 'string' },
194
+ acs_credential_pool_id: { format: 'uuid', type: 'string' },
195
+ acs_system_id: { format: 'uuid', type: 'string' },
196
+ acs_user_id: { format: 'uuid', type: 'string' },
197
+ code: { nullable: true, type: 'string' },
198
+ created_at: { format: 'date-time', type: 'string' },
199
+ display_name: { minLength: 1, type: 'string' },
200
+ ends_at: { type: 'string' },
201
+ errors: {
202
+ items: {
203
+ properties: {
204
+ error_code: { type: 'string' },
205
+ message: { type: 'string' },
206
+ },
207
+ required: ['error_code', 'message'],
208
+ type: 'object',
209
+ },
210
+ type: 'array',
211
+ },
212
+ external_type: {
213
+ enum: [
214
+ 'pti_card',
215
+ 'brivo_credential',
216
+ 'hid_credential',
217
+ 'visionline_card',
218
+ ],
219
+ type: 'string',
220
+ },
221
+ external_type_display_name: { type: 'string' },
222
+ is_multi_phone_sync_credential: { type: 'boolean' },
223
+ parent_acs_credential_id: { format: 'uuid', type: 'string' },
224
+ starts_at: { type: 'string' },
225
+ visionline_metadata: {
226
+ properties: {
227
+ common_acs_entrance_ids: {
228
+ items: { format: 'uuid', type: 'string' },
229
+ type: 'array',
230
+ },
231
+ guest_acs_entrance_ids: {
232
+ items: { format: 'uuid', type: 'string' },
233
+ type: 'array',
234
+ },
235
+ joiner_acs_credential_ids: {
236
+ items: { format: 'uuid', type: 'string' },
237
+ type: 'array',
238
+ },
239
+ },
240
+ type: 'object',
241
+ },
242
+ warnings: {
243
+ items: {
244
+ properties: {
245
+ message: { type: 'string' },
246
+ warning_code: { type: 'string' },
247
+ },
248
+ required: ['warning_code', 'message'],
249
+ type: 'object',
250
+ },
251
+ type: 'array',
252
+ },
253
+ workspace_id: { format: 'uuid', type: 'string' },
254
+ },
255
+ required: [
256
+ 'acs_credential_id',
257
+ 'acs_system_id',
258
+ 'display_name',
259
+ 'access_method',
260
+ 'created_at',
261
+ 'workspace_id',
262
+ 'errors',
263
+ 'warnings',
264
+ ],
265
+ type: 'object',
266
+ },
267
+ acs_credential_pool: {
268
+ properties: {
269
+ acs_credential_pool_id: { format: 'uuid', type: 'string' },
270
+ acs_system_id: { format: 'uuid', type: 'string' },
271
+ created_at: { format: 'date-time', type: 'string' },
272
+ display_name: { minLength: 1, type: 'string' },
273
+ external_type: { enum: ['hid_part_number'], type: 'string' },
274
+ external_type_display_name: { type: 'string' },
275
+ workspace_id: { format: 'uuid', type: 'string' },
276
+ },
277
+ required: [
278
+ 'acs_credential_pool_id',
279
+ 'acs_system_id',
280
+ 'display_name',
281
+ 'external_type',
282
+ 'external_type_display_name',
283
+ 'created_at',
284
+ 'workspace_id',
285
+ ],
286
+ type: 'object',
287
+ },
288
+ acs_credential_provisioning_automation: {
289
+ properties: {
290
+ acs_credential_provisioning_automation_id: {
291
+ format: 'uuid',
292
+ type: 'string',
293
+ },
294
+ created_at: { format: 'date-time', type: 'string' },
295
+ credential_manager_acs_system_id: { format: 'uuid', type: 'string' },
296
+ user_identity_id: { format: 'uuid', type: 'string' },
297
+ workspace_id: { format: 'uuid', type: 'string' },
298
+ },
299
+ required: [
300
+ 'acs_credential_provisioning_automation_id',
301
+ 'credential_manager_acs_system_id',
302
+ 'user_identity_id',
303
+ 'created_at',
304
+ 'workspace_id',
305
+ ],
306
+ type: 'object',
307
+ },
308
+ acs_entrance: {
309
+ properties: {
310
+ acs_entrance_id: { format: 'uuid', type: 'string' },
311
+ acs_system_id: { format: 'uuid', type: 'string' },
312
+ created_at: { format: 'date-time', type: 'string' },
313
+ display_name: { type: 'string' },
314
+ latch_metadata: {
315
+ nullable: true,
316
+ properties: {
317
+ accessibility_type: { type: 'string' },
318
+ is_connected: { type: 'boolean' },
319
+ name: { type: 'string' },
320
+ type: { type: 'string' },
321
+ },
322
+ required: ['accessibility_type', 'name', 'type', 'is_connected'],
323
+ type: 'object',
324
+ },
325
+ visionline_metadata: {
326
+ nullable: true,
327
+ properties: {
328
+ door_category: {
329
+ enum: [
330
+ 'entrance',
331
+ 'guest',
332
+ 'elevator reader',
333
+ 'common',
334
+ 'common (PMS)',
335
+ ],
336
+ type: 'string',
337
+ },
338
+ door_name: { type: 'string' },
339
+ profiles: {
340
+ items: {
341
+ properties: {
342
+ visionline_door_profile_id: { type: 'string' },
343
+ visionline_door_profile_type: {
344
+ enum: ['BLE', 'commonDoor', 'touch'],
345
+ type: 'string',
346
+ },
347
+ },
348
+ required: [
349
+ 'visionline_door_profile_id',
350
+ 'visionline_door_profile_type',
351
+ ],
352
+ type: 'object',
353
+ },
354
+ type: 'array',
355
+ },
356
+ },
357
+ required: ['door_name', 'door_category'],
358
+ type: 'object',
359
+ },
360
+ },
361
+ required: [
362
+ 'acs_entrance_id',
363
+ 'display_name',
364
+ 'acs_system_id',
365
+ 'created_at',
366
+ 'latch_metadata',
367
+ 'visionline_metadata',
368
+ ],
369
+ type: 'object',
370
+ },
187
371
  acs_system: {
188
372
  properties: {
189
373
  acs_system_id: { format: 'uuid', type: 'string' },
@@ -420,9 +604,18 @@ export default {
420
604
  },
421
605
  connect_webview: {
422
606
  properties: {
423
- accepted_devices: { items: { type: 'string' }, type: 'array' },
607
+ accepted_devices: {
608
+ description:
609
+ '\n ---\n deprecated: Unused. Will be removed.\n ---\n ',
610
+ items: { type: 'string' },
611
+ type: 'array',
612
+ },
424
613
  accepted_providers: { items: { type: 'string' }, type: 'array' },
425
- any_device_allowed: { type: 'boolean' },
614
+ any_device_allowed: {
615
+ description:
616
+ '\n ---\n deprecated: Unused. Will be removed.\n ---\n ',
617
+ type: 'boolean',
618
+ },
426
619
  any_provider_allowed: { type: 'boolean' },
427
620
  authorized_at: {
428
621
  format: 'date-time',
@@ -473,8 +666,8 @@ export default {
473
666
  'device_selection_mode',
474
667
  'accepted_providers',
475
668
  'accepted_devices',
476
- 'any_provider_allowed',
477
669
  'any_device_allowed',
670
+ 'any_provider_allowed',
478
671
  'login_successful',
479
672
  'status',
480
673
  'custom_redirect_url',
@@ -1891,6 +2084,16 @@ export default {
1891
2084
  ],
1892
2085
  type: 'object',
1893
2086
  },
2087
+ network: {
2088
+ properties: {
2089
+ created_at: { format: 'date-time', type: 'string' },
2090
+ display_name: { type: 'string' },
2091
+ network_id: { format: 'uuid', type: 'string' },
2092
+ workspace_id: { format: 'uuid', type: 'string' },
2093
+ },
2094
+ required: ['network_id', 'workspace_id', 'display_name', 'created_at'],
2095
+ type: 'object',
2096
+ },
1894
2097
  noise_threshold: {
1895
2098
  properties: {
1896
2099
  device_id: { format: 'uuid', type: 'string' },
@@ -2391,6 +2594,29 @@ export default {
2391
2594
  ],
2392
2595
  type: 'object',
2393
2596
  },
2597
+ user_identity: {
2598
+ properties: {
2599
+ created_at: { format: 'date-time', type: 'string' },
2600
+ display_name: { minLength: 1, type: 'string' },
2601
+ email_address: { format: 'email', nullable: true, type: 'string' },
2602
+ full_name: { minLength: 1, nullable: true, type: 'string' },
2603
+ phone_number: { nullable: true, type: 'string' },
2604
+ user_identity_id: { format: 'uuid', type: 'string' },
2605
+ user_identity_key: { minLength: 1, nullable: true, type: 'string' },
2606
+ workspace_id: { format: 'uuid', type: 'string' },
2607
+ },
2608
+ required: [
2609
+ 'user_identity_id',
2610
+ 'user_identity_key',
2611
+ 'email_address',
2612
+ 'phone_number',
2613
+ 'display_name',
2614
+ 'full_name',
2615
+ 'created_at',
2616
+ 'workspace_id',
2617
+ ],
2618
+ type: 'object',
2619
+ },
2394
2620
  webhook: {
2395
2621
  properties: {
2396
2622
  event_types: { items: { type: 'string' }, type: 'array' },
@@ -3730,6 +3956,7 @@ export default {
3730
3956
  tags: ['/acs'],
3731
3957
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
3732
3958
  'x-fern-sdk-method-name': 'get',
3959
+ 'x-fern-sdk-return-value': 'acs_access_group',
3733
3960
  },
3734
3961
  },
3735
3962
  '/acs/access_groups/list': {
@@ -3779,6 +4006,7 @@ export default {
3779
4006
  tags: ['/acs'],
3780
4007
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
3781
4008
  'x-fern-sdk-method-name': 'list',
4009
+ 'x-fern-sdk-return-value': 'acs_access_groups',
3782
4010
  },
3783
4011
  },
3784
4012
  '/acs/access_groups/list_users': {
@@ -3829,6 +4057,7 @@ export default {
3829
4057
  tags: ['/acs'],
3830
4058
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
3831
4059
  'x-fern-sdk-method-name': 'list_users',
4060
+ 'x-fern-sdk-return-value': 'acs_users',
3832
4061
  },
3833
4062
  },
3834
4063
  '/acs/access_groups/remove_user': {
@@ -3899,31 +4128,7 @@ export default {
3899
4128
  properties: {
3900
4129
  acs_credential_pools: {
3901
4130
  items: {
3902
- properties: {
3903
- acs_credential_pool_id: {
3904
- format: 'uuid',
3905
- type: 'string',
3906
- },
3907
- acs_system_id: { format: 'uuid', type: 'string' },
3908
- created_at: { format: 'date-time', type: 'string' },
3909
- display_name: { minLength: 1, type: 'string' },
3910
- external_type: {
3911
- enum: ['hid_part_number'],
3912
- type: 'string',
3913
- },
3914
- external_type_display_name: { type: 'string' },
3915
- workspace_id: { format: 'uuid', type: 'string' },
3916
- },
3917
- required: [
3918
- 'acs_credential_pool_id',
3919
- 'acs_system_id',
3920
- 'display_name',
3921
- 'external_type',
3922
- 'external_type_display_name',
3923
- 'created_at',
3924
- 'workspace_id',
3925
- ],
3926
- type: 'object',
4131
+ $ref: '#/components/schemas/acs_credential_pool',
3927
4132
  },
3928
4133
  type: 'array',
3929
4134
  },
@@ -3948,6 +4153,7 @@ export default {
3948
4153
  tags: ['/acs'],
3949
4154
  'x-fern-sdk-group-name': ['acs', 'credential_pools'],
3950
4155
  'x-fern-sdk-method-name': 'list',
4156
+ 'x-fern-sdk-return-value': 'acs_credential_pools',
3951
4157
  },
3952
4158
  },
3953
4159
  '/acs/credential_provisioning_automations/launch': {
@@ -3986,27 +4192,7 @@ export default {
3986
4192
  schema: {
3987
4193
  properties: {
3988
4194
  acs_credential_provisioning_automation: {
3989
- properties: {
3990
- acs_credential_provisioning_automation_id: {
3991
- format: 'uuid',
3992
- type: 'string',
3993
- },
3994
- created_at: { format: 'date-time', type: 'string' },
3995
- credential_manager_acs_system_id: {
3996
- format: 'uuid',
3997
- type: 'string',
3998
- },
3999
- user_identity_id: { format: 'uuid', type: 'string' },
4000
- workspace_id: { format: 'uuid', type: 'string' },
4001
- },
4002
- required: [
4003
- 'acs_credential_provisioning_automation_id',
4004
- 'credential_manager_acs_system_id',
4005
- 'user_identity_id',
4006
- 'created_at',
4007
- 'workspace_id',
4008
- ],
4009
- type: 'object',
4195
+ $ref: '#/components/schemas/acs_credential_provisioning_automation',
4010
4196
  },
4011
4197
  ok: { type: 'boolean' },
4012
4198
  },
@@ -4029,6 +4215,7 @@ export default {
4029
4215
  tags: ['/acs'],
4030
4216
  'x-fern-sdk-group-name': ['acs', 'credential_provisioning_automations'],
4031
4217
  'x-fern-sdk-method-name': 'launch',
4218
+ 'x-fern-sdk-return-value': 'acs_credential_provisioning_automation',
4032
4219
  },
4033
4220
  },
4034
4221
  '/acs/credentials/assign': {
@@ -4055,90 +4242,7 @@ export default {
4055
4242
  schema: {
4056
4243
  properties: {
4057
4244
  acs_credential: {
4058
- properties: {
4059
- access_method: {
4060
- enum: ['code', 'card', 'mobile_key'],
4061
- type: 'string',
4062
- },
4063
- acs_credential_id: { format: 'uuid', type: 'string' },
4064
- acs_credential_pool_id: {
4065
- format: 'uuid',
4066
- type: 'string',
4067
- },
4068
- acs_system_id: { format: 'uuid', type: 'string' },
4069
- acs_user_id: { format: 'uuid', type: 'string' },
4070
- code: { nullable: true, type: 'string' },
4071
- created_at: { format: 'date-time', type: 'string' },
4072
- display_name: { minLength: 1, type: 'string' },
4073
- ends_at: { type: 'string' },
4074
- errors: {
4075
- items: {
4076
- properties: {
4077
- error_code: { type: 'string' },
4078
- message: { type: 'string' },
4079
- },
4080
- required: ['error_code', 'message'],
4081
- type: 'object',
4082
- },
4083
- type: 'array',
4084
- },
4085
- external_type: {
4086
- enum: [
4087
- 'pti_card',
4088
- 'brivo_credential',
4089
- 'hid_credential',
4090
- 'visionline_card',
4091
- ],
4092
- type: 'string',
4093
- },
4094
- external_type_display_name: { type: 'string' },
4095
- is_multi_phone_sync_credential: { type: 'boolean' },
4096
- parent_acs_credential_id: {
4097
- format: 'uuid',
4098
- type: 'string',
4099
- },
4100
- starts_at: { type: 'string' },
4101
- visionline_metadata: {
4102
- properties: {
4103
- common_acs_entrance_ids: {
4104
- items: { format: 'uuid', type: 'string' },
4105
- type: 'array',
4106
- },
4107
- guest_acs_entrance_ids: {
4108
- items: { format: 'uuid', type: 'string' },
4109
- type: 'array',
4110
- },
4111
- joiner_acs_credential_ids: {
4112
- items: { format: 'uuid', type: 'string' },
4113
- type: 'array',
4114
- },
4115
- },
4116
- type: 'object',
4117
- },
4118
- warnings: {
4119
- items: {
4120
- properties: {
4121
- message: { type: 'string' },
4122
- warning_code: { type: 'string' },
4123
- },
4124
- required: ['warning_code', 'message'],
4125
- type: 'object',
4126
- },
4127
- type: 'array',
4128
- },
4129
- workspace_id: { format: 'uuid', type: 'string' },
4130
- },
4131
- required: [
4132
- 'acs_credential_id',
4133
- 'acs_system_id',
4134
- 'display_name',
4135
- 'access_method',
4136
- 'created_at',
4137
- 'workspace_id',
4138
- 'errors',
4139
- 'warnings',
4140
- ],
4141
- type: 'object',
4245
+ $ref: '#/components/schemas/acs_credential',
4142
4246
  },
4143
4247
  ok: { type: 'boolean' },
4144
4248
  },
@@ -4184,90 +4288,7 @@ export default {
4184
4288
  schema: {
4185
4289
  properties: {
4186
4290
  acs_credential: {
4187
- properties: {
4188
- access_method: {
4189
- enum: ['code', 'card', 'mobile_key'],
4190
- type: 'string',
4191
- },
4192
- acs_credential_id: { format: 'uuid', type: 'string' },
4193
- acs_credential_pool_id: {
4194
- format: 'uuid',
4195
- type: 'string',
4196
- },
4197
- acs_system_id: { format: 'uuid', type: 'string' },
4198
- acs_user_id: { format: 'uuid', type: 'string' },
4199
- code: { nullable: true, type: 'string' },
4200
- created_at: { format: 'date-time', type: 'string' },
4201
- display_name: { minLength: 1, type: 'string' },
4202
- ends_at: { type: 'string' },
4203
- errors: {
4204
- items: {
4205
- properties: {
4206
- error_code: { type: 'string' },
4207
- message: { type: 'string' },
4208
- },
4209
- required: ['error_code', 'message'],
4210
- type: 'object',
4211
- },
4212
- type: 'array',
4213
- },
4214
- external_type: {
4215
- enum: [
4216
- 'pti_card',
4217
- 'brivo_credential',
4218
- 'hid_credential',
4219
- 'visionline_card',
4220
- ],
4221
- type: 'string',
4222
- },
4223
- external_type_display_name: { type: 'string' },
4224
- is_multi_phone_sync_credential: { type: 'boolean' },
4225
- parent_acs_credential_id: {
4226
- format: 'uuid',
4227
- type: 'string',
4228
- },
4229
- starts_at: { type: 'string' },
4230
- visionline_metadata: {
4231
- properties: {
4232
- common_acs_entrance_ids: {
4233
- items: { format: 'uuid', type: 'string' },
4234
- type: 'array',
4235
- },
4236
- guest_acs_entrance_ids: {
4237
- items: { format: 'uuid', type: 'string' },
4238
- type: 'array',
4239
- },
4240
- joiner_acs_credential_ids: {
4241
- items: { format: 'uuid', type: 'string' },
4242
- type: 'array',
4243
- },
4244
- },
4245
- type: 'object',
4246
- },
4247
- warnings: {
4248
- items: {
4249
- properties: {
4250
- message: { type: 'string' },
4251
- warning_code: { type: 'string' },
4252
- },
4253
- required: ['warning_code', 'message'],
4254
- type: 'object',
4255
- },
4256
- type: 'array',
4257
- },
4258
- workspace_id: { format: 'uuid', type: 'string' },
4259
- },
4260
- required: [
4261
- 'acs_credential_id',
4262
- 'acs_system_id',
4263
- 'display_name',
4264
- 'access_method',
4265
- 'created_at',
4266
- 'workspace_id',
4267
- 'errors',
4268
- 'warnings',
4269
- ],
4270
- type: 'object',
4291
+ $ref: '#/components/schemas/acs_credential',
4271
4292
  },
4272
4293
  ok: { type: 'boolean' },
4273
4294
  },
@@ -4353,90 +4374,7 @@ export default {
4353
4374
  schema: {
4354
4375
  properties: {
4355
4376
  acs_credential: {
4356
- properties: {
4357
- access_method: {
4358
- enum: ['code', 'card', 'mobile_key'],
4359
- type: 'string',
4360
- },
4361
- acs_credential_id: { format: 'uuid', type: 'string' },
4362
- acs_credential_pool_id: {
4363
- format: 'uuid',
4364
- type: 'string',
4365
- },
4366
- acs_system_id: { format: 'uuid', type: 'string' },
4367
- acs_user_id: { format: 'uuid', type: 'string' },
4368
- code: { nullable: true, type: 'string' },
4369
- created_at: { format: 'date-time', type: 'string' },
4370
- display_name: { minLength: 1, type: 'string' },
4371
- ends_at: { type: 'string' },
4372
- errors: {
4373
- items: {
4374
- properties: {
4375
- error_code: { type: 'string' },
4376
- message: { type: 'string' },
4377
- },
4378
- required: ['error_code', 'message'],
4379
- type: 'object',
4380
- },
4381
- type: 'array',
4382
- },
4383
- external_type: {
4384
- enum: [
4385
- 'pti_card',
4386
- 'brivo_credential',
4387
- 'hid_credential',
4388
- 'visionline_card',
4389
- ],
4390
- type: 'string',
4391
- },
4392
- external_type_display_name: { type: 'string' },
4393
- is_multi_phone_sync_credential: { type: 'boolean' },
4394
- parent_acs_credential_id: {
4395
- format: 'uuid',
4396
- type: 'string',
4397
- },
4398
- starts_at: { type: 'string' },
4399
- visionline_metadata: {
4400
- properties: {
4401
- common_acs_entrance_ids: {
4402
- items: { format: 'uuid', type: 'string' },
4403
- type: 'array',
4404
- },
4405
- guest_acs_entrance_ids: {
4406
- items: { format: 'uuid', type: 'string' },
4407
- type: 'array',
4408
- },
4409
- joiner_acs_credential_ids: {
4410
- items: { format: 'uuid', type: 'string' },
4411
- type: 'array',
4412
- },
4413
- },
4414
- type: 'object',
4415
- },
4416
- warnings: {
4417
- items: {
4418
- properties: {
4419
- message: { type: 'string' },
4420
- warning_code: { type: 'string' },
4421
- },
4422
- required: ['warning_code', 'message'],
4423
- type: 'object',
4424
- },
4425
- type: 'array',
4426
- },
4427
- workspace_id: { format: 'uuid', type: 'string' },
4428
- },
4429
- required: [
4430
- 'acs_credential_id',
4431
- 'acs_system_id',
4432
- 'display_name',
4433
- 'access_method',
4434
- 'created_at',
4435
- 'workspace_id',
4436
- 'errors',
4437
- 'warnings',
4438
- ],
4439
- type: 'object',
4377
+ $ref: '#/components/schemas/acs_credential',
4440
4378
  },
4441
4379
  ok: { type: 'boolean' },
4442
4380
  },
@@ -4459,6 +4397,7 @@ export default {
4459
4397
  tags: ['/acs'],
4460
4398
  'x-fern-sdk-group-name': ['acs', 'credentials'],
4461
4399
  'x-fern-sdk-method-name': 'create',
4400
+ 'x-fern-sdk-return-value': 'acs_credential',
4462
4401
  },
4463
4402
  },
4464
4403
  '/acs/credentials/delete': {
@@ -4527,90 +4466,7 @@ export default {
4527
4466
  schema: {
4528
4467
  properties: {
4529
4468
  acs_credential: {
4530
- properties: {
4531
- access_method: {
4532
- enum: ['code', 'card', 'mobile_key'],
4533
- type: 'string',
4534
- },
4535
- acs_credential_id: { format: 'uuid', type: 'string' },
4536
- acs_credential_pool_id: {
4537
- format: 'uuid',
4538
- type: 'string',
4539
- },
4540
- acs_system_id: { format: 'uuid', type: 'string' },
4541
- acs_user_id: { format: 'uuid', type: 'string' },
4542
- code: { nullable: true, type: 'string' },
4543
- created_at: { format: 'date-time', type: 'string' },
4544
- display_name: { minLength: 1, type: 'string' },
4545
- ends_at: { type: 'string' },
4546
- errors: {
4547
- items: {
4548
- properties: {
4549
- error_code: { type: 'string' },
4550
- message: { type: 'string' },
4551
- },
4552
- required: ['error_code', 'message'],
4553
- type: 'object',
4554
- },
4555
- type: 'array',
4556
- },
4557
- external_type: {
4558
- enum: [
4559
- 'pti_card',
4560
- 'brivo_credential',
4561
- 'hid_credential',
4562
- 'visionline_card',
4563
- ],
4564
- type: 'string',
4565
- },
4566
- external_type_display_name: { type: 'string' },
4567
- is_multi_phone_sync_credential: { type: 'boolean' },
4568
- parent_acs_credential_id: {
4569
- format: 'uuid',
4570
- type: 'string',
4571
- },
4572
- starts_at: { type: 'string' },
4573
- visionline_metadata: {
4574
- properties: {
4575
- common_acs_entrance_ids: {
4576
- items: { format: 'uuid', type: 'string' },
4577
- type: 'array',
4578
- },
4579
- guest_acs_entrance_ids: {
4580
- items: { format: 'uuid', type: 'string' },
4581
- type: 'array',
4582
- },
4583
- joiner_acs_credential_ids: {
4584
- items: { format: 'uuid', type: 'string' },
4585
- type: 'array',
4586
- },
4587
- },
4588
- type: 'object',
4589
- },
4590
- warnings: {
4591
- items: {
4592
- properties: {
4593
- message: { type: 'string' },
4594
- warning_code: { type: 'string' },
4595
- },
4596
- required: ['warning_code', 'message'],
4597
- type: 'object',
4598
- },
4599
- type: 'array',
4600
- },
4601
- workspace_id: { format: 'uuid', type: 'string' },
4602
- },
4603
- required: [
4604
- 'acs_credential_id',
4605
- 'acs_system_id',
4606
- 'display_name',
4607
- 'access_method',
4608
- 'created_at',
4609
- 'workspace_id',
4610
- 'errors',
4611
- 'warnings',
4612
- ],
4613
- type: 'object',
4469
+ $ref: '#/components/schemas/acs_credential',
4614
4470
  },
4615
4471
  ok: { type: 'boolean' },
4616
4472
  },
@@ -4633,6 +4489,7 @@ export default {
4633
4489
  tags: ['/acs'],
4634
4490
  'x-fern-sdk-group-name': ['acs', 'credentials'],
4635
4491
  'x-fern-sdk-method-name': 'get',
4492
+ 'x-fern-sdk-return-value': 'acs_credential',
4636
4493
  },
4637
4494
  },
4638
4495
  '/acs/credentials/list': {
@@ -4694,92 +4551,7 @@ export default {
4694
4551
  schema: {
4695
4552
  properties: {
4696
4553
  acs_credentials: {
4697
- items: {
4698
- properties: {
4699
- access_method: {
4700
- enum: ['code', 'card', 'mobile_key'],
4701
- type: 'string',
4702
- },
4703
- acs_credential_id: { format: 'uuid', type: 'string' },
4704
- acs_credential_pool_id: {
4705
- format: 'uuid',
4706
- type: 'string',
4707
- },
4708
- acs_system_id: { format: 'uuid', type: 'string' },
4709
- acs_user_id: { format: 'uuid', type: 'string' },
4710
- code: { nullable: true, type: 'string' },
4711
- created_at: { format: 'date-time', type: 'string' },
4712
- display_name: { minLength: 1, type: 'string' },
4713
- ends_at: { type: 'string' },
4714
- errors: {
4715
- items: {
4716
- properties: {
4717
- error_code: { type: 'string' },
4718
- message: { type: 'string' },
4719
- },
4720
- required: ['error_code', 'message'],
4721
- type: 'object',
4722
- },
4723
- type: 'array',
4724
- },
4725
- external_type: {
4726
- enum: [
4727
- 'pti_card',
4728
- 'brivo_credential',
4729
- 'hid_credential',
4730
- 'visionline_card',
4731
- ],
4732
- type: 'string',
4733
- },
4734
- external_type_display_name: { type: 'string' },
4735
- is_multi_phone_sync_credential: { type: 'boolean' },
4736
- parent_acs_credential_id: {
4737
- format: 'uuid',
4738
- type: 'string',
4739
- },
4740
- starts_at: { type: 'string' },
4741
- visionline_metadata: {
4742
- properties: {
4743
- common_acs_entrance_ids: {
4744
- items: { format: 'uuid', type: 'string' },
4745
- type: 'array',
4746
- },
4747
- guest_acs_entrance_ids: {
4748
- items: { format: 'uuid', type: 'string' },
4749
- type: 'array',
4750
- },
4751
- joiner_acs_credential_ids: {
4752
- items: { format: 'uuid', type: 'string' },
4753
- type: 'array',
4754
- },
4755
- },
4756
- type: 'object',
4757
- },
4758
- warnings: {
4759
- items: {
4760
- properties: {
4761
- message: { type: 'string' },
4762
- warning_code: { type: 'string' },
4763
- },
4764
- required: ['warning_code', 'message'],
4765
- type: 'object',
4766
- },
4767
- type: 'array',
4768
- },
4769
- workspace_id: { format: 'uuid', type: 'string' },
4770
- },
4771
- required: [
4772
- 'acs_credential_id',
4773
- 'acs_system_id',
4774
- 'display_name',
4775
- 'access_method',
4776
- 'created_at',
4777
- 'workspace_id',
4778
- 'errors',
4779
- 'warnings',
4780
- ],
4781
- type: 'object',
4782
- },
4554
+ items: { $ref: '#/components/schemas/acs_credential' },
4783
4555
  type: 'array',
4784
4556
  },
4785
4557
  ok: { type: 'boolean' },
@@ -4804,6 +4576,7 @@ export default {
4804
4576
  tags: ['/acs'],
4805
4577
  'x-fern-sdk-group-name': ['acs', 'credentials'],
4806
4578
  'x-fern-sdk-method-name': 'list',
4579
+ 'x-fern-sdk-return-value': 'acs_credentials',
4807
4580
  },
4808
4581
  },
4809
4582
  '/acs/credentials/unassign': {
@@ -4830,90 +4603,7 @@ export default {
4830
4603
  schema: {
4831
4604
  properties: {
4832
4605
  acs_credential: {
4833
- properties: {
4834
- access_method: {
4835
- enum: ['code', 'card', 'mobile_key'],
4836
- type: 'string',
4837
- },
4838
- acs_credential_id: { format: 'uuid', type: 'string' },
4839
- acs_credential_pool_id: {
4840
- format: 'uuid',
4841
- type: 'string',
4842
- },
4843
- acs_system_id: { format: 'uuid', type: 'string' },
4844
- acs_user_id: { format: 'uuid', type: 'string' },
4845
- code: { nullable: true, type: 'string' },
4846
- created_at: { format: 'date-time', type: 'string' },
4847
- display_name: { minLength: 1, type: 'string' },
4848
- ends_at: { type: 'string' },
4849
- errors: {
4850
- items: {
4851
- properties: {
4852
- error_code: { type: 'string' },
4853
- message: { type: 'string' },
4854
- },
4855
- required: ['error_code', 'message'],
4856
- type: 'object',
4857
- },
4858
- type: 'array',
4859
- },
4860
- external_type: {
4861
- enum: [
4862
- 'pti_card',
4863
- 'brivo_credential',
4864
- 'hid_credential',
4865
- 'visionline_card',
4866
- ],
4867
- type: 'string',
4868
- },
4869
- external_type_display_name: { type: 'string' },
4870
- is_multi_phone_sync_credential: { type: 'boolean' },
4871
- parent_acs_credential_id: {
4872
- format: 'uuid',
4873
- type: 'string',
4874
- },
4875
- starts_at: { type: 'string' },
4876
- visionline_metadata: {
4877
- properties: {
4878
- common_acs_entrance_ids: {
4879
- items: { format: 'uuid', type: 'string' },
4880
- type: 'array',
4881
- },
4882
- guest_acs_entrance_ids: {
4883
- items: { format: 'uuid', type: 'string' },
4884
- type: 'array',
4885
- },
4886
- joiner_acs_credential_ids: {
4887
- items: { format: 'uuid', type: 'string' },
4888
- type: 'array',
4889
- },
4890
- },
4891
- type: 'object',
4892
- },
4893
- warnings: {
4894
- items: {
4895
- properties: {
4896
- message: { type: 'string' },
4897
- warning_code: { type: 'string' },
4898
- },
4899
- required: ['warning_code', 'message'],
4900
- type: 'object',
4901
- },
4902
- type: 'array',
4903
- },
4904
- workspace_id: { format: 'uuid', type: 'string' },
4905
- },
4906
- required: [
4907
- 'acs_credential_id',
4908
- 'acs_system_id',
4909
- 'display_name',
4910
- 'access_method',
4911
- 'created_at',
4912
- 'workspace_id',
4913
- 'errors',
4914
- 'warnings',
4915
- ],
4916
- type: 'object',
4606
+ $ref: '#/components/schemas/acs_credential',
4917
4607
  },
4918
4608
  ok: { type: 'boolean' },
4919
4609
  },
@@ -4959,90 +4649,7 @@ export default {
4959
4649
  schema: {
4960
4650
  properties: {
4961
4651
  acs_credential: {
4962
- properties: {
4963
- access_method: {
4964
- enum: ['code', 'card', 'mobile_key'],
4965
- type: 'string',
4966
- },
4967
- acs_credential_id: { format: 'uuid', type: 'string' },
4968
- acs_credential_pool_id: {
4969
- format: 'uuid',
4970
- type: 'string',
4971
- },
4972
- acs_system_id: { format: 'uuid', type: 'string' },
4973
- acs_user_id: { format: 'uuid', type: 'string' },
4974
- code: { nullable: true, type: 'string' },
4975
- created_at: { format: 'date-time', type: 'string' },
4976
- display_name: { minLength: 1, type: 'string' },
4977
- ends_at: { type: 'string' },
4978
- errors: {
4979
- items: {
4980
- properties: {
4981
- error_code: { type: 'string' },
4982
- message: { type: 'string' },
4983
- },
4984
- required: ['error_code', 'message'],
4985
- type: 'object',
4986
- },
4987
- type: 'array',
4988
- },
4989
- external_type: {
4990
- enum: [
4991
- 'pti_card',
4992
- 'brivo_credential',
4993
- 'hid_credential',
4994
- 'visionline_card',
4995
- ],
4996
- type: 'string',
4997
- },
4998
- external_type_display_name: { type: 'string' },
4999
- is_multi_phone_sync_credential: { type: 'boolean' },
5000
- parent_acs_credential_id: {
5001
- format: 'uuid',
5002
- type: 'string',
5003
- },
5004
- starts_at: { type: 'string' },
5005
- visionline_metadata: {
5006
- properties: {
5007
- common_acs_entrance_ids: {
5008
- items: { format: 'uuid', type: 'string' },
5009
- type: 'array',
5010
- },
5011
- guest_acs_entrance_ids: {
5012
- items: { format: 'uuid', type: 'string' },
5013
- type: 'array',
5014
- },
5015
- joiner_acs_credential_ids: {
5016
- items: { format: 'uuid', type: 'string' },
5017
- type: 'array',
5018
- },
5019
- },
5020
- type: 'object',
5021
- },
5022
- warnings: {
5023
- items: {
5024
- properties: {
5025
- message: { type: 'string' },
5026
- warning_code: { type: 'string' },
5027
- },
5028
- required: ['warning_code', 'message'],
5029
- type: 'object',
5030
- },
5031
- type: 'array',
5032
- },
5033
- workspace_id: { format: 'uuid', type: 'string' },
5034
- },
5035
- required: [
5036
- 'acs_credential_id',
5037
- 'acs_system_id',
5038
- 'display_name',
5039
- 'access_method',
5040
- 'created_at',
5041
- 'workspace_id',
5042
- 'errors',
5043
- 'warnings',
5044
- ],
5045
- type: 'object',
4652
+ $ref: '#/components/schemas/acs_credential',
5046
4653
  },
5047
4654
  ok: { type: 'boolean' },
5048
4655
  },
@@ -5072,109 +4679,26 @@ export default {
5072
4679
  operationId: 'acsCredentialsUpdatePatch',
5073
4680
  requestBody: {
5074
4681
  content: {
5075
- 'application/json': {
5076
- schema: {
5077
- properties: {
5078
- acs_credential_id: { type: 'string' },
5079
- code: { pattern: '^\\d+$', type: 'string' },
5080
- },
5081
- required: ['acs_credential_id', 'code'],
5082
- type: 'object',
5083
- },
5084
- },
5085
- },
5086
- },
5087
- responses: {
5088
- 200: {
5089
- content: {
5090
- 'application/json': {
5091
- schema: {
5092
- properties: {
5093
- acs_credential: {
5094
- properties: {
5095
- access_method: {
5096
- enum: ['code', 'card', 'mobile_key'],
5097
- type: 'string',
5098
- },
5099
- acs_credential_id: { format: 'uuid', type: 'string' },
5100
- acs_credential_pool_id: {
5101
- format: 'uuid',
5102
- type: 'string',
5103
- },
5104
- acs_system_id: { format: 'uuid', type: 'string' },
5105
- acs_user_id: { format: 'uuid', type: 'string' },
5106
- code: { nullable: true, type: 'string' },
5107
- created_at: { format: 'date-time', type: 'string' },
5108
- display_name: { minLength: 1, type: 'string' },
5109
- ends_at: { type: 'string' },
5110
- errors: {
5111
- items: {
5112
- properties: {
5113
- error_code: { type: 'string' },
5114
- message: { type: 'string' },
5115
- },
5116
- required: ['error_code', 'message'],
5117
- type: 'object',
5118
- },
5119
- type: 'array',
5120
- },
5121
- external_type: {
5122
- enum: [
5123
- 'pti_card',
5124
- 'brivo_credential',
5125
- 'hid_credential',
5126
- 'visionline_card',
5127
- ],
5128
- type: 'string',
5129
- },
5130
- external_type_display_name: { type: 'string' },
5131
- is_multi_phone_sync_credential: { type: 'boolean' },
5132
- parent_acs_credential_id: {
5133
- format: 'uuid',
5134
- type: 'string',
5135
- },
5136
- starts_at: { type: 'string' },
5137
- visionline_metadata: {
5138
- properties: {
5139
- common_acs_entrance_ids: {
5140
- items: { format: 'uuid', type: 'string' },
5141
- type: 'array',
5142
- },
5143
- guest_acs_entrance_ids: {
5144
- items: { format: 'uuid', type: 'string' },
5145
- type: 'array',
5146
- },
5147
- joiner_acs_credential_ids: {
5148
- items: { format: 'uuid', type: 'string' },
5149
- type: 'array',
5150
- },
5151
- },
5152
- type: 'object',
5153
- },
5154
- warnings: {
5155
- items: {
5156
- properties: {
5157
- message: { type: 'string' },
5158
- warning_code: { type: 'string' },
5159
- },
5160
- required: ['warning_code', 'message'],
5161
- type: 'object',
5162
- },
5163
- type: 'array',
5164
- },
5165
- workspace_id: { format: 'uuid', type: 'string' },
5166
- },
5167
- required: [
5168
- 'acs_credential_id',
5169
- 'acs_system_id',
5170
- 'display_name',
5171
- 'access_method',
5172
- 'created_at',
5173
- 'workspace_id',
5174
- 'errors',
5175
- 'warnings',
5176
- ],
5177
- type: 'object',
4682
+ 'application/json': {
4683
+ schema: {
4684
+ properties: {
4685
+ acs_credential_id: { type: 'string' },
4686
+ code: { pattern: '^\\d+$', type: 'string' },
4687
+ },
4688
+ required: ['acs_credential_id', 'code'],
4689
+ type: 'object',
4690
+ },
4691
+ },
4692
+ },
4693
+ },
4694
+ responses: {
4695
+ 200: {
4696
+ content: {
4697
+ 'application/json': {
4698
+ schema: {
4699
+ properties: {
4700
+ acs_credential: {
4701
+ $ref: '#/components/schemas/acs_credential',
5178
4702
  },
5179
4703
  ok: { type: 'boolean' },
5180
4704
  },
@@ -5220,90 +4744,7 @@ export default {
5220
4744
  schema: {
5221
4745
  properties: {
5222
4746
  acs_credential: {
5223
- properties: {
5224
- access_method: {
5225
- enum: ['code', 'card', 'mobile_key'],
5226
- type: 'string',
5227
- },
5228
- acs_credential_id: { format: 'uuid', type: 'string' },
5229
- acs_credential_pool_id: {
5230
- format: 'uuid',
5231
- type: 'string',
5232
- },
5233
- acs_system_id: { format: 'uuid', type: 'string' },
5234
- acs_user_id: { format: 'uuid', type: 'string' },
5235
- code: { nullable: true, type: 'string' },
5236
- created_at: { format: 'date-time', type: 'string' },
5237
- display_name: { minLength: 1, type: 'string' },
5238
- ends_at: { type: 'string' },
5239
- errors: {
5240
- items: {
5241
- properties: {
5242
- error_code: { type: 'string' },
5243
- message: { type: 'string' },
5244
- },
5245
- required: ['error_code', 'message'],
5246
- type: 'object',
5247
- },
5248
- type: 'array',
5249
- },
5250
- external_type: {
5251
- enum: [
5252
- 'pti_card',
5253
- 'brivo_credential',
5254
- 'hid_credential',
5255
- 'visionline_card',
5256
- ],
5257
- type: 'string',
5258
- },
5259
- external_type_display_name: { type: 'string' },
5260
- is_multi_phone_sync_credential: { type: 'boolean' },
5261
- parent_acs_credential_id: {
5262
- format: 'uuid',
5263
- type: 'string',
5264
- },
5265
- starts_at: { type: 'string' },
5266
- visionline_metadata: {
5267
- properties: {
5268
- common_acs_entrance_ids: {
5269
- items: { format: 'uuid', type: 'string' },
5270
- type: 'array',
5271
- },
5272
- guest_acs_entrance_ids: {
5273
- items: { format: 'uuid', type: 'string' },
5274
- type: 'array',
5275
- },
5276
- joiner_acs_credential_ids: {
5277
- items: { format: 'uuid', type: 'string' },
5278
- type: 'array',
5279
- },
5280
- },
5281
- type: 'object',
5282
- },
5283
- warnings: {
5284
- items: {
5285
- properties: {
5286
- message: { type: 'string' },
5287
- warning_code: { type: 'string' },
5288
- },
5289
- required: ['warning_code', 'message'],
5290
- type: 'object',
5291
- },
5292
- type: 'array',
5293
- },
5294
- workspace_id: { format: 'uuid', type: 'string' },
5295
- },
5296
- required: [
5297
- 'acs_credential_id',
5298
- 'acs_system_id',
5299
- 'display_name',
5300
- 'access_method',
5301
- 'created_at',
5302
- 'workspace_id',
5303
- 'errors',
5304
- 'warnings',
5305
- ],
5306
- type: 'object',
4747
+ $ref: '#/components/schemas/acs_credential',
5307
4748
  },
5308
4749
  ok: { type: 'boolean' },
5309
4750
  },
@@ -5350,76 +4791,7 @@ export default {
5350
4791
  'application/json': {
5351
4792
  schema: {
5352
4793
  properties: {
5353
- acs_entrance: {
5354
- properties: {
5355
- acs_entrance_id: { format: 'uuid', type: 'string' },
5356
- acs_system_id: { format: 'uuid', type: 'string' },
5357
- created_at: { format: 'date-time', type: 'string' },
5358
- display_name: { type: 'string' },
5359
- latch_metadata: {
5360
- nullable: true,
5361
- properties: {
5362
- accessibility_type: { type: 'string' },
5363
- is_connected: { type: 'boolean' },
5364
- name: { type: 'string' },
5365
- type: { type: 'string' },
5366
- },
5367
- required: [
5368
- 'accessibility_type',
5369
- 'name',
5370
- 'type',
5371
- 'is_connected',
5372
- ],
5373
- type: 'object',
5374
- },
5375
- visionline_metadata: {
5376
- nullable: true,
5377
- properties: {
5378
- door_category: {
5379
- enum: [
5380
- 'entrance',
5381
- 'guest',
5382
- 'elevator reader',
5383
- 'common',
5384
- 'common (PMS)',
5385
- ],
5386
- type: 'string',
5387
- },
5388
- door_name: { type: 'string' },
5389
- profiles: {
5390
- items: {
5391
- properties: {
5392
- visionline_door_profile_id: {
5393
- type: 'string',
5394
- },
5395
- visionline_door_profile_type: {
5396
- enum: ['BLE', 'commonDoor', 'touch'],
5397
- type: 'string',
5398
- },
5399
- },
5400
- required: [
5401
- 'visionline_door_profile_id',
5402
- 'visionline_door_profile_type',
5403
- ],
5404
- type: 'object',
5405
- },
5406
- type: 'array',
5407
- },
5408
- },
5409
- required: ['door_name', 'door_category'],
5410
- type: 'object',
5411
- },
5412
- },
5413
- required: [
5414
- 'acs_entrance_id',
5415
- 'display_name',
5416
- 'acs_system_id',
5417
- 'created_at',
5418
- 'latch_metadata',
5419
- 'visionline_metadata',
5420
- ],
5421
- type: 'object',
5422
- },
4794
+ acs_entrance: { $ref: '#/components/schemas/acs_entrance' },
5423
4795
  ok: { type: 'boolean' },
5424
4796
  },
5425
4797
  required: ['acs_entrance', 'ok'],
@@ -5442,6 +4814,7 @@ export default {
5442
4814
  tags: ['/acs'],
5443
4815
  'x-fern-sdk-group-name': ['acs', 'entrances'],
5444
4816
  'x-fern-sdk-method-name': 'get',
4817
+ 'x-fern-sdk-return-value': 'acs_entrance',
5445
4818
  },
5446
4819
  },
5447
4820
  '/acs/entrances/grant_access': {
@@ -5512,76 +4885,7 @@ export default {
5512
4885
  schema: {
5513
4886
  properties: {
5514
4887
  acs_entrances: {
5515
- items: {
5516
- properties: {
5517
- acs_entrance_id: { format: 'uuid', type: 'string' },
5518
- acs_system_id: { format: 'uuid', type: 'string' },
5519
- created_at: { format: 'date-time', type: 'string' },
5520
- display_name: { type: 'string' },
5521
- latch_metadata: {
5522
- nullable: true,
5523
- properties: {
5524
- accessibility_type: { type: 'string' },
5525
- is_connected: { type: 'boolean' },
5526
- name: { type: 'string' },
5527
- type: { type: 'string' },
5528
- },
5529
- required: [
5530
- 'accessibility_type',
5531
- 'name',
5532
- 'type',
5533
- 'is_connected',
5534
- ],
5535
- type: 'object',
5536
- },
5537
- visionline_metadata: {
5538
- nullable: true,
5539
- properties: {
5540
- door_category: {
5541
- enum: [
5542
- 'entrance',
5543
- 'guest',
5544
- 'elevator reader',
5545
- 'common',
5546
- 'common (PMS)',
5547
- ],
5548
- type: 'string',
5549
- },
5550
- door_name: { type: 'string' },
5551
- profiles: {
5552
- items: {
5553
- properties: {
5554
- visionline_door_profile_id: {
5555
- type: 'string',
5556
- },
5557
- visionline_door_profile_type: {
5558
- enum: ['BLE', 'commonDoor', 'touch'],
5559
- type: 'string',
5560
- },
5561
- },
5562
- required: [
5563
- 'visionline_door_profile_id',
5564
- 'visionline_door_profile_type',
5565
- ],
5566
- type: 'object',
5567
- },
5568
- type: 'array',
5569
- },
5570
- },
5571
- required: ['door_name', 'door_category'],
5572
- type: 'object',
5573
- },
5574
- },
5575
- required: [
5576
- 'acs_entrance_id',
5577
- 'display_name',
5578
- 'acs_system_id',
5579
- 'created_at',
5580
- 'latch_metadata',
5581
- 'visionline_metadata',
5582
- ],
5583
- type: 'object',
5584
- },
4888
+ items: { $ref: '#/components/schemas/acs_entrance' },
5585
4889
  type: 'array',
5586
4890
  },
5587
4891
  ok: { type: 'boolean' },
@@ -5606,6 +4910,7 @@ export default {
5606
4910
  tags: ['/acs'],
5607
4911
  'x-fern-sdk-group-name': ['acs', 'entrances'],
5608
4912
  'x-fern-sdk-method-name': 'list',
4913
+ 'x-fern-sdk-return-value': 'acs_entrances',
5609
4914
  },
5610
4915
  },
5611
4916
  '/acs/entrances/list_credentials_with_access': {
@@ -5638,92 +4943,7 @@ export default {
5638
4943
  schema: {
5639
4944
  properties: {
5640
4945
  acs_credentials: {
5641
- items: {
5642
- properties: {
5643
- access_method: {
5644
- enum: ['code', 'card', 'mobile_key'],
5645
- type: 'string',
5646
- },
5647
- acs_credential_id: { format: 'uuid', type: 'string' },
5648
- acs_credential_pool_id: {
5649
- format: 'uuid',
5650
- type: 'string',
5651
- },
5652
- acs_system_id: { format: 'uuid', type: 'string' },
5653
- acs_user_id: { format: 'uuid', type: 'string' },
5654
- code: { nullable: true, type: 'string' },
5655
- created_at: { format: 'date-time', type: 'string' },
5656
- display_name: { minLength: 1, type: 'string' },
5657
- ends_at: { type: 'string' },
5658
- errors: {
5659
- items: {
5660
- properties: {
5661
- error_code: { type: 'string' },
5662
- message: { type: 'string' },
5663
- },
5664
- required: ['error_code', 'message'],
5665
- type: 'object',
5666
- },
5667
- type: 'array',
5668
- },
5669
- external_type: {
5670
- enum: [
5671
- 'pti_card',
5672
- 'brivo_credential',
5673
- 'hid_credential',
5674
- 'visionline_card',
5675
- ],
5676
- type: 'string',
5677
- },
5678
- external_type_display_name: { type: 'string' },
5679
- is_multi_phone_sync_credential: { type: 'boolean' },
5680
- parent_acs_credential_id: {
5681
- format: 'uuid',
5682
- type: 'string',
5683
- },
5684
- starts_at: { type: 'string' },
5685
- visionline_metadata: {
5686
- properties: {
5687
- common_acs_entrance_ids: {
5688
- items: { format: 'uuid', type: 'string' },
5689
- type: 'array',
5690
- },
5691
- guest_acs_entrance_ids: {
5692
- items: { format: 'uuid', type: 'string' },
5693
- type: 'array',
5694
- },
5695
- joiner_acs_credential_ids: {
5696
- items: { format: 'uuid', type: 'string' },
5697
- type: 'array',
5698
- },
5699
- },
5700
- type: 'object',
5701
- },
5702
- warnings: {
5703
- items: {
5704
- properties: {
5705
- message: { type: 'string' },
5706
- warning_code: { type: 'string' },
5707
- },
5708
- required: ['warning_code', 'message'],
5709
- type: 'object',
5710
- },
5711
- type: 'array',
5712
- },
5713
- workspace_id: { format: 'uuid', type: 'string' },
5714
- },
5715
- required: [
5716
- 'acs_credential_id',
5717
- 'acs_system_id',
5718
- 'display_name',
5719
- 'access_method',
5720
- 'created_at',
5721
- 'workspace_id',
5722
- 'errors',
5723
- 'warnings',
5724
- ],
5725
- type: 'object',
5726
- },
4946
+ items: { $ref: '#/components/schemas/acs_credential' },
5727
4947
  type: 'array',
5728
4948
  },
5729
4949
  ok: { type: 'boolean' },
@@ -5748,6 +4968,7 @@ export default {
5748
4968
  tags: ['/acs'],
5749
4969
  'x-fern-sdk-group-name': ['acs', 'entrances'],
5750
4970
  'x-fern-sdk-method-name': 'list_credentials_with_access',
4971
+ 'x-fern-sdk-return-value': 'acs_credentials',
5751
4972
  },
5752
4973
  },
5753
4974
  '/acs/systems/get': {
@@ -5794,6 +5015,7 @@ export default {
5794
5015
  tags: ['/acs'],
5795
5016
  'x-fern-sdk-group-name': ['acs', 'systems'],
5796
5017
  'x-fern-sdk-method-name': 'get',
5018
+ 'x-fern-sdk-return-value': 'acs_system',
5797
5019
  },
5798
5020
  },
5799
5021
  '/acs/systems/list': {
@@ -5843,6 +5065,7 @@ export default {
5843
5065
  tags: ['/acs'],
5844
5066
  'x-fern-sdk-group-name': ['acs', 'systems'],
5845
5067
  'x-fern-sdk-method-name': 'list',
5068
+ 'x-fern-sdk-return-value': 'acs_systems',
5846
5069
  },
5847
5070
  },
5848
5071
  '/acs/users/add_to_access_group': {
@@ -5997,6 +5220,7 @@ export default {
5997
5220
  tags: ['/acs'],
5998
5221
  'x-fern-sdk-group-name': ['acs', 'users'],
5999
5222
  'x-fern-sdk-method-name': 'create',
5223
+ 'x-fern-sdk-return-value': 'acs_user',
6000
5224
  },
6001
5225
  },
6002
5226
  '/acs/users/delete': {
@@ -6082,6 +5306,7 @@ export default {
6082
5306
  tags: ['/acs'],
6083
5307
  'x-fern-sdk-group-name': ['acs', 'users'],
6084
5308
  'x-fern-sdk-method-name': 'get',
5309
+ 'x-fern-sdk-return-value': 'acs_user',
6085
5310
  },
6086
5311
  },
6087
5312
  '/acs/users/list': {
@@ -6137,6 +5362,7 @@ export default {
6137
5362
  tags: ['/acs'],
6138
5363
  'x-fern-sdk-group-name': ['acs', 'users'],
6139
5364
  'x-fern-sdk-method-name': 'list',
5365
+ 'x-fern-sdk-return-value': 'acs_users',
6140
5366
  },
6141
5367
  },
6142
5368
  '/acs/users/list_accessible_entrances': {
@@ -6160,76 +5386,7 @@ export default {
6160
5386
  schema: {
6161
5387
  properties: {
6162
5388
  acs_entrances: {
6163
- items: {
6164
- properties: {
6165
- acs_entrance_id: { format: 'uuid', type: 'string' },
6166
- acs_system_id: { format: 'uuid', type: 'string' },
6167
- created_at: { format: 'date-time', type: 'string' },
6168
- display_name: { type: 'string' },
6169
- latch_metadata: {
6170
- nullable: true,
6171
- properties: {
6172
- accessibility_type: { type: 'string' },
6173
- is_connected: { type: 'boolean' },
6174
- name: { type: 'string' },
6175
- type: { type: 'string' },
6176
- },
6177
- required: [
6178
- 'accessibility_type',
6179
- 'name',
6180
- 'type',
6181
- 'is_connected',
6182
- ],
6183
- type: 'object',
6184
- },
6185
- visionline_metadata: {
6186
- nullable: true,
6187
- properties: {
6188
- door_category: {
6189
- enum: [
6190
- 'entrance',
6191
- 'guest',
6192
- 'elevator reader',
6193
- 'common',
6194
- 'common (PMS)',
6195
- ],
6196
- type: 'string',
6197
- },
6198
- door_name: { type: 'string' },
6199
- profiles: {
6200
- items: {
6201
- properties: {
6202
- visionline_door_profile_id: {
6203
- type: 'string',
6204
- },
6205
- visionline_door_profile_type: {
6206
- enum: ['BLE', 'commonDoor', 'touch'],
6207
- type: 'string',
6208
- },
6209
- },
6210
- required: [
6211
- 'visionline_door_profile_id',
6212
- 'visionline_door_profile_type',
6213
- ],
6214
- type: 'object',
6215
- },
6216
- type: 'array',
6217
- },
6218
- },
6219
- required: ['door_name', 'door_category'],
6220
- type: 'object',
6221
- },
6222
- },
6223
- required: [
6224
- 'acs_entrance_id',
6225
- 'display_name',
6226
- 'acs_system_id',
6227
- 'created_at',
6228
- 'latch_metadata',
6229
- 'visionline_metadata',
6230
- ],
6231
- type: 'object',
6232
- },
5389
+ items: { $ref: '#/components/schemas/acs_entrance' },
6233
5390
  type: 'array',
6234
5391
  },
6235
5392
  ok: { type: 'boolean' },
@@ -6254,6 +5411,7 @@ export default {
6254
5411
  tags: ['/acs'],
6255
5412
  'x-fern-sdk-group-name': ['acs', 'users'],
6256
5413
  'x-fern-sdk-method-name': 'list_accessible_entrances',
5414
+ 'x-fern-sdk-return-value': 'acs_entrances',
6257
5415
  },
6258
5416
  },
6259
5417
  '/acs/users/remove_from_access_group': {
@@ -9511,21 +8669,7 @@ export default {
9511
8669
  'application/json': {
9512
8670
  schema: {
9513
8671
  properties: {
9514
- network: {
9515
- properties: {
9516
- created_at: { format: 'date-time', type: 'string' },
9517
- display_name: { type: 'string' },
9518
- network_id: { format: 'uuid', type: 'string' },
9519
- workspace_id: { format: 'uuid', type: 'string' },
9520
- },
9521
- required: [
9522
- 'network_id',
9523
- 'workspace_id',
9524
- 'display_name',
9525
- 'created_at',
9526
- ],
9527
- type: 'object',
9528
- },
8672
+ network: { $ref: '#/components/schemas/network' },
9529
8673
  ok: { type: 'boolean' },
9530
8674
  },
9531
8675
  required: ['network', 'ok'],
@@ -9547,6 +8691,7 @@ export default {
9547
8691
  tags: ['/networks'],
9548
8692
  'x-fern-sdk-group-name': ['networks'],
9549
8693
  'x-fern-sdk-method-name': 'get',
8694
+ 'x-fern-sdk-return-value': 'network',
9550
8695
  },
9551
8696
  },
9552
8697
  '/networks/list': {
@@ -9564,21 +8709,7 @@ export default {
9564
8709
  schema: {
9565
8710
  properties: {
9566
8711
  networks: {
9567
- items: {
9568
- properties: {
9569
- created_at: { format: 'date-time', type: 'string' },
9570
- display_name: { type: 'string' },
9571
- network_id: { format: 'uuid', type: 'string' },
9572
- workspace_id: { format: 'uuid', type: 'string' },
9573
- },
9574
- required: [
9575
- 'network_id',
9576
- 'workspace_id',
9577
- 'display_name',
9578
- 'created_at',
9579
- ],
9580
- type: 'object',
9581
- },
8712
+ items: { $ref: '#/components/schemas/network' },
9582
8713
  type: 'array',
9583
8714
  },
9584
8715
  ok: { type: 'boolean' },
@@ -9602,6 +8733,7 @@ export default {
9602
8733
  tags: ['/networks'],
9603
8734
  'x-fern-sdk-group-name': ['networks'],
9604
8735
  'x-fern-sdk-method-name': 'list',
8736
+ 'x-fern-sdk-return-value': 'networks',
9605
8737
  },
9606
8738
  },
9607
8739
  '/noise_sensors/noise_thresholds/create': {
@@ -11455,39 +10587,7 @@ export default {
11455
10587
  properties: {
11456
10588
  ok: { type: 'boolean' },
11457
10589
  user_identity: {
11458
- properties: {
11459
- created_at: { format: 'date-time', type: 'string' },
11460
- display_name: { minLength: 1, type: 'string' },
11461
- email_address: {
11462
- format: 'email',
11463
- nullable: true,
11464
- type: 'string',
11465
- },
11466
- full_name: {
11467
- minLength: 1,
11468
- nullable: true,
11469
- type: 'string',
11470
- },
11471
- phone_number: { nullable: true, type: 'string' },
11472
- user_identity_id: { format: 'uuid', type: 'string' },
11473
- user_identity_key: {
11474
- minLength: 1,
11475
- nullable: true,
11476
- type: 'string',
11477
- },
11478
- workspace_id: { format: 'uuid', type: 'string' },
11479
- },
11480
- required: [
11481
- 'user_identity_id',
11482
- 'user_identity_key',
11483
- 'email_address',
11484
- 'phone_number',
11485
- 'display_name',
11486
- 'full_name',
11487
- 'created_at',
11488
- 'workspace_id',
11489
- ],
11490
- type: 'object',
10590
+ $ref: '#/components/schemas/user_identity',
11491
10591
  },
11492
10592
  },
11493
10593
  required: ['user_identity', 'ok'],
@@ -11509,6 +10609,7 @@ export default {
11509
10609
  tags: ['/user_identities'],
11510
10610
  'x-fern-sdk-group-name': ['user_identities'],
11511
10611
  'x-fern-sdk-method-name': 'create',
10612
+ 'x-fern-sdk-return-value': 'user_identity',
11512
10613
  },
11513
10614
  },
11514
10615
  '/user_identities/delete': {
@@ -11644,6 +10745,7 @@ export default {
11644
10745
  tags: ['/user_identities'],
11645
10746
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
11646
10747
  'x-fern-sdk-method-name': 'get',
10748
+ 'x-fern-sdk-return-value': 'enrollment_automation',
11647
10749
  },
11648
10750
  },
11649
10751
  '/user_identities/enrollment_automations/launch': {
@@ -11730,6 +10832,7 @@ export default {
11730
10832
  tags: ['/user_identities'],
11731
10833
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
11732
10834
  'x-fern-sdk-method-name': 'launch',
10835
+ 'x-fern-sdk-return-value': 'enrollment_automation',
11733
10836
  },
11734
10837
  },
11735
10838
  '/user_identities/enrollment_automations/list': {
@@ -11782,6 +10885,7 @@ export default {
11782
10885
  tags: ['/user_identities'],
11783
10886
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
11784
10887
  'x-fern-sdk-method-name': 'list',
10888
+ 'x-fern-sdk-return-value': 'enrollment_automations',
11785
10889
  },
11786
10890
  },
11787
10891
  '/user_identities/get': {
@@ -11817,39 +10921,7 @@ export default {
11817
10921
  properties: {
11818
10922
  ok: { type: 'boolean' },
11819
10923
  user_identity: {
11820
- properties: {
11821
- created_at: { format: 'date-time', type: 'string' },
11822
- display_name: { minLength: 1, type: 'string' },
11823
- email_address: {
11824
- format: 'email',
11825
- nullable: true,
11826
- type: 'string',
11827
- },
11828
- full_name: {
11829
- minLength: 1,
11830
- nullable: true,
11831
- type: 'string',
11832
- },
11833
- phone_number: { nullable: true, type: 'string' },
11834
- user_identity_id: { format: 'uuid', type: 'string' },
11835
- user_identity_key: {
11836
- minLength: 1,
11837
- nullable: true,
11838
- type: 'string',
11839
- },
11840
- workspace_id: { format: 'uuid', type: 'string' },
11841
- },
11842
- required: [
11843
- 'user_identity_id',
11844
- 'user_identity_key',
11845
- 'email_address',
11846
- 'phone_number',
11847
- 'display_name',
11848
- 'full_name',
11849
- 'created_at',
11850
- 'workspace_id',
11851
- ],
11852
- type: 'object',
10924
+ $ref: '#/components/schemas/user_identity',
11853
10925
  },
11854
10926
  },
11855
10927
  required: ['user_identity', 'ok'],
@@ -11871,6 +10943,7 @@ export default {
11871
10943
  tags: ['/user_identities'],
11872
10944
  'x-fern-sdk-group-name': ['user_identities'],
11873
10945
  'x-fern-sdk-method-name': 'get',
10946
+ 'x-fern-sdk-return-value': 'user_identity',
11874
10947
  },
11875
10948
  },
11876
10949
  '/user_identities/grant_access_to_device': {
@@ -11984,41 +11057,7 @@ export default {
11984
11057
  properties: {
11985
11058
  ok: { type: 'boolean' },
11986
11059
  user_identities: {
11987
- items: {
11988
- properties: {
11989
- created_at: { format: 'date-time', type: 'string' },
11990
- display_name: { minLength: 1, type: 'string' },
11991
- email_address: {
11992
- format: 'email',
11993
- nullable: true,
11994
- type: 'string',
11995
- },
11996
- full_name: {
11997
- minLength: 1,
11998
- nullable: true,
11999
- type: 'string',
12000
- },
12001
- phone_number: { nullable: true, type: 'string' },
12002
- user_identity_id: { format: 'uuid', type: 'string' },
12003
- user_identity_key: {
12004
- minLength: 1,
12005
- nullable: true,
12006
- type: 'string',
12007
- },
12008
- workspace_id: { format: 'uuid', type: 'string' },
12009
- },
12010
- required: [
12011
- 'user_identity_id',
12012
- 'user_identity_key',
12013
- 'email_address',
12014
- 'phone_number',
12015
- 'display_name',
12016
- 'full_name',
12017
- 'created_at',
12018
- 'workspace_id',
12019
- ],
12020
- type: 'object',
12021
- },
11060
+ items: { $ref: '#/components/schemas/user_identity' },
12022
11061
  type: 'array',
12023
11062
  },
12024
11063
  },
@@ -12068,12 +11107,18 @@ export default {
12068
11107
  schema: {
12069
11108
  properties: {
12070
11109
  accessible_devices: {
11110
+ description:
11111
+ '\n ---\n deprecated: use devices.\n ---\n ',
11112
+ items: { $ref: '#/components/schemas/device' },
11113
+ type: 'array',
11114
+ },
11115
+ devices: {
12071
11116
  items: { $ref: '#/components/schemas/device' },
12072
11117
  type: 'array',
12073
11118
  },
12074
11119
  ok: { type: 'boolean' },
12075
11120
  },
12076
- required: ['accessible_devices', 'ok'],
11121
+ required: ['devices', 'accessible_devices', 'ok'],
12077
11122
  type: 'object',
12078
11123
  },
12079
11124
  },
@@ -12092,6 +11137,7 @@ export default {
12092
11137
  tags: ['/user_identities'],
12093
11138
  'x-fern-sdk-group-name': ['user_identities'],
12094
11139
  'x-fern-sdk-method-name': 'list_accessible_devices',
11140
+ 'x-fern-sdk-return-value': 'devices',
12095
11141
  },
12096
11142
  },
12097
11143
  '/user_identities/list_acs_systems': {
@@ -12142,6 +11188,7 @@ export default {
12142
11188
  tags: ['/user_identities'],
12143
11189
  'x-fern-sdk-group-name': ['user_identities'],
12144
11190
  'x-fern-sdk-method-name': 'list_acs_systems',
11191
+ 'x-fern-sdk-return-value': 'acs_systems',
12145
11192
  },
12146
11193
  },
12147
11194
  '/user_identities/list_acs_users': {
@@ -12191,6 +11238,7 @@ export default {
12191
11238
  tags: ['/user_identities'],
12192
11239
  'x-fern-sdk-group-name': ['user_identities'],
12193
11240
  'x-fern-sdk-method-name': 'list_acs_users',
11241
+ 'x-fern-sdk-return-value': 'acs_users',
12194
11242
  },
12195
11243
  },
12196
11244
  '/user_identities/remove_acs_user': {
@@ -12731,6 +11779,7 @@ export default {
12731
11779
  tags: ['/workspaces'],
12732
11780
  'x-fern-sdk-group-name': ['workspaces'],
12733
11781
  'x-fern-sdk-method-name': 'create',
11782
+ 'x-fern-sdk-return-value': 'workspace',
12734
11783
  },
12735
11784
  },
12736
11785
  '/workspaces/get': {