@seamapi/types 1.233.0 → 1.234.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -271,6 +271,7 @@ export default {
271
271
  },
272
272
  external_type_display_name: { type: 'string' },
273
273
  is_latest_desired_state_synced_with_provider: { type: 'boolean' },
274
+ is_managed: { enum: [true], type: 'boolean' },
274
275
  is_multi_phone_sync_credential: { type: 'boolean' },
275
276
  latest_desired_state_synced_with_provider_at: {
276
277
  format: 'date-time',
@@ -281,14 +282,17 @@ export default {
281
282
  visionline_metadata: {
282
283
  properties: {
283
284
  card_function_type: { enum: ['guest', 'staff'], type: 'string' },
285
+ card_id: { type: 'string' },
284
286
  common_acs_entrance_ids: {
285
287
  items: { format: 'uuid', type: 'string' },
286
288
  type: 'array',
287
289
  },
290
+ credential_id: { type: 'string' },
288
291
  guest_acs_entrance_ids: {
289
292
  items: { format: 'uuid', type: 'string' },
290
293
  type: 'array',
291
294
  },
295
+ is_valid: { type: 'boolean' },
292
296
  joiner_acs_credential_ids: {
293
297
  items: { format: 'uuid', type: 'string' },
294
298
  type: 'array',
@@ -319,6 +323,7 @@ export default {
319
323
  'workspace_id',
320
324
  'errors',
321
325
  'warnings',
326
+ 'is_managed',
322
327
  ],
323
328
  type: 'object',
324
329
  },
@@ -702,6 +707,7 @@ export default {
702
707
  full_name: { type: 'string' },
703
708
  hid_acs_system_id: { format: 'uuid', type: 'string' },
704
709
  is_latest_desired_state_synced_with_provider: { type: 'boolean' },
710
+ is_managed: { enum: [true], type: 'boolean' },
705
711
  is_suspended: { type: 'boolean' },
706
712
  latest_desired_state_synced_with_provider_at: {
707
713
  format: 'date-time',
@@ -734,6 +740,7 @@ export default {
734
740
  'display_name',
735
741
  'is_suspended',
736
742
  'warnings',
743
+ 'is_managed',
737
744
  ],
738
745
  type: 'object',
739
746
  },
@@ -6104,6 +6111,335 @@ export default {
6104
6111
  'x-fern-sdk-method-name': 'unassign',
6105
6112
  },
6106
6113
  },
6114
+ '/acs/credentials/unmanaged/get': {
6115
+ post: {
6116
+ operationId: 'acsCredentialsUnmanagedGetPost',
6117
+ requestBody: {
6118
+ content: {
6119
+ 'application/json': {
6120
+ schema: {
6121
+ properties: {
6122
+ acs_credential_id: { format: 'uuid', type: 'string' },
6123
+ },
6124
+ required: ['acs_credential_id'],
6125
+ type: 'object',
6126
+ },
6127
+ },
6128
+ },
6129
+ },
6130
+ responses: {
6131
+ 200: {
6132
+ content: {
6133
+ 'application/json': {
6134
+ schema: {
6135
+ properties: {
6136
+ acs_credential: {
6137
+ properties: {
6138
+ access_method: {
6139
+ enum: ['code', 'card', 'mobile_key'],
6140
+ type: 'string',
6141
+ },
6142
+ acs_credential_id: { format: 'uuid', type: 'string' },
6143
+ acs_credential_pool_id: {
6144
+ format: 'uuid',
6145
+ type: 'string',
6146
+ },
6147
+ acs_system_id: { format: 'uuid', type: 'string' },
6148
+ acs_user_id: { format: 'uuid', type: 'string' },
6149
+ code: { nullable: true, type: 'string' },
6150
+ created_at: { format: 'date-time', type: 'string' },
6151
+ display_name: { minLength: 1, type: 'string' },
6152
+ ends_at: { type: 'string' },
6153
+ errors: {
6154
+ items: {
6155
+ properties: {
6156
+ error_code: { type: 'string' },
6157
+ message: { type: 'string' },
6158
+ },
6159
+ required: ['error_code', 'message'],
6160
+ type: 'object',
6161
+ },
6162
+ type: 'array',
6163
+ },
6164
+ external_type: {
6165
+ enum: [
6166
+ 'pti_card',
6167
+ 'brivo_credential',
6168
+ 'hid_credential',
6169
+ 'visionline_card',
6170
+ 'salto_ks_credential',
6171
+ ],
6172
+ type: 'string',
6173
+ },
6174
+ external_type_display_name: { type: 'string' },
6175
+ is_latest_desired_state_synced_with_provider: {
6176
+ type: 'boolean',
6177
+ },
6178
+ is_managed: { enum: [false], type: 'boolean' },
6179
+ is_multi_phone_sync_credential: { type: 'boolean' },
6180
+ latest_desired_state_synced_with_provider_at: {
6181
+ format: 'date-time',
6182
+ type: 'string',
6183
+ },
6184
+ parent_acs_credential_id: {
6185
+ format: 'uuid',
6186
+ type: 'string',
6187
+ },
6188
+ starts_at: { type: 'string' },
6189
+ visionline_metadata: {
6190
+ properties: {
6191
+ card_function_type: {
6192
+ enum: ['guest', 'staff'],
6193
+ type: 'string',
6194
+ },
6195
+ card_id: { type: 'string' },
6196
+ common_acs_entrance_ids: {
6197
+ items: { format: 'uuid', type: 'string' },
6198
+ type: 'array',
6199
+ },
6200
+ credential_id: { type: 'string' },
6201
+ guest_acs_entrance_ids: {
6202
+ items: { format: 'uuid', type: 'string' },
6203
+ type: 'array',
6204
+ },
6205
+ is_valid: { type: 'boolean' },
6206
+ joiner_acs_credential_ids: {
6207
+ items: { format: 'uuid', type: 'string' },
6208
+ type: 'array',
6209
+ },
6210
+ },
6211
+ required: ['card_function_type'],
6212
+ type: 'object',
6213
+ },
6214
+ warnings: {
6215
+ items: {
6216
+ properties: {
6217
+ message: { type: 'string' },
6218
+ warning_code: { type: 'string' },
6219
+ },
6220
+ required: ['warning_code', 'message'],
6221
+ type: 'object',
6222
+ },
6223
+ type: 'array',
6224
+ },
6225
+ workspace_id: { format: 'uuid', type: 'string' },
6226
+ },
6227
+ required: [
6228
+ 'acs_credential_id',
6229
+ 'acs_system_id',
6230
+ 'display_name',
6231
+ 'access_method',
6232
+ 'created_at',
6233
+ 'workspace_id',
6234
+ 'errors',
6235
+ 'warnings',
6236
+ 'is_managed',
6237
+ ],
6238
+ type: 'object',
6239
+ },
6240
+ ok: { type: 'boolean' },
6241
+ },
6242
+ required: ['acs_credential', 'ok'],
6243
+ type: 'object',
6244
+ },
6245
+ },
6246
+ },
6247
+ description: 'OK',
6248
+ },
6249
+ 400: { description: 'Bad Request' },
6250
+ 401: { description: 'Unauthorized' },
6251
+ },
6252
+ security: [
6253
+ { pat_with_workspace: [] },
6254
+ { console_session: [] },
6255
+ { api_key: [] },
6256
+ ],
6257
+ summary: '/acs/credentials/unmanaged/get',
6258
+ tags: ['/acs'],
6259
+ 'x-fern-sdk-group-name': ['acs', 'credentials', 'unmanaged'],
6260
+ 'x-fern-sdk-method-name': 'get',
6261
+ 'x-fern-sdk-return-value': 'acs_credential',
6262
+ },
6263
+ },
6264
+ '/acs/credentials/unmanaged/list': {
6265
+ post: {
6266
+ operationId: 'acsCredentialsUnmanagedListPost',
6267
+ requestBody: {
6268
+ content: {
6269
+ 'application/json': {
6270
+ schema: {
6271
+ oneOf: [
6272
+ {
6273
+ properties: {
6274
+ acs_user_id: { format: 'uuid', type: 'string' },
6275
+ },
6276
+ required: ['acs_user_id'],
6277
+ type: 'object',
6278
+ },
6279
+ {
6280
+ properties: {
6281
+ acs_system_id: { format: 'uuid', type: 'string' },
6282
+ },
6283
+ required: ['acs_system_id'],
6284
+ type: 'object',
6285
+ },
6286
+ {
6287
+ properties: {
6288
+ acs_system_id: { format: 'uuid', type: 'string' },
6289
+ acs_user_id: { format: 'uuid', type: 'string' },
6290
+ },
6291
+ required: ['acs_user_id', 'acs_system_id'],
6292
+ type: 'object',
6293
+ },
6294
+ {
6295
+ properties: {
6296
+ user_identity_id: { format: 'uuid', type: 'string' },
6297
+ },
6298
+ required: ['user_identity_id'],
6299
+ type: 'object',
6300
+ },
6301
+ ],
6302
+ },
6303
+ },
6304
+ },
6305
+ },
6306
+ responses: {
6307
+ 200: {
6308
+ content: {
6309
+ 'application/json': {
6310
+ schema: {
6311
+ properties: {
6312
+ acs_credentials: {
6313
+ items: {
6314
+ properties: {
6315
+ access_method: {
6316
+ enum: ['code', 'card', 'mobile_key'],
6317
+ type: 'string',
6318
+ },
6319
+ acs_credential_id: { format: 'uuid', type: 'string' },
6320
+ acs_credential_pool_id: {
6321
+ format: 'uuid',
6322
+ type: 'string',
6323
+ },
6324
+ acs_system_id: { format: 'uuid', type: 'string' },
6325
+ acs_user_id: { format: 'uuid', type: 'string' },
6326
+ code: { nullable: true, type: 'string' },
6327
+ created_at: { format: 'date-time', type: 'string' },
6328
+ display_name: { minLength: 1, type: 'string' },
6329
+ ends_at: { type: 'string' },
6330
+ errors: {
6331
+ items: {
6332
+ properties: {
6333
+ error_code: { type: 'string' },
6334
+ message: { type: 'string' },
6335
+ },
6336
+ required: ['error_code', 'message'],
6337
+ type: 'object',
6338
+ },
6339
+ type: 'array',
6340
+ },
6341
+ external_type: {
6342
+ enum: [
6343
+ 'pti_card',
6344
+ 'brivo_credential',
6345
+ 'hid_credential',
6346
+ 'visionline_card',
6347
+ 'salto_ks_credential',
6348
+ ],
6349
+ type: 'string',
6350
+ },
6351
+ external_type_display_name: { type: 'string' },
6352
+ is_latest_desired_state_synced_with_provider: {
6353
+ type: 'boolean',
6354
+ },
6355
+ is_managed: { enum: [false], type: 'boolean' },
6356
+ is_multi_phone_sync_credential: { type: 'boolean' },
6357
+ latest_desired_state_synced_with_provider_at: {
6358
+ format: 'date-time',
6359
+ type: 'string',
6360
+ },
6361
+ parent_acs_credential_id: {
6362
+ format: 'uuid',
6363
+ type: 'string',
6364
+ },
6365
+ starts_at: { type: 'string' },
6366
+ visionline_metadata: {
6367
+ properties: {
6368
+ card_function_type: {
6369
+ enum: ['guest', 'staff'],
6370
+ type: 'string',
6371
+ },
6372
+ card_id: { type: 'string' },
6373
+ common_acs_entrance_ids: {
6374
+ items: { format: 'uuid', type: 'string' },
6375
+ type: 'array',
6376
+ },
6377
+ credential_id: { type: 'string' },
6378
+ guest_acs_entrance_ids: {
6379
+ items: { format: 'uuid', type: 'string' },
6380
+ type: 'array',
6381
+ },
6382
+ is_valid: { type: 'boolean' },
6383
+ joiner_acs_credential_ids: {
6384
+ items: { format: 'uuid', type: 'string' },
6385
+ type: 'array',
6386
+ },
6387
+ },
6388
+ required: ['card_function_type'],
6389
+ type: 'object',
6390
+ },
6391
+ warnings: {
6392
+ items: {
6393
+ properties: {
6394
+ message: { type: 'string' },
6395
+ warning_code: { type: 'string' },
6396
+ },
6397
+ required: ['warning_code', 'message'],
6398
+ type: 'object',
6399
+ },
6400
+ type: 'array',
6401
+ },
6402
+ workspace_id: { format: 'uuid', type: 'string' },
6403
+ },
6404
+ required: [
6405
+ 'acs_credential_id',
6406
+ 'acs_system_id',
6407
+ 'display_name',
6408
+ 'access_method',
6409
+ 'created_at',
6410
+ 'workspace_id',
6411
+ 'errors',
6412
+ 'warnings',
6413
+ 'is_managed',
6414
+ ],
6415
+ type: 'object',
6416
+ },
6417
+ type: 'array',
6418
+ },
6419
+ ok: { type: 'boolean' },
6420
+ },
6421
+ required: ['acs_credentials', 'ok'],
6422
+ type: 'object',
6423
+ },
6424
+ },
6425
+ },
6426
+ description: 'OK',
6427
+ },
6428
+ 400: { description: 'Bad Request' },
6429
+ 401: { description: 'Unauthorized' },
6430
+ },
6431
+ security: [
6432
+ { api_key: [] },
6433
+ { pat_with_workspace: [] },
6434
+ { console_session: [] },
6435
+ ],
6436
+ summary: '/acs/credentials/unmanaged/list',
6437
+ tags: ['/acs'],
6438
+ 'x-fern-sdk-group-name': ['acs', 'credentials', 'unmanaged'],
6439
+ 'x-fern-sdk-method-name': 'list',
6440
+ 'x-fern-sdk-return-value': 'acs_credentials',
6441
+ },
6442
+ },
6107
6443
  '/acs/credentials/update': {
6108
6444
  patch: {
6109
6445
  operationId: 'acsCredentialsUpdatePatch',
@@ -7101,8 +7437,11 @@ export default {
7101
7437
  schema: {
7102
7438
  properties: {
7103
7439
  acs_system_id: { format: 'uuid', type: 'string' },
7440
+ limit: { default: 500, format: 'float', type: 'number' },
7441
+ user_identity_email_address: { type: 'string' },
7442
+ user_identity_id: { format: 'uuid', type: 'string' },
7443
+ user_identity_phone_number: { type: 'string' },
7104
7444
  },
7105
- required: ['acs_system_id'],
7106
7445
  type: 'object',
7107
7446
  },
7108
7447
  },
@@ -7115,7 +7454,102 @@ export default {
7115
7454
  schema: {
7116
7455
  properties: {
7117
7456
  acs_users: {
7118
- items: { $ref: '#/components/schemas/acs_user' },
7457
+ items: {
7458
+ properties: {
7459
+ access_schedule: {
7460
+ properties: {
7461
+ ends_at: { format: 'date-time', type: 'string' },
7462
+ starts_at: {
7463
+ format: 'date-time',
7464
+ type: 'string',
7465
+ },
7466
+ },
7467
+ required: ['starts_at', 'ends_at'],
7468
+ type: 'object',
7469
+ },
7470
+ acs_system_id: { format: 'uuid', type: 'string' },
7471
+ acs_user_id: { format: 'uuid', type: 'string' },
7472
+ created_at: { format: 'date-time', type: 'string' },
7473
+ display_name: { type: 'string' },
7474
+ email: {
7475
+ deprecated: true,
7476
+ format: 'email',
7477
+ type: 'string',
7478
+ 'x-deprecated': 'use email_address.',
7479
+ },
7480
+ email_address: { format: 'email', type: 'string' },
7481
+ external_type: {
7482
+ enum: [
7483
+ 'pti_user',
7484
+ 'brivo_user',
7485
+ 'hid_credential_manager_user',
7486
+ 'salto_site_user',
7487
+ 'latch_user',
7488
+ ],
7489
+ type: 'string',
7490
+ },
7491
+ external_type_display_name: { type: 'string' },
7492
+ full_name: { type: 'string' },
7493
+ hid_acs_system_id: { format: 'uuid', type: 'string' },
7494
+ is_latest_desired_state_synced_with_provider: {
7495
+ type: 'boolean',
7496
+ },
7497
+ is_managed: { enum: [false], type: 'boolean' },
7498
+ is_suspended: { type: 'boolean' },
7499
+ latest_desired_state_synced_with_provider_at: {
7500
+ format: 'date-time',
7501
+ type: 'string',
7502
+ },
7503
+ phone_number: { type: 'string' },
7504
+ user_identity_email_address: {
7505
+ nullable: true,
7506
+ type: 'string',
7507
+ },
7508
+ user_identity_full_name: {
7509
+ nullable: true,
7510
+ type: 'string',
7511
+ },
7512
+ user_identity_id: { type: 'string' },
7513
+ user_identity_phone_number: {
7514
+ nullable: true,
7515
+ type: 'string',
7516
+ },
7517
+ warnings: {
7518
+ items: {
7519
+ properties: {
7520
+ created_at: {
7521
+ format: 'date-time',
7522
+ type: 'string',
7523
+ },
7524
+ message: { type: 'string' },
7525
+ warning_code: {
7526
+ enum: ['being_deleted'],
7527
+ type: 'string',
7528
+ },
7529
+ },
7530
+ required: [
7531
+ 'created_at',
7532
+ 'message',
7533
+ 'warning_code',
7534
+ ],
7535
+ type: 'object',
7536
+ },
7537
+ type: 'array',
7538
+ },
7539
+ workspace_id: { format: 'uuid', type: 'string' },
7540
+ },
7541
+ required: [
7542
+ 'acs_user_id',
7543
+ 'acs_system_id',
7544
+ 'workspace_id',
7545
+ 'created_at',
7546
+ 'display_name',
7547
+ 'is_suspended',
7548
+ 'warnings',
7549
+ 'is_managed',
7550
+ ],
7551
+ type: 'object',
7552
+ },
7119
7553
  type: 'array',
7120
7554
  },
7121
7555
  ok: { type: 'boolean' },
@@ -7131,7 +7565,6 @@ export default {
7131
7565
  401: { description: 'Unauthorized' },
7132
7566
  },
7133
7567
  security: [
7134
- { client_session: [] },
7135
7568
  { pat_with_workspace: [] },
7136
7569
  { console_session: [] },
7137
7570
  { api_key: [] },