@seamapi/types 1.153.0 → 1.153.2

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' },
@@ -276,9 +460,9 @@ export default {
276
460
  hid_acs_system_id: { format: 'uuid', type: 'string' },
277
461
  is_suspended: { type: 'boolean' },
278
462
  phone_number: { nullable: true, type: 'string' },
279
- user_identity_email_address: { type: 'string' },
463
+ user_identity_email_address: { nullable: true, type: 'string' },
280
464
  user_identity_id: { type: 'string' },
281
- user_identity_phone_number: { type: 'string' },
465
+ user_identity_phone_number: { nullable: true, type: 'string' },
282
466
  workspace_id: { format: 'uuid', type: 'string' },
283
467
  },
284
468
  required: [
@@ -1900,6 +2084,16 @@ export default {
1900
2084
  ],
1901
2085
  type: 'object',
1902
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
+ },
1903
2097
  noise_threshold: {
1904
2098
  properties: {
1905
2099
  device_id: { format: 'uuid', type: 'string' },
@@ -2400,6 +2594,29 @@ export default {
2400
2594
  ],
2401
2595
  type: 'object',
2402
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
+ },
2403
2620
  webhook: {
2404
2621
  properties: {
2405
2622
  event_types: { items: { type: 'string' }, type: 'array' },
@@ -3739,6 +3956,7 @@ export default {
3739
3956
  tags: ['/acs'],
3740
3957
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
3741
3958
  'x-fern-sdk-method-name': 'get',
3959
+ 'x-fern-sdk-return-value': 'acs_access_group',
3742
3960
  },
3743
3961
  },
3744
3962
  '/acs/access_groups/list': {
@@ -3788,6 +4006,7 @@ export default {
3788
4006
  tags: ['/acs'],
3789
4007
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
3790
4008
  'x-fern-sdk-method-name': 'list',
4009
+ 'x-fern-sdk-return-value': 'acs_access_groups',
3791
4010
  },
3792
4011
  },
3793
4012
  '/acs/access_groups/list_users': {
@@ -3838,6 +4057,7 @@ export default {
3838
4057
  tags: ['/acs'],
3839
4058
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
3840
4059
  'x-fern-sdk-method-name': 'list_users',
4060
+ 'x-fern-sdk-return-value': 'acs_users',
3841
4061
  },
3842
4062
  },
3843
4063
  '/acs/access_groups/remove_user': {
@@ -3908,31 +4128,7 @@ export default {
3908
4128
  properties: {
3909
4129
  acs_credential_pools: {
3910
4130
  items: {
3911
- properties: {
3912
- acs_credential_pool_id: {
3913
- format: 'uuid',
3914
- type: 'string',
3915
- },
3916
- acs_system_id: { format: 'uuid', type: 'string' },
3917
- created_at: { format: 'date-time', type: 'string' },
3918
- display_name: { minLength: 1, type: 'string' },
3919
- external_type: {
3920
- enum: ['hid_part_number'],
3921
- type: 'string',
3922
- },
3923
- external_type_display_name: { type: 'string' },
3924
- workspace_id: { format: 'uuid', type: 'string' },
3925
- },
3926
- required: [
3927
- 'acs_credential_pool_id',
3928
- 'acs_system_id',
3929
- 'display_name',
3930
- 'external_type',
3931
- 'external_type_display_name',
3932
- 'created_at',
3933
- 'workspace_id',
3934
- ],
3935
- type: 'object',
4131
+ $ref: '#/components/schemas/acs_credential_pool',
3936
4132
  },
3937
4133
  type: 'array',
3938
4134
  },
@@ -3957,6 +4153,7 @@ export default {
3957
4153
  tags: ['/acs'],
3958
4154
  'x-fern-sdk-group-name': ['acs', 'credential_pools'],
3959
4155
  'x-fern-sdk-method-name': 'list',
4156
+ 'x-fern-sdk-return-value': 'acs_credential_pools',
3960
4157
  },
3961
4158
  },
3962
4159
  '/acs/credential_provisioning_automations/launch': {
@@ -3995,27 +4192,7 @@ export default {
3995
4192
  schema: {
3996
4193
  properties: {
3997
4194
  acs_credential_provisioning_automation: {
3998
- properties: {
3999
- acs_credential_provisioning_automation_id: {
4000
- format: 'uuid',
4001
- type: 'string',
4002
- },
4003
- created_at: { format: 'date-time', type: 'string' },
4004
- credential_manager_acs_system_id: {
4005
- format: 'uuid',
4006
- type: 'string',
4007
- },
4008
- user_identity_id: { format: 'uuid', type: 'string' },
4009
- workspace_id: { format: 'uuid', type: 'string' },
4010
- },
4011
- required: [
4012
- 'acs_credential_provisioning_automation_id',
4013
- 'credential_manager_acs_system_id',
4014
- 'user_identity_id',
4015
- 'created_at',
4016
- 'workspace_id',
4017
- ],
4018
- type: 'object',
4195
+ $ref: '#/components/schemas/acs_credential_provisioning_automation',
4019
4196
  },
4020
4197
  ok: { type: 'boolean' },
4021
4198
  },
@@ -4038,6 +4215,7 @@ export default {
4038
4215
  tags: ['/acs'],
4039
4216
  'x-fern-sdk-group-name': ['acs', 'credential_provisioning_automations'],
4040
4217
  'x-fern-sdk-method-name': 'launch',
4218
+ 'x-fern-sdk-return-value': 'acs_credential_provisioning_automation',
4041
4219
  },
4042
4220
  },
4043
4221
  '/acs/credentials/assign': {
@@ -4064,90 +4242,7 @@ export default {
4064
4242
  schema: {
4065
4243
  properties: {
4066
4244
  acs_credential: {
4067
- properties: {
4068
- access_method: {
4069
- enum: ['code', 'card', 'mobile_key'],
4070
- type: 'string',
4071
- },
4072
- acs_credential_id: { format: 'uuid', type: 'string' },
4073
- acs_credential_pool_id: {
4074
- format: 'uuid',
4075
- type: 'string',
4076
- },
4077
- acs_system_id: { format: 'uuid', type: 'string' },
4078
- acs_user_id: { format: 'uuid', type: 'string' },
4079
- code: { nullable: true, type: 'string' },
4080
- created_at: { format: 'date-time', type: 'string' },
4081
- display_name: { minLength: 1, type: 'string' },
4082
- ends_at: { type: 'string' },
4083
- errors: {
4084
- items: {
4085
- properties: {
4086
- error_code: { type: 'string' },
4087
- message: { type: 'string' },
4088
- },
4089
- required: ['error_code', 'message'],
4090
- type: 'object',
4091
- },
4092
- type: 'array',
4093
- },
4094
- external_type: {
4095
- enum: [
4096
- 'pti_card',
4097
- 'brivo_credential',
4098
- 'hid_credential',
4099
- 'visionline_card',
4100
- ],
4101
- type: 'string',
4102
- },
4103
- external_type_display_name: { type: 'string' },
4104
- is_multi_phone_sync_credential: { type: 'boolean' },
4105
- parent_acs_credential_id: {
4106
- format: 'uuid',
4107
- type: 'string',
4108
- },
4109
- starts_at: { type: 'string' },
4110
- visionline_metadata: {
4111
- properties: {
4112
- common_acs_entrance_ids: {
4113
- items: { format: 'uuid', type: 'string' },
4114
- type: 'array',
4115
- },
4116
- guest_acs_entrance_ids: {
4117
- items: { format: 'uuid', type: 'string' },
4118
- type: 'array',
4119
- },
4120
- joiner_acs_credential_ids: {
4121
- items: { format: 'uuid', type: 'string' },
4122
- type: 'array',
4123
- },
4124
- },
4125
- type: 'object',
4126
- },
4127
- warnings: {
4128
- items: {
4129
- properties: {
4130
- message: { type: 'string' },
4131
- warning_code: { type: 'string' },
4132
- },
4133
- required: ['warning_code', 'message'],
4134
- type: 'object',
4135
- },
4136
- type: 'array',
4137
- },
4138
- workspace_id: { format: 'uuid', type: 'string' },
4139
- },
4140
- required: [
4141
- 'acs_credential_id',
4142
- 'acs_system_id',
4143
- 'display_name',
4144
- 'access_method',
4145
- 'created_at',
4146
- 'workspace_id',
4147
- 'errors',
4148
- 'warnings',
4149
- ],
4150
- type: 'object',
4245
+ $ref: '#/components/schemas/acs_credential',
4151
4246
  },
4152
4247
  ok: { type: 'boolean' },
4153
4248
  },
@@ -4193,90 +4288,7 @@ export default {
4193
4288
  schema: {
4194
4289
  properties: {
4195
4290
  acs_credential: {
4196
- properties: {
4197
- access_method: {
4198
- enum: ['code', 'card', 'mobile_key'],
4199
- type: 'string',
4200
- },
4201
- acs_credential_id: { format: 'uuid', type: 'string' },
4202
- acs_credential_pool_id: {
4203
- format: 'uuid',
4204
- type: 'string',
4205
- },
4206
- acs_system_id: { format: 'uuid', type: 'string' },
4207
- acs_user_id: { format: 'uuid', type: 'string' },
4208
- code: { nullable: true, type: 'string' },
4209
- created_at: { format: 'date-time', type: 'string' },
4210
- display_name: { minLength: 1, type: 'string' },
4211
- ends_at: { type: 'string' },
4212
- errors: {
4213
- items: {
4214
- properties: {
4215
- error_code: { type: 'string' },
4216
- message: { type: 'string' },
4217
- },
4218
- required: ['error_code', 'message'],
4219
- type: 'object',
4220
- },
4221
- type: 'array',
4222
- },
4223
- external_type: {
4224
- enum: [
4225
- 'pti_card',
4226
- 'brivo_credential',
4227
- 'hid_credential',
4228
- 'visionline_card',
4229
- ],
4230
- type: 'string',
4231
- },
4232
- external_type_display_name: { type: 'string' },
4233
- is_multi_phone_sync_credential: { type: 'boolean' },
4234
- parent_acs_credential_id: {
4235
- format: 'uuid',
4236
- type: 'string',
4237
- },
4238
- starts_at: { type: 'string' },
4239
- visionline_metadata: {
4240
- properties: {
4241
- common_acs_entrance_ids: {
4242
- items: { format: 'uuid', type: 'string' },
4243
- type: 'array',
4244
- },
4245
- guest_acs_entrance_ids: {
4246
- items: { format: 'uuid', type: 'string' },
4247
- type: 'array',
4248
- },
4249
- joiner_acs_credential_ids: {
4250
- items: { format: 'uuid', type: 'string' },
4251
- type: 'array',
4252
- },
4253
- },
4254
- type: 'object',
4255
- },
4256
- warnings: {
4257
- items: {
4258
- properties: {
4259
- message: { type: 'string' },
4260
- warning_code: { type: 'string' },
4261
- },
4262
- required: ['warning_code', 'message'],
4263
- type: 'object',
4264
- },
4265
- type: 'array',
4266
- },
4267
- workspace_id: { format: 'uuid', type: 'string' },
4268
- },
4269
- required: [
4270
- 'acs_credential_id',
4271
- 'acs_system_id',
4272
- 'display_name',
4273
- 'access_method',
4274
- 'created_at',
4275
- 'workspace_id',
4276
- 'errors',
4277
- 'warnings',
4278
- ],
4279
- type: 'object',
4291
+ $ref: '#/components/schemas/acs_credential',
4280
4292
  },
4281
4293
  ok: { type: 'boolean' },
4282
4294
  },
@@ -4362,90 +4374,7 @@ export default {
4362
4374
  schema: {
4363
4375
  properties: {
4364
4376
  acs_credential: {
4365
- properties: {
4366
- access_method: {
4367
- enum: ['code', 'card', 'mobile_key'],
4368
- type: 'string',
4369
- },
4370
- acs_credential_id: { format: 'uuid', type: 'string' },
4371
- acs_credential_pool_id: {
4372
- format: 'uuid',
4373
- type: 'string',
4374
- },
4375
- acs_system_id: { format: 'uuid', type: 'string' },
4376
- acs_user_id: { format: 'uuid', type: 'string' },
4377
- code: { nullable: true, type: 'string' },
4378
- created_at: { format: 'date-time', type: 'string' },
4379
- display_name: { minLength: 1, type: 'string' },
4380
- ends_at: { type: 'string' },
4381
- errors: {
4382
- items: {
4383
- properties: {
4384
- error_code: { type: 'string' },
4385
- message: { type: 'string' },
4386
- },
4387
- required: ['error_code', 'message'],
4388
- type: 'object',
4389
- },
4390
- type: 'array',
4391
- },
4392
- external_type: {
4393
- enum: [
4394
- 'pti_card',
4395
- 'brivo_credential',
4396
- 'hid_credential',
4397
- 'visionline_card',
4398
- ],
4399
- type: 'string',
4400
- },
4401
- external_type_display_name: { type: 'string' },
4402
- is_multi_phone_sync_credential: { type: 'boolean' },
4403
- parent_acs_credential_id: {
4404
- format: 'uuid',
4405
- type: 'string',
4406
- },
4407
- starts_at: { type: 'string' },
4408
- visionline_metadata: {
4409
- properties: {
4410
- common_acs_entrance_ids: {
4411
- items: { format: 'uuid', type: 'string' },
4412
- type: 'array',
4413
- },
4414
- guest_acs_entrance_ids: {
4415
- items: { format: 'uuid', type: 'string' },
4416
- type: 'array',
4417
- },
4418
- joiner_acs_credential_ids: {
4419
- items: { format: 'uuid', type: 'string' },
4420
- type: 'array',
4421
- },
4422
- },
4423
- type: 'object',
4424
- },
4425
- warnings: {
4426
- items: {
4427
- properties: {
4428
- message: { type: 'string' },
4429
- warning_code: { type: 'string' },
4430
- },
4431
- required: ['warning_code', 'message'],
4432
- type: 'object',
4433
- },
4434
- type: 'array',
4435
- },
4436
- workspace_id: { format: 'uuid', type: 'string' },
4437
- },
4438
- required: [
4439
- 'acs_credential_id',
4440
- 'acs_system_id',
4441
- 'display_name',
4442
- 'access_method',
4443
- 'created_at',
4444
- 'workspace_id',
4445
- 'errors',
4446
- 'warnings',
4447
- ],
4448
- type: 'object',
4377
+ $ref: '#/components/schemas/acs_credential',
4449
4378
  },
4450
4379
  ok: { type: 'boolean' },
4451
4380
  },
@@ -4468,6 +4397,7 @@ export default {
4468
4397
  tags: ['/acs'],
4469
4398
  'x-fern-sdk-group-name': ['acs', 'credentials'],
4470
4399
  'x-fern-sdk-method-name': 'create',
4400
+ 'x-fern-sdk-return-value': 'acs_credential',
4471
4401
  },
4472
4402
  },
4473
4403
  '/acs/credentials/delete': {
@@ -4536,90 +4466,7 @@ export default {
4536
4466
  schema: {
4537
4467
  properties: {
4538
4468
  acs_credential: {
4539
- properties: {
4540
- access_method: {
4541
- enum: ['code', 'card', 'mobile_key'],
4542
- type: 'string',
4543
- },
4544
- acs_credential_id: { format: 'uuid', type: 'string' },
4545
- acs_credential_pool_id: {
4546
- format: 'uuid',
4547
- type: 'string',
4548
- },
4549
- acs_system_id: { format: 'uuid', type: 'string' },
4550
- acs_user_id: { format: 'uuid', type: 'string' },
4551
- code: { nullable: true, type: 'string' },
4552
- created_at: { format: 'date-time', type: 'string' },
4553
- display_name: { minLength: 1, type: 'string' },
4554
- ends_at: { type: 'string' },
4555
- errors: {
4556
- items: {
4557
- properties: {
4558
- error_code: { type: 'string' },
4559
- message: { type: 'string' },
4560
- },
4561
- required: ['error_code', 'message'],
4562
- type: 'object',
4563
- },
4564
- type: 'array',
4565
- },
4566
- external_type: {
4567
- enum: [
4568
- 'pti_card',
4569
- 'brivo_credential',
4570
- 'hid_credential',
4571
- 'visionline_card',
4572
- ],
4573
- type: 'string',
4574
- },
4575
- external_type_display_name: { type: 'string' },
4576
- is_multi_phone_sync_credential: { type: 'boolean' },
4577
- parent_acs_credential_id: {
4578
- format: 'uuid',
4579
- type: 'string',
4580
- },
4581
- starts_at: { type: 'string' },
4582
- visionline_metadata: {
4583
- properties: {
4584
- common_acs_entrance_ids: {
4585
- items: { format: 'uuid', type: 'string' },
4586
- type: 'array',
4587
- },
4588
- guest_acs_entrance_ids: {
4589
- items: { format: 'uuid', type: 'string' },
4590
- type: 'array',
4591
- },
4592
- joiner_acs_credential_ids: {
4593
- items: { format: 'uuid', type: 'string' },
4594
- type: 'array',
4595
- },
4596
- },
4597
- type: 'object',
4598
- },
4599
- warnings: {
4600
- items: {
4601
- properties: {
4602
- message: { type: 'string' },
4603
- warning_code: { type: 'string' },
4604
- },
4605
- required: ['warning_code', 'message'],
4606
- type: 'object',
4607
- },
4608
- type: 'array',
4609
- },
4610
- workspace_id: { format: 'uuid', type: 'string' },
4611
- },
4612
- required: [
4613
- 'acs_credential_id',
4614
- 'acs_system_id',
4615
- 'display_name',
4616
- 'access_method',
4617
- 'created_at',
4618
- 'workspace_id',
4619
- 'errors',
4620
- 'warnings',
4621
- ],
4622
- type: 'object',
4469
+ $ref: '#/components/schemas/acs_credential',
4623
4470
  },
4624
4471
  ok: { type: 'boolean' },
4625
4472
  },
@@ -4642,6 +4489,7 @@ export default {
4642
4489
  tags: ['/acs'],
4643
4490
  'x-fern-sdk-group-name': ['acs', 'credentials'],
4644
4491
  'x-fern-sdk-method-name': 'get',
4492
+ 'x-fern-sdk-return-value': 'acs_credential',
4645
4493
  },
4646
4494
  },
4647
4495
  '/acs/credentials/list': {
@@ -4703,92 +4551,7 @@ export default {
4703
4551
  schema: {
4704
4552
  properties: {
4705
4553
  acs_credentials: {
4706
- items: {
4707
- properties: {
4708
- access_method: {
4709
- enum: ['code', 'card', 'mobile_key'],
4710
- type: 'string',
4711
- },
4712
- acs_credential_id: { format: 'uuid', type: 'string' },
4713
- acs_credential_pool_id: {
4714
- format: 'uuid',
4715
- type: 'string',
4716
- },
4717
- acs_system_id: { format: 'uuid', type: 'string' },
4718
- acs_user_id: { format: 'uuid', type: 'string' },
4719
- code: { nullable: true, type: 'string' },
4720
- created_at: { format: 'date-time', type: 'string' },
4721
- display_name: { minLength: 1, type: 'string' },
4722
- ends_at: { type: 'string' },
4723
- errors: {
4724
- items: {
4725
- properties: {
4726
- error_code: { type: 'string' },
4727
- message: { type: 'string' },
4728
- },
4729
- required: ['error_code', 'message'],
4730
- type: 'object',
4731
- },
4732
- type: 'array',
4733
- },
4734
- external_type: {
4735
- enum: [
4736
- 'pti_card',
4737
- 'brivo_credential',
4738
- 'hid_credential',
4739
- 'visionline_card',
4740
- ],
4741
- type: 'string',
4742
- },
4743
- external_type_display_name: { type: 'string' },
4744
- is_multi_phone_sync_credential: { type: 'boolean' },
4745
- parent_acs_credential_id: {
4746
- format: 'uuid',
4747
- type: 'string',
4748
- },
4749
- starts_at: { type: 'string' },
4750
- visionline_metadata: {
4751
- properties: {
4752
- common_acs_entrance_ids: {
4753
- items: { format: 'uuid', type: 'string' },
4754
- type: 'array',
4755
- },
4756
- guest_acs_entrance_ids: {
4757
- items: { format: 'uuid', type: 'string' },
4758
- type: 'array',
4759
- },
4760
- joiner_acs_credential_ids: {
4761
- items: { format: 'uuid', type: 'string' },
4762
- type: 'array',
4763
- },
4764
- },
4765
- type: 'object',
4766
- },
4767
- warnings: {
4768
- items: {
4769
- properties: {
4770
- message: { type: 'string' },
4771
- warning_code: { type: 'string' },
4772
- },
4773
- required: ['warning_code', 'message'],
4774
- type: 'object',
4775
- },
4776
- type: 'array',
4777
- },
4778
- workspace_id: { format: 'uuid', type: 'string' },
4779
- },
4780
- required: [
4781
- 'acs_credential_id',
4782
- 'acs_system_id',
4783
- 'display_name',
4784
- 'access_method',
4785
- 'created_at',
4786
- 'workspace_id',
4787
- 'errors',
4788
- 'warnings',
4789
- ],
4790
- type: 'object',
4791
- },
4554
+ items: { $ref: '#/components/schemas/acs_credential' },
4792
4555
  type: 'array',
4793
4556
  },
4794
4557
  ok: { type: 'boolean' },
@@ -4813,6 +4576,7 @@ export default {
4813
4576
  tags: ['/acs'],
4814
4577
  'x-fern-sdk-group-name': ['acs', 'credentials'],
4815
4578
  'x-fern-sdk-method-name': 'list',
4579
+ 'x-fern-sdk-return-value': 'acs_credentials',
4816
4580
  },
4817
4581
  },
4818
4582
  '/acs/credentials/unassign': {
@@ -4839,90 +4603,7 @@ export default {
4839
4603
  schema: {
4840
4604
  properties: {
4841
4605
  acs_credential: {
4842
- properties: {
4843
- access_method: {
4844
- enum: ['code', 'card', 'mobile_key'],
4845
- type: 'string',
4846
- },
4847
- acs_credential_id: { format: 'uuid', type: 'string' },
4848
- acs_credential_pool_id: {
4849
- format: 'uuid',
4850
- type: 'string',
4851
- },
4852
- acs_system_id: { format: 'uuid', type: 'string' },
4853
- acs_user_id: { format: 'uuid', type: 'string' },
4854
- code: { nullable: true, type: 'string' },
4855
- created_at: { format: 'date-time', type: 'string' },
4856
- display_name: { minLength: 1, type: 'string' },
4857
- ends_at: { type: 'string' },
4858
- errors: {
4859
- items: {
4860
- properties: {
4861
- error_code: { type: 'string' },
4862
- message: { type: 'string' },
4863
- },
4864
- required: ['error_code', 'message'],
4865
- type: 'object',
4866
- },
4867
- type: 'array',
4868
- },
4869
- external_type: {
4870
- enum: [
4871
- 'pti_card',
4872
- 'brivo_credential',
4873
- 'hid_credential',
4874
- 'visionline_card',
4875
- ],
4876
- type: 'string',
4877
- },
4878
- external_type_display_name: { type: 'string' },
4879
- is_multi_phone_sync_credential: { type: 'boolean' },
4880
- parent_acs_credential_id: {
4881
- format: 'uuid',
4882
- type: 'string',
4883
- },
4884
- starts_at: { type: 'string' },
4885
- visionline_metadata: {
4886
- properties: {
4887
- common_acs_entrance_ids: {
4888
- items: { format: 'uuid', type: 'string' },
4889
- type: 'array',
4890
- },
4891
- guest_acs_entrance_ids: {
4892
- items: { format: 'uuid', type: 'string' },
4893
- type: 'array',
4894
- },
4895
- joiner_acs_credential_ids: {
4896
- items: { format: 'uuid', type: 'string' },
4897
- type: 'array',
4898
- },
4899
- },
4900
- type: 'object',
4901
- },
4902
- warnings: {
4903
- items: {
4904
- properties: {
4905
- message: { type: 'string' },
4906
- warning_code: { type: 'string' },
4907
- },
4908
- required: ['warning_code', 'message'],
4909
- type: 'object',
4910
- },
4911
- type: 'array',
4912
- },
4913
- workspace_id: { format: 'uuid', type: 'string' },
4914
- },
4915
- required: [
4916
- 'acs_credential_id',
4917
- 'acs_system_id',
4918
- 'display_name',
4919
- 'access_method',
4920
- 'created_at',
4921
- 'workspace_id',
4922
- 'errors',
4923
- 'warnings',
4924
- ],
4925
- type: 'object',
4606
+ $ref: '#/components/schemas/acs_credential',
4926
4607
  },
4927
4608
  ok: { type: 'boolean' },
4928
4609
  },
@@ -4968,90 +4649,7 @@ export default {
4968
4649
  schema: {
4969
4650
  properties: {
4970
4651
  acs_credential: {
4971
- properties: {
4972
- access_method: {
4973
- enum: ['code', 'card', 'mobile_key'],
4974
- type: 'string',
4975
- },
4976
- acs_credential_id: { format: 'uuid', type: 'string' },
4977
- acs_credential_pool_id: {
4978
- format: 'uuid',
4979
- type: 'string',
4980
- },
4981
- acs_system_id: { format: 'uuid', type: 'string' },
4982
- acs_user_id: { format: 'uuid', type: 'string' },
4983
- code: { nullable: true, type: 'string' },
4984
- created_at: { format: 'date-time', type: 'string' },
4985
- display_name: { minLength: 1, type: 'string' },
4986
- ends_at: { type: 'string' },
4987
- errors: {
4988
- items: {
4989
- properties: {
4990
- error_code: { type: 'string' },
4991
- message: { type: 'string' },
4992
- },
4993
- required: ['error_code', 'message'],
4994
- type: 'object',
4995
- },
4996
- type: 'array',
4997
- },
4998
- external_type: {
4999
- enum: [
5000
- 'pti_card',
5001
- 'brivo_credential',
5002
- 'hid_credential',
5003
- 'visionline_card',
5004
- ],
5005
- type: 'string',
5006
- },
5007
- external_type_display_name: { type: 'string' },
5008
- is_multi_phone_sync_credential: { type: 'boolean' },
5009
- parent_acs_credential_id: {
5010
- format: 'uuid',
5011
- type: 'string',
5012
- },
5013
- starts_at: { type: 'string' },
5014
- visionline_metadata: {
5015
- properties: {
5016
- common_acs_entrance_ids: {
5017
- items: { format: 'uuid', type: 'string' },
5018
- type: 'array',
5019
- },
5020
- guest_acs_entrance_ids: {
5021
- items: { format: 'uuid', type: 'string' },
5022
- type: 'array',
5023
- },
5024
- joiner_acs_credential_ids: {
5025
- items: { format: 'uuid', type: 'string' },
5026
- type: 'array',
5027
- },
5028
- },
5029
- type: 'object',
5030
- },
5031
- warnings: {
5032
- items: {
5033
- properties: {
5034
- message: { type: 'string' },
5035
- warning_code: { type: 'string' },
5036
- },
5037
- required: ['warning_code', 'message'],
5038
- type: 'object',
5039
- },
5040
- type: 'array',
5041
- },
5042
- workspace_id: { format: 'uuid', type: 'string' },
5043
- },
5044
- required: [
5045
- 'acs_credential_id',
5046
- 'acs_system_id',
5047
- 'display_name',
5048
- 'access_method',
5049
- 'created_at',
5050
- 'workspace_id',
5051
- 'errors',
5052
- 'warnings',
5053
- ],
5054
- type: 'object',
4652
+ $ref: '#/components/schemas/acs_credential',
5055
4653
  },
5056
4654
  ok: { type: 'boolean' },
5057
4655
  },
@@ -5081,109 +4679,26 @@ export default {
5081
4679
  operationId: 'acsCredentialsUpdatePatch',
5082
4680
  requestBody: {
5083
4681
  content: {
5084
- 'application/json': {
5085
- schema: {
5086
- properties: {
5087
- acs_credential_id: { type: 'string' },
5088
- code: { pattern: '^\\d+$', type: 'string' },
5089
- },
5090
- required: ['acs_credential_id', 'code'],
5091
- type: 'object',
5092
- },
5093
- },
5094
- },
5095
- },
5096
- responses: {
5097
- 200: {
5098
- content: {
5099
- 'application/json': {
5100
- schema: {
5101
- properties: {
5102
- acs_credential: {
5103
- properties: {
5104
- access_method: {
5105
- enum: ['code', 'card', 'mobile_key'],
5106
- type: 'string',
5107
- },
5108
- acs_credential_id: { format: 'uuid', type: 'string' },
5109
- acs_credential_pool_id: {
5110
- format: 'uuid',
5111
- type: 'string',
5112
- },
5113
- acs_system_id: { format: 'uuid', type: 'string' },
5114
- acs_user_id: { format: 'uuid', type: 'string' },
5115
- code: { nullable: true, type: 'string' },
5116
- created_at: { format: 'date-time', type: 'string' },
5117
- display_name: { minLength: 1, type: 'string' },
5118
- ends_at: { type: 'string' },
5119
- errors: {
5120
- items: {
5121
- properties: {
5122
- error_code: { type: 'string' },
5123
- message: { type: 'string' },
5124
- },
5125
- required: ['error_code', 'message'],
5126
- type: 'object',
5127
- },
5128
- type: 'array',
5129
- },
5130
- external_type: {
5131
- enum: [
5132
- 'pti_card',
5133
- 'brivo_credential',
5134
- 'hid_credential',
5135
- 'visionline_card',
5136
- ],
5137
- type: 'string',
5138
- },
5139
- external_type_display_name: { type: 'string' },
5140
- is_multi_phone_sync_credential: { type: 'boolean' },
5141
- parent_acs_credential_id: {
5142
- format: 'uuid',
5143
- type: 'string',
5144
- },
5145
- starts_at: { type: 'string' },
5146
- visionline_metadata: {
5147
- properties: {
5148
- common_acs_entrance_ids: {
5149
- items: { format: 'uuid', type: 'string' },
5150
- type: 'array',
5151
- },
5152
- guest_acs_entrance_ids: {
5153
- items: { format: 'uuid', type: 'string' },
5154
- type: 'array',
5155
- },
5156
- joiner_acs_credential_ids: {
5157
- items: { format: 'uuid', type: 'string' },
5158
- type: 'array',
5159
- },
5160
- },
5161
- type: 'object',
5162
- },
5163
- warnings: {
5164
- items: {
5165
- properties: {
5166
- message: { type: 'string' },
5167
- warning_code: { type: 'string' },
5168
- },
5169
- required: ['warning_code', 'message'],
5170
- type: 'object',
5171
- },
5172
- type: 'array',
5173
- },
5174
- workspace_id: { format: 'uuid', type: 'string' },
5175
- },
5176
- required: [
5177
- 'acs_credential_id',
5178
- 'acs_system_id',
5179
- 'display_name',
5180
- 'access_method',
5181
- 'created_at',
5182
- 'workspace_id',
5183
- 'errors',
5184
- 'warnings',
5185
- ],
5186
- 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',
5187
4702
  },
5188
4703
  ok: { type: 'boolean' },
5189
4704
  },
@@ -5229,90 +4744,7 @@ export default {
5229
4744
  schema: {
5230
4745
  properties: {
5231
4746
  acs_credential: {
5232
- properties: {
5233
- access_method: {
5234
- enum: ['code', 'card', 'mobile_key'],
5235
- type: 'string',
5236
- },
5237
- acs_credential_id: { format: 'uuid', type: 'string' },
5238
- acs_credential_pool_id: {
5239
- format: 'uuid',
5240
- type: 'string',
5241
- },
5242
- acs_system_id: { format: 'uuid', type: 'string' },
5243
- acs_user_id: { format: 'uuid', type: 'string' },
5244
- code: { nullable: true, type: 'string' },
5245
- created_at: { format: 'date-time', type: 'string' },
5246
- display_name: { minLength: 1, type: 'string' },
5247
- ends_at: { type: 'string' },
5248
- errors: {
5249
- items: {
5250
- properties: {
5251
- error_code: { type: 'string' },
5252
- message: { type: 'string' },
5253
- },
5254
- required: ['error_code', 'message'],
5255
- type: 'object',
5256
- },
5257
- type: 'array',
5258
- },
5259
- external_type: {
5260
- enum: [
5261
- 'pti_card',
5262
- 'brivo_credential',
5263
- 'hid_credential',
5264
- 'visionline_card',
5265
- ],
5266
- type: 'string',
5267
- },
5268
- external_type_display_name: { type: 'string' },
5269
- is_multi_phone_sync_credential: { type: 'boolean' },
5270
- parent_acs_credential_id: {
5271
- format: 'uuid',
5272
- type: 'string',
5273
- },
5274
- starts_at: { type: 'string' },
5275
- visionline_metadata: {
5276
- properties: {
5277
- common_acs_entrance_ids: {
5278
- items: { format: 'uuid', type: 'string' },
5279
- type: 'array',
5280
- },
5281
- guest_acs_entrance_ids: {
5282
- items: { format: 'uuid', type: 'string' },
5283
- type: 'array',
5284
- },
5285
- joiner_acs_credential_ids: {
5286
- items: { format: 'uuid', type: 'string' },
5287
- type: 'array',
5288
- },
5289
- },
5290
- type: 'object',
5291
- },
5292
- warnings: {
5293
- items: {
5294
- properties: {
5295
- message: { type: 'string' },
5296
- warning_code: { type: 'string' },
5297
- },
5298
- required: ['warning_code', 'message'],
5299
- type: 'object',
5300
- },
5301
- type: 'array',
5302
- },
5303
- workspace_id: { format: 'uuid', type: 'string' },
5304
- },
5305
- required: [
5306
- 'acs_credential_id',
5307
- 'acs_system_id',
5308
- 'display_name',
5309
- 'access_method',
5310
- 'created_at',
5311
- 'workspace_id',
5312
- 'errors',
5313
- 'warnings',
5314
- ],
5315
- type: 'object',
4747
+ $ref: '#/components/schemas/acs_credential',
5316
4748
  },
5317
4749
  ok: { type: 'boolean' },
5318
4750
  },
@@ -5359,76 +4791,7 @@ export default {
5359
4791
  'application/json': {
5360
4792
  schema: {
5361
4793
  properties: {
5362
- acs_entrance: {
5363
- properties: {
5364
- acs_entrance_id: { format: 'uuid', type: 'string' },
5365
- acs_system_id: { format: 'uuid', type: 'string' },
5366
- created_at: { format: 'date-time', type: 'string' },
5367
- display_name: { type: 'string' },
5368
- latch_metadata: {
5369
- nullable: true,
5370
- properties: {
5371
- accessibility_type: { type: 'string' },
5372
- is_connected: { type: 'boolean' },
5373
- name: { type: 'string' },
5374
- type: { type: 'string' },
5375
- },
5376
- required: [
5377
- 'accessibility_type',
5378
- 'name',
5379
- 'type',
5380
- 'is_connected',
5381
- ],
5382
- type: 'object',
5383
- },
5384
- visionline_metadata: {
5385
- nullable: true,
5386
- properties: {
5387
- door_category: {
5388
- enum: [
5389
- 'entrance',
5390
- 'guest',
5391
- 'elevator reader',
5392
- 'common',
5393
- 'common (PMS)',
5394
- ],
5395
- type: 'string',
5396
- },
5397
- door_name: { type: 'string' },
5398
- profiles: {
5399
- items: {
5400
- properties: {
5401
- visionline_door_profile_id: {
5402
- type: 'string',
5403
- },
5404
- visionline_door_profile_type: {
5405
- enum: ['BLE', 'commonDoor', 'touch'],
5406
- type: 'string',
5407
- },
5408
- },
5409
- required: [
5410
- 'visionline_door_profile_id',
5411
- 'visionline_door_profile_type',
5412
- ],
5413
- type: 'object',
5414
- },
5415
- type: 'array',
5416
- },
5417
- },
5418
- required: ['door_name', 'door_category'],
5419
- type: 'object',
5420
- },
5421
- },
5422
- required: [
5423
- 'acs_entrance_id',
5424
- 'display_name',
5425
- 'acs_system_id',
5426
- 'created_at',
5427
- 'latch_metadata',
5428
- 'visionline_metadata',
5429
- ],
5430
- type: 'object',
5431
- },
4794
+ acs_entrance: { $ref: '#/components/schemas/acs_entrance' },
5432
4795
  ok: { type: 'boolean' },
5433
4796
  },
5434
4797
  required: ['acs_entrance', 'ok'],
@@ -5451,6 +4814,7 @@ export default {
5451
4814
  tags: ['/acs'],
5452
4815
  'x-fern-sdk-group-name': ['acs', 'entrances'],
5453
4816
  'x-fern-sdk-method-name': 'get',
4817
+ 'x-fern-sdk-return-value': 'acs_entrance',
5454
4818
  },
5455
4819
  },
5456
4820
  '/acs/entrances/grant_access': {
@@ -5521,76 +4885,7 @@ export default {
5521
4885
  schema: {
5522
4886
  properties: {
5523
4887
  acs_entrances: {
5524
- items: {
5525
- properties: {
5526
- acs_entrance_id: { format: 'uuid', type: 'string' },
5527
- acs_system_id: { format: 'uuid', type: 'string' },
5528
- created_at: { format: 'date-time', type: 'string' },
5529
- display_name: { type: 'string' },
5530
- latch_metadata: {
5531
- nullable: true,
5532
- properties: {
5533
- accessibility_type: { type: 'string' },
5534
- is_connected: { type: 'boolean' },
5535
- name: { type: 'string' },
5536
- type: { type: 'string' },
5537
- },
5538
- required: [
5539
- 'accessibility_type',
5540
- 'name',
5541
- 'type',
5542
- 'is_connected',
5543
- ],
5544
- type: 'object',
5545
- },
5546
- visionline_metadata: {
5547
- nullable: true,
5548
- properties: {
5549
- door_category: {
5550
- enum: [
5551
- 'entrance',
5552
- 'guest',
5553
- 'elevator reader',
5554
- 'common',
5555
- 'common (PMS)',
5556
- ],
5557
- type: 'string',
5558
- },
5559
- door_name: { type: 'string' },
5560
- profiles: {
5561
- items: {
5562
- properties: {
5563
- visionline_door_profile_id: {
5564
- type: 'string',
5565
- },
5566
- visionline_door_profile_type: {
5567
- enum: ['BLE', 'commonDoor', 'touch'],
5568
- type: 'string',
5569
- },
5570
- },
5571
- required: [
5572
- 'visionline_door_profile_id',
5573
- 'visionline_door_profile_type',
5574
- ],
5575
- type: 'object',
5576
- },
5577
- type: 'array',
5578
- },
5579
- },
5580
- required: ['door_name', 'door_category'],
5581
- type: 'object',
5582
- },
5583
- },
5584
- required: [
5585
- 'acs_entrance_id',
5586
- 'display_name',
5587
- 'acs_system_id',
5588
- 'created_at',
5589
- 'latch_metadata',
5590
- 'visionline_metadata',
5591
- ],
5592
- type: 'object',
5593
- },
4888
+ items: { $ref: '#/components/schemas/acs_entrance' },
5594
4889
  type: 'array',
5595
4890
  },
5596
4891
  ok: { type: 'boolean' },
@@ -5615,6 +4910,7 @@ export default {
5615
4910
  tags: ['/acs'],
5616
4911
  'x-fern-sdk-group-name': ['acs', 'entrances'],
5617
4912
  'x-fern-sdk-method-name': 'list',
4913
+ 'x-fern-sdk-return-value': 'acs_entrances',
5618
4914
  },
5619
4915
  },
5620
4916
  '/acs/entrances/list_credentials_with_access': {
@@ -5647,92 +4943,7 @@ export default {
5647
4943
  schema: {
5648
4944
  properties: {
5649
4945
  acs_credentials: {
5650
- items: {
5651
- properties: {
5652
- access_method: {
5653
- enum: ['code', 'card', 'mobile_key'],
5654
- type: 'string',
5655
- },
5656
- acs_credential_id: { format: 'uuid', type: 'string' },
5657
- acs_credential_pool_id: {
5658
- format: 'uuid',
5659
- type: 'string',
5660
- },
5661
- acs_system_id: { format: 'uuid', type: 'string' },
5662
- acs_user_id: { format: 'uuid', type: 'string' },
5663
- code: { nullable: true, type: 'string' },
5664
- created_at: { format: 'date-time', type: 'string' },
5665
- display_name: { minLength: 1, type: 'string' },
5666
- ends_at: { type: 'string' },
5667
- errors: {
5668
- items: {
5669
- properties: {
5670
- error_code: { type: 'string' },
5671
- message: { type: 'string' },
5672
- },
5673
- required: ['error_code', 'message'],
5674
- type: 'object',
5675
- },
5676
- type: 'array',
5677
- },
5678
- external_type: {
5679
- enum: [
5680
- 'pti_card',
5681
- 'brivo_credential',
5682
- 'hid_credential',
5683
- 'visionline_card',
5684
- ],
5685
- type: 'string',
5686
- },
5687
- external_type_display_name: { type: 'string' },
5688
- is_multi_phone_sync_credential: { type: 'boolean' },
5689
- parent_acs_credential_id: {
5690
- format: 'uuid',
5691
- type: 'string',
5692
- },
5693
- starts_at: { type: 'string' },
5694
- visionline_metadata: {
5695
- properties: {
5696
- common_acs_entrance_ids: {
5697
- items: { format: 'uuid', type: 'string' },
5698
- type: 'array',
5699
- },
5700
- guest_acs_entrance_ids: {
5701
- items: { format: 'uuid', type: 'string' },
5702
- type: 'array',
5703
- },
5704
- joiner_acs_credential_ids: {
5705
- items: { format: 'uuid', type: 'string' },
5706
- type: 'array',
5707
- },
5708
- },
5709
- type: 'object',
5710
- },
5711
- warnings: {
5712
- items: {
5713
- properties: {
5714
- message: { type: 'string' },
5715
- warning_code: { type: 'string' },
5716
- },
5717
- required: ['warning_code', 'message'],
5718
- type: 'object',
5719
- },
5720
- type: 'array',
5721
- },
5722
- workspace_id: { format: 'uuid', type: 'string' },
5723
- },
5724
- required: [
5725
- 'acs_credential_id',
5726
- 'acs_system_id',
5727
- 'display_name',
5728
- 'access_method',
5729
- 'created_at',
5730
- 'workspace_id',
5731
- 'errors',
5732
- 'warnings',
5733
- ],
5734
- type: 'object',
5735
- },
4946
+ items: { $ref: '#/components/schemas/acs_credential' },
5736
4947
  type: 'array',
5737
4948
  },
5738
4949
  ok: { type: 'boolean' },
@@ -5757,6 +4968,7 @@ export default {
5757
4968
  tags: ['/acs'],
5758
4969
  'x-fern-sdk-group-name': ['acs', 'entrances'],
5759
4970
  'x-fern-sdk-method-name': 'list_credentials_with_access',
4971
+ 'x-fern-sdk-return-value': 'acs_credentials',
5760
4972
  },
5761
4973
  },
5762
4974
  '/acs/systems/get': {
@@ -5803,6 +5015,7 @@ export default {
5803
5015
  tags: ['/acs'],
5804
5016
  'x-fern-sdk-group-name': ['acs', 'systems'],
5805
5017
  'x-fern-sdk-method-name': 'get',
5018
+ 'x-fern-sdk-return-value': 'acs_system',
5806
5019
  },
5807
5020
  },
5808
5021
  '/acs/systems/list': {
@@ -5852,6 +5065,7 @@ export default {
5852
5065
  tags: ['/acs'],
5853
5066
  'x-fern-sdk-group-name': ['acs', 'systems'],
5854
5067
  'x-fern-sdk-method-name': 'list',
5068
+ 'x-fern-sdk-return-value': 'acs_systems',
5855
5069
  },
5856
5070
  },
5857
5071
  '/acs/users/add_to_access_group': {
@@ -6006,6 +5220,7 @@ export default {
6006
5220
  tags: ['/acs'],
6007
5221
  'x-fern-sdk-group-name': ['acs', 'users'],
6008
5222
  'x-fern-sdk-method-name': 'create',
5223
+ 'x-fern-sdk-return-value': 'acs_user',
6009
5224
  },
6010
5225
  },
6011
5226
  '/acs/users/delete': {
@@ -6091,6 +5306,7 @@ export default {
6091
5306
  tags: ['/acs'],
6092
5307
  'x-fern-sdk-group-name': ['acs', 'users'],
6093
5308
  'x-fern-sdk-method-name': 'get',
5309
+ 'x-fern-sdk-return-value': 'acs_user',
6094
5310
  },
6095
5311
  },
6096
5312
  '/acs/users/list': {
@@ -6146,6 +5362,7 @@ export default {
6146
5362
  tags: ['/acs'],
6147
5363
  'x-fern-sdk-group-name': ['acs', 'users'],
6148
5364
  'x-fern-sdk-method-name': 'list',
5365
+ 'x-fern-sdk-return-value': 'acs_users',
6149
5366
  },
6150
5367
  },
6151
5368
  '/acs/users/list_accessible_entrances': {
@@ -6169,76 +5386,7 @@ export default {
6169
5386
  schema: {
6170
5387
  properties: {
6171
5388
  acs_entrances: {
6172
- items: {
6173
- properties: {
6174
- acs_entrance_id: { format: 'uuid', type: 'string' },
6175
- acs_system_id: { format: 'uuid', type: 'string' },
6176
- created_at: { format: 'date-time', type: 'string' },
6177
- display_name: { type: 'string' },
6178
- latch_metadata: {
6179
- nullable: true,
6180
- properties: {
6181
- accessibility_type: { type: 'string' },
6182
- is_connected: { type: 'boolean' },
6183
- name: { type: 'string' },
6184
- type: { type: 'string' },
6185
- },
6186
- required: [
6187
- 'accessibility_type',
6188
- 'name',
6189
- 'type',
6190
- 'is_connected',
6191
- ],
6192
- type: 'object',
6193
- },
6194
- visionline_metadata: {
6195
- nullable: true,
6196
- properties: {
6197
- door_category: {
6198
- enum: [
6199
- 'entrance',
6200
- 'guest',
6201
- 'elevator reader',
6202
- 'common',
6203
- 'common (PMS)',
6204
- ],
6205
- type: 'string',
6206
- },
6207
- door_name: { type: 'string' },
6208
- profiles: {
6209
- items: {
6210
- properties: {
6211
- visionline_door_profile_id: {
6212
- type: 'string',
6213
- },
6214
- visionline_door_profile_type: {
6215
- enum: ['BLE', 'commonDoor', 'touch'],
6216
- type: 'string',
6217
- },
6218
- },
6219
- required: [
6220
- 'visionline_door_profile_id',
6221
- 'visionline_door_profile_type',
6222
- ],
6223
- type: 'object',
6224
- },
6225
- type: 'array',
6226
- },
6227
- },
6228
- required: ['door_name', 'door_category'],
6229
- type: 'object',
6230
- },
6231
- },
6232
- required: [
6233
- 'acs_entrance_id',
6234
- 'display_name',
6235
- 'acs_system_id',
6236
- 'created_at',
6237
- 'latch_metadata',
6238
- 'visionline_metadata',
6239
- ],
6240
- type: 'object',
6241
- },
5389
+ items: { $ref: '#/components/schemas/acs_entrance' },
6242
5390
  type: 'array',
6243
5391
  },
6244
5392
  ok: { type: 'boolean' },
@@ -6263,6 +5411,7 @@ export default {
6263
5411
  tags: ['/acs'],
6264
5412
  'x-fern-sdk-group-name': ['acs', 'users'],
6265
5413
  'x-fern-sdk-method-name': 'list_accessible_entrances',
5414
+ 'x-fern-sdk-return-value': 'acs_entrances',
6266
5415
  },
6267
5416
  },
6268
5417
  '/acs/users/remove_from_access_group': {
@@ -9520,21 +8669,7 @@ export default {
9520
8669
  'application/json': {
9521
8670
  schema: {
9522
8671
  properties: {
9523
- network: {
9524
- properties: {
9525
- created_at: { format: 'date-time', type: 'string' },
9526
- display_name: { type: 'string' },
9527
- network_id: { format: 'uuid', type: 'string' },
9528
- workspace_id: { format: 'uuid', type: 'string' },
9529
- },
9530
- required: [
9531
- 'network_id',
9532
- 'workspace_id',
9533
- 'display_name',
9534
- 'created_at',
9535
- ],
9536
- type: 'object',
9537
- },
8672
+ network: { $ref: '#/components/schemas/network' },
9538
8673
  ok: { type: 'boolean' },
9539
8674
  },
9540
8675
  required: ['network', 'ok'],
@@ -9556,6 +8691,7 @@ export default {
9556
8691
  tags: ['/networks'],
9557
8692
  'x-fern-sdk-group-name': ['networks'],
9558
8693
  'x-fern-sdk-method-name': 'get',
8694
+ 'x-fern-sdk-return-value': 'network',
9559
8695
  },
9560
8696
  },
9561
8697
  '/networks/list': {
@@ -9573,21 +8709,7 @@ export default {
9573
8709
  schema: {
9574
8710
  properties: {
9575
8711
  networks: {
9576
- items: {
9577
- properties: {
9578
- created_at: { format: 'date-time', type: 'string' },
9579
- display_name: { type: 'string' },
9580
- network_id: { format: 'uuid', type: 'string' },
9581
- workspace_id: { format: 'uuid', type: 'string' },
9582
- },
9583
- required: [
9584
- 'network_id',
9585
- 'workspace_id',
9586
- 'display_name',
9587
- 'created_at',
9588
- ],
9589
- type: 'object',
9590
- },
8712
+ items: { $ref: '#/components/schemas/network' },
9591
8713
  type: 'array',
9592
8714
  },
9593
8715
  ok: { type: 'boolean' },
@@ -9611,6 +8733,7 @@ export default {
9611
8733
  tags: ['/networks'],
9612
8734
  'x-fern-sdk-group-name': ['networks'],
9613
8735
  'x-fern-sdk-method-name': 'list',
8736
+ 'x-fern-sdk-return-value': 'networks',
9614
8737
  },
9615
8738
  },
9616
8739
  '/noise_sensors/noise_thresholds/create': {
@@ -11464,39 +10587,7 @@ export default {
11464
10587
  properties: {
11465
10588
  ok: { type: 'boolean' },
11466
10589
  user_identity: {
11467
- properties: {
11468
- created_at: { format: 'date-time', type: 'string' },
11469
- display_name: { minLength: 1, type: 'string' },
11470
- email_address: {
11471
- format: 'email',
11472
- nullable: true,
11473
- type: 'string',
11474
- },
11475
- full_name: {
11476
- minLength: 1,
11477
- nullable: true,
11478
- type: 'string',
11479
- },
11480
- phone_number: { nullable: true, type: 'string' },
11481
- user_identity_id: { format: 'uuid', type: 'string' },
11482
- user_identity_key: {
11483
- minLength: 1,
11484
- nullable: true,
11485
- type: 'string',
11486
- },
11487
- workspace_id: { format: 'uuid', type: 'string' },
11488
- },
11489
- required: [
11490
- 'user_identity_id',
11491
- 'user_identity_key',
11492
- 'email_address',
11493
- 'phone_number',
11494
- 'display_name',
11495
- 'full_name',
11496
- 'created_at',
11497
- 'workspace_id',
11498
- ],
11499
- type: 'object',
10590
+ $ref: '#/components/schemas/user_identity',
11500
10591
  },
11501
10592
  },
11502
10593
  required: ['user_identity', 'ok'],
@@ -11518,6 +10609,7 @@ export default {
11518
10609
  tags: ['/user_identities'],
11519
10610
  'x-fern-sdk-group-name': ['user_identities'],
11520
10611
  'x-fern-sdk-method-name': 'create',
10612
+ 'x-fern-sdk-return-value': 'user_identity',
11521
10613
  },
11522
10614
  },
11523
10615
  '/user_identities/delete': {
@@ -11653,6 +10745,7 @@ export default {
11653
10745
  tags: ['/user_identities'],
11654
10746
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
11655
10747
  'x-fern-sdk-method-name': 'get',
10748
+ 'x-fern-sdk-return-value': 'enrollment_automation',
11656
10749
  },
11657
10750
  },
11658
10751
  '/user_identities/enrollment_automations/launch': {
@@ -11739,6 +10832,7 @@ export default {
11739
10832
  tags: ['/user_identities'],
11740
10833
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
11741
10834
  'x-fern-sdk-method-name': 'launch',
10835
+ 'x-fern-sdk-return-value': 'enrollment_automation',
11742
10836
  },
11743
10837
  },
11744
10838
  '/user_identities/enrollment_automations/list': {
@@ -11791,6 +10885,7 @@ export default {
11791
10885
  tags: ['/user_identities'],
11792
10886
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
11793
10887
  'x-fern-sdk-method-name': 'list',
10888
+ 'x-fern-sdk-return-value': 'enrollment_automations',
11794
10889
  },
11795
10890
  },
11796
10891
  '/user_identities/get': {
@@ -11826,39 +10921,7 @@ export default {
11826
10921
  properties: {
11827
10922
  ok: { type: 'boolean' },
11828
10923
  user_identity: {
11829
- properties: {
11830
- created_at: { format: 'date-time', type: 'string' },
11831
- display_name: { minLength: 1, type: 'string' },
11832
- email_address: {
11833
- format: 'email',
11834
- nullable: true,
11835
- type: 'string',
11836
- },
11837
- full_name: {
11838
- minLength: 1,
11839
- nullable: true,
11840
- type: 'string',
11841
- },
11842
- phone_number: { nullable: true, type: 'string' },
11843
- user_identity_id: { format: 'uuid', type: 'string' },
11844
- user_identity_key: {
11845
- minLength: 1,
11846
- nullable: true,
11847
- type: 'string',
11848
- },
11849
- workspace_id: { format: 'uuid', type: 'string' },
11850
- },
11851
- required: [
11852
- 'user_identity_id',
11853
- 'user_identity_key',
11854
- 'email_address',
11855
- 'phone_number',
11856
- 'display_name',
11857
- 'full_name',
11858
- 'created_at',
11859
- 'workspace_id',
11860
- ],
11861
- type: 'object',
10924
+ $ref: '#/components/schemas/user_identity',
11862
10925
  },
11863
10926
  },
11864
10927
  required: ['user_identity', 'ok'],
@@ -11880,6 +10943,7 @@ export default {
11880
10943
  tags: ['/user_identities'],
11881
10944
  'x-fern-sdk-group-name': ['user_identities'],
11882
10945
  'x-fern-sdk-method-name': 'get',
10946
+ 'x-fern-sdk-return-value': 'user_identity',
11883
10947
  },
11884
10948
  },
11885
10949
  '/user_identities/grant_access_to_device': {
@@ -11993,41 +11057,7 @@ export default {
11993
11057
  properties: {
11994
11058
  ok: { type: 'boolean' },
11995
11059
  user_identities: {
11996
- items: {
11997
- properties: {
11998
- created_at: { format: 'date-time', type: 'string' },
11999
- display_name: { minLength: 1, type: 'string' },
12000
- email_address: {
12001
- format: 'email',
12002
- nullable: true,
12003
- type: 'string',
12004
- },
12005
- full_name: {
12006
- minLength: 1,
12007
- nullable: true,
12008
- type: 'string',
12009
- },
12010
- phone_number: { nullable: true, type: 'string' },
12011
- user_identity_id: { format: 'uuid', type: 'string' },
12012
- user_identity_key: {
12013
- minLength: 1,
12014
- nullable: true,
12015
- type: 'string',
12016
- },
12017
- workspace_id: { format: 'uuid', type: 'string' },
12018
- },
12019
- required: [
12020
- 'user_identity_id',
12021
- 'user_identity_key',
12022
- 'email_address',
12023
- 'phone_number',
12024
- 'display_name',
12025
- 'full_name',
12026
- 'created_at',
12027
- 'workspace_id',
12028
- ],
12029
- type: 'object',
12030
- },
11060
+ items: { $ref: '#/components/schemas/user_identity' },
12031
11061
  type: 'array',
12032
11062
  },
12033
11063
  },
@@ -12077,12 +11107,18 @@ export default {
12077
11107
  schema: {
12078
11108
  properties: {
12079
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: {
12080
11116
  items: { $ref: '#/components/schemas/device' },
12081
11117
  type: 'array',
12082
11118
  },
12083
11119
  ok: { type: 'boolean' },
12084
11120
  },
12085
- required: ['accessible_devices', 'ok'],
11121
+ required: ['devices', 'accessible_devices', 'ok'],
12086
11122
  type: 'object',
12087
11123
  },
12088
11124
  },
@@ -12101,6 +11137,7 @@ export default {
12101
11137
  tags: ['/user_identities'],
12102
11138
  'x-fern-sdk-group-name': ['user_identities'],
12103
11139
  'x-fern-sdk-method-name': 'list_accessible_devices',
11140
+ 'x-fern-sdk-return-value': 'devices',
12104
11141
  },
12105
11142
  },
12106
11143
  '/user_identities/list_acs_systems': {
@@ -12151,6 +11188,7 @@ export default {
12151
11188
  tags: ['/user_identities'],
12152
11189
  'x-fern-sdk-group-name': ['user_identities'],
12153
11190
  'x-fern-sdk-method-name': 'list_acs_systems',
11191
+ 'x-fern-sdk-return-value': 'acs_systems',
12154
11192
  },
12155
11193
  },
12156
11194
  '/user_identities/list_acs_users': {
@@ -12200,6 +11238,7 @@ export default {
12200
11238
  tags: ['/user_identities'],
12201
11239
  'x-fern-sdk-group-name': ['user_identities'],
12202
11240
  'x-fern-sdk-method-name': 'list_acs_users',
11241
+ 'x-fern-sdk-return-value': 'acs_users',
12203
11242
  },
12204
11243
  },
12205
11244
  '/user_identities/remove_acs_user': {
@@ -12740,6 +11779,7 @@ export default {
12740
11779
  tags: ['/workspaces'],
12741
11780
  'x-fern-sdk-group-name': ['workspaces'],
12742
11781
  'x-fern-sdk-method-name': 'create',
11782
+ 'x-fern-sdk-return-value': 'workspace',
12743
11783
  },
12744
11784
  },
12745
11785
  '/workspaces/get': {