@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.
@@ -254,6 +254,7 @@ export default {
254
254
  },
255
255
  external_type_display_name: { type: 'string' },
256
256
  is_latest_desired_state_synced_with_provider: { type: 'boolean' },
257
+ is_managed: { enum: [true], type: 'boolean' },
257
258
  is_multi_phone_sync_credential: { type: 'boolean' },
258
259
  latest_desired_state_synced_with_provider_at: {
259
260
  format: 'date-time',
@@ -264,14 +265,17 @@ export default {
264
265
  visionline_metadata: {
265
266
  properties: {
266
267
  card_function_type: { enum: ['guest', 'staff'], type: 'string' },
268
+ card_id: { type: 'string' },
267
269
  common_acs_entrance_ids: {
268
270
  items: { format: 'uuid', type: 'string' },
269
271
  type: 'array',
270
272
  },
273
+ credential_id: { type: 'string' },
271
274
  guest_acs_entrance_ids: {
272
275
  items: { format: 'uuid', type: 'string' },
273
276
  type: 'array',
274
277
  },
278
+ is_valid: { type: 'boolean' },
275
279
  joiner_acs_credential_ids: {
276
280
  items: { format: 'uuid', type: 'string' },
277
281
  type: 'array',
@@ -302,6 +306,7 @@ export default {
302
306
  'workspace_id',
303
307
  'errors',
304
308
  'warnings',
309
+ 'is_managed',
305
310
  ],
306
311
  type: 'object',
307
312
  },
@@ -662,6 +667,7 @@ export default {
662
667
  full_name: { type: 'string' },
663
668
  hid_acs_system_id: { format: 'uuid', type: 'string' },
664
669
  is_latest_desired_state_synced_with_provider: { type: 'boolean' },
670
+ is_managed: { enum: [true], type: 'boolean' },
665
671
  is_suspended: { type: 'boolean' },
666
672
  latest_desired_state_synced_with_provider_at: {
667
673
  format: 'date-time',
@@ -694,6 +700,7 @@ export default {
694
700
  'display_name',
695
701
  'is_suspended',
696
702
  'warnings',
703
+ 'is_managed',
697
704
  ],
698
705
  type: 'object',
699
706
  },
@@ -6002,6 +6009,335 @@ export default {
6002
6009
  'x-fern-sdk-method-name': 'unassign',
6003
6010
  },
6004
6011
  },
6012
+ '/acs/credentials/unmanaged/get': {
6013
+ post: {
6014
+ operationId: 'acsCredentialsUnmanagedGetPost',
6015
+ requestBody: {
6016
+ content: {
6017
+ 'application/json': {
6018
+ schema: {
6019
+ properties: {
6020
+ acs_credential_id: { format: 'uuid', type: 'string' },
6021
+ },
6022
+ required: ['acs_credential_id'],
6023
+ type: 'object',
6024
+ },
6025
+ },
6026
+ },
6027
+ },
6028
+ responses: {
6029
+ 200: {
6030
+ content: {
6031
+ 'application/json': {
6032
+ schema: {
6033
+ properties: {
6034
+ acs_credential: {
6035
+ properties: {
6036
+ access_method: {
6037
+ enum: ['code', 'card', 'mobile_key'],
6038
+ type: 'string',
6039
+ },
6040
+ acs_credential_id: { format: 'uuid', type: 'string' },
6041
+ acs_credential_pool_id: {
6042
+ format: 'uuid',
6043
+ type: 'string',
6044
+ },
6045
+ acs_system_id: { format: 'uuid', type: 'string' },
6046
+ acs_user_id: { format: 'uuid', type: 'string' },
6047
+ code: { nullable: true, type: 'string' },
6048
+ created_at: { format: 'date-time', type: 'string' },
6049
+ display_name: { minLength: 1, type: 'string' },
6050
+ ends_at: { type: 'string' },
6051
+ errors: {
6052
+ items: {
6053
+ properties: {
6054
+ error_code: { type: 'string' },
6055
+ message: { type: 'string' },
6056
+ },
6057
+ required: ['error_code', 'message'],
6058
+ type: 'object',
6059
+ },
6060
+ type: 'array',
6061
+ },
6062
+ external_type: {
6063
+ enum: [
6064
+ 'pti_card',
6065
+ 'brivo_credential',
6066
+ 'hid_credential',
6067
+ 'visionline_card',
6068
+ 'salto_ks_credential',
6069
+ ],
6070
+ type: 'string',
6071
+ },
6072
+ external_type_display_name: { type: 'string' },
6073
+ is_latest_desired_state_synced_with_provider: {
6074
+ type: 'boolean',
6075
+ },
6076
+ is_managed: { enum: [false], type: 'boolean' },
6077
+ is_multi_phone_sync_credential: { type: 'boolean' },
6078
+ latest_desired_state_synced_with_provider_at: {
6079
+ format: 'date-time',
6080
+ type: 'string',
6081
+ },
6082
+ parent_acs_credential_id: {
6083
+ format: 'uuid',
6084
+ type: 'string',
6085
+ },
6086
+ starts_at: { type: 'string' },
6087
+ visionline_metadata: {
6088
+ properties: {
6089
+ card_function_type: {
6090
+ enum: ['guest', 'staff'],
6091
+ type: 'string',
6092
+ },
6093
+ card_id: { type: 'string' },
6094
+ common_acs_entrance_ids: {
6095
+ items: { format: 'uuid', type: 'string' },
6096
+ type: 'array',
6097
+ },
6098
+ credential_id: { type: 'string' },
6099
+ guest_acs_entrance_ids: {
6100
+ items: { format: 'uuid', type: 'string' },
6101
+ type: 'array',
6102
+ },
6103
+ is_valid: { type: 'boolean' },
6104
+ joiner_acs_credential_ids: {
6105
+ items: { format: 'uuid', type: 'string' },
6106
+ type: 'array',
6107
+ },
6108
+ },
6109
+ required: ['card_function_type'],
6110
+ type: 'object',
6111
+ },
6112
+ warnings: {
6113
+ items: {
6114
+ properties: {
6115
+ message: { type: 'string' },
6116
+ warning_code: { type: 'string' },
6117
+ },
6118
+ required: ['warning_code', 'message'],
6119
+ type: 'object',
6120
+ },
6121
+ type: 'array',
6122
+ },
6123
+ workspace_id: { format: 'uuid', type: 'string' },
6124
+ },
6125
+ required: [
6126
+ 'acs_credential_id',
6127
+ 'acs_system_id',
6128
+ 'display_name',
6129
+ 'access_method',
6130
+ 'created_at',
6131
+ 'workspace_id',
6132
+ 'errors',
6133
+ 'warnings',
6134
+ 'is_managed',
6135
+ ],
6136
+ type: 'object',
6137
+ },
6138
+ ok: { type: 'boolean' },
6139
+ },
6140
+ required: ['acs_credential', 'ok'],
6141
+ type: 'object',
6142
+ },
6143
+ },
6144
+ },
6145
+ description: 'OK',
6146
+ },
6147
+ 400: { description: 'Bad Request' },
6148
+ 401: { description: 'Unauthorized' },
6149
+ },
6150
+ security: [
6151
+ { pat_with_workspace: [] },
6152
+ { console_session: [] },
6153
+ { api_key: [] },
6154
+ ],
6155
+ summary: '/acs/credentials/unmanaged/get',
6156
+ tags: ['/acs'],
6157
+ 'x-fern-sdk-group-name': ['acs', 'credentials', 'unmanaged'],
6158
+ 'x-fern-sdk-method-name': 'get',
6159
+ 'x-fern-sdk-return-value': 'acs_credential',
6160
+ },
6161
+ },
6162
+ '/acs/credentials/unmanaged/list': {
6163
+ post: {
6164
+ operationId: 'acsCredentialsUnmanagedListPost',
6165
+ requestBody: {
6166
+ content: {
6167
+ 'application/json': {
6168
+ schema: {
6169
+ oneOf: [
6170
+ {
6171
+ properties: {
6172
+ acs_user_id: { format: 'uuid', type: 'string' },
6173
+ },
6174
+ required: ['acs_user_id'],
6175
+ type: 'object',
6176
+ },
6177
+ {
6178
+ properties: {
6179
+ acs_system_id: { format: 'uuid', type: 'string' },
6180
+ },
6181
+ required: ['acs_system_id'],
6182
+ type: 'object',
6183
+ },
6184
+ {
6185
+ properties: {
6186
+ acs_system_id: { format: 'uuid', type: 'string' },
6187
+ acs_user_id: { format: 'uuid', type: 'string' },
6188
+ },
6189
+ required: ['acs_user_id', 'acs_system_id'],
6190
+ type: 'object',
6191
+ },
6192
+ {
6193
+ properties: {
6194
+ user_identity_id: { format: 'uuid', type: 'string' },
6195
+ },
6196
+ required: ['user_identity_id'],
6197
+ type: 'object',
6198
+ },
6199
+ ],
6200
+ },
6201
+ },
6202
+ },
6203
+ },
6204
+ responses: {
6205
+ 200: {
6206
+ content: {
6207
+ 'application/json': {
6208
+ schema: {
6209
+ properties: {
6210
+ acs_credentials: {
6211
+ items: {
6212
+ properties: {
6213
+ access_method: {
6214
+ enum: ['code', 'card', 'mobile_key'],
6215
+ type: 'string',
6216
+ },
6217
+ acs_credential_id: { format: 'uuid', type: 'string' },
6218
+ acs_credential_pool_id: {
6219
+ format: 'uuid',
6220
+ type: 'string',
6221
+ },
6222
+ acs_system_id: { format: 'uuid', type: 'string' },
6223
+ acs_user_id: { format: 'uuid', type: 'string' },
6224
+ code: { nullable: true, type: 'string' },
6225
+ created_at: { format: 'date-time', type: 'string' },
6226
+ display_name: { minLength: 1, type: 'string' },
6227
+ ends_at: { type: 'string' },
6228
+ errors: {
6229
+ items: {
6230
+ properties: {
6231
+ error_code: { type: 'string' },
6232
+ message: { type: 'string' },
6233
+ },
6234
+ required: ['error_code', 'message'],
6235
+ type: 'object',
6236
+ },
6237
+ type: 'array',
6238
+ },
6239
+ external_type: {
6240
+ enum: [
6241
+ 'pti_card',
6242
+ 'brivo_credential',
6243
+ 'hid_credential',
6244
+ 'visionline_card',
6245
+ 'salto_ks_credential',
6246
+ ],
6247
+ type: 'string',
6248
+ },
6249
+ external_type_display_name: { type: 'string' },
6250
+ is_latest_desired_state_synced_with_provider: {
6251
+ type: 'boolean',
6252
+ },
6253
+ is_managed: { enum: [false], type: 'boolean' },
6254
+ is_multi_phone_sync_credential: { type: 'boolean' },
6255
+ latest_desired_state_synced_with_provider_at: {
6256
+ format: 'date-time',
6257
+ type: 'string',
6258
+ },
6259
+ parent_acs_credential_id: {
6260
+ format: 'uuid',
6261
+ type: 'string',
6262
+ },
6263
+ starts_at: { type: 'string' },
6264
+ visionline_metadata: {
6265
+ properties: {
6266
+ card_function_type: {
6267
+ enum: ['guest', 'staff'],
6268
+ type: 'string',
6269
+ },
6270
+ card_id: { type: 'string' },
6271
+ common_acs_entrance_ids: {
6272
+ items: { format: 'uuid', type: 'string' },
6273
+ type: 'array',
6274
+ },
6275
+ credential_id: { type: 'string' },
6276
+ guest_acs_entrance_ids: {
6277
+ items: { format: 'uuid', type: 'string' },
6278
+ type: 'array',
6279
+ },
6280
+ is_valid: { type: 'boolean' },
6281
+ joiner_acs_credential_ids: {
6282
+ items: { format: 'uuid', type: 'string' },
6283
+ type: 'array',
6284
+ },
6285
+ },
6286
+ required: ['card_function_type'],
6287
+ type: 'object',
6288
+ },
6289
+ warnings: {
6290
+ items: {
6291
+ properties: {
6292
+ message: { type: 'string' },
6293
+ warning_code: { type: 'string' },
6294
+ },
6295
+ required: ['warning_code', 'message'],
6296
+ type: 'object',
6297
+ },
6298
+ type: 'array',
6299
+ },
6300
+ workspace_id: { format: 'uuid', type: 'string' },
6301
+ },
6302
+ required: [
6303
+ 'acs_credential_id',
6304
+ 'acs_system_id',
6305
+ 'display_name',
6306
+ 'access_method',
6307
+ 'created_at',
6308
+ 'workspace_id',
6309
+ 'errors',
6310
+ 'warnings',
6311
+ 'is_managed',
6312
+ ],
6313
+ type: 'object',
6314
+ },
6315
+ type: 'array',
6316
+ },
6317
+ ok: { type: 'boolean' },
6318
+ },
6319
+ required: ['acs_credentials', 'ok'],
6320
+ type: 'object',
6321
+ },
6322
+ },
6323
+ },
6324
+ description: 'OK',
6325
+ },
6326
+ 400: { description: 'Bad Request' },
6327
+ 401: { description: 'Unauthorized' },
6328
+ },
6329
+ security: [
6330
+ { api_key: [] },
6331
+ { pat_with_workspace: [] },
6332
+ { console_session: [] },
6333
+ ],
6334
+ summary: '/acs/credentials/unmanaged/list',
6335
+ tags: ['/acs'],
6336
+ 'x-fern-sdk-group-name': ['acs', 'credentials', 'unmanaged'],
6337
+ 'x-fern-sdk-method-name': 'list',
6338
+ 'x-fern-sdk-return-value': 'acs_credentials',
6339
+ },
6340
+ },
6005
6341
  '/acs/credentials/update': {
6006
6342
  patch: {
6007
6343
  operationId: 'acsCredentialsUpdatePatch',
@@ -6993,8 +7329,11 @@ export default {
6993
7329
  schema: {
6994
7330
  properties: {
6995
7331
  acs_system_id: { format: 'uuid', type: 'string' },
7332
+ limit: { default: 500, format: 'float', type: 'number' },
7333
+ user_identity_email_address: { type: 'string' },
7334
+ user_identity_id: { format: 'uuid', type: 'string' },
7335
+ user_identity_phone_number: { type: 'string' },
6996
7336
  },
6997
- required: ['acs_system_id'],
6998
7337
  type: 'object',
6999
7338
  },
7000
7339
  },
@@ -7007,7 +7346,102 @@ export default {
7007
7346
  schema: {
7008
7347
  properties: {
7009
7348
  acs_users: {
7010
- items: { $ref: '#/components/schemas/acs_user' },
7349
+ items: {
7350
+ properties: {
7351
+ access_schedule: {
7352
+ properties: {
7353
+ ends_at: { format: 'date-time', type: 'string' },
7354
+ starts_at: {
7355
+ format: 'date-time',
7356
+ type: 'string',
7357
+ },
7358
+ },
7359
+ required: ['starts_at', 'ends_at'],
7360
+ type: 'object',
7361
+ },
7362
+ acs_system_id: { format: 'uuid', type: 'string' },
7363
+ acs_user_id: { format: 'uuid', type: 'string' },
7364
+ created_at: { format: 'date-time', type: 'string' },
7365
+ display_name: { type: 'string' },
7366
+ email: {
7367
+ deprecated: true,
7368
+ format: 'email',
7369
+ type: 'string',
7370
+ 'x-deprecated': 'use email_address.',
7371
+ },
7372
+ email_address: { format: 'email', type: 'string' },
7373
+ external_type: {
7374
+ enum: [
7375
+ 'pti_user',
7376
+ 'brivo_user',
7377
+ 'hid_credential_manager_user',
7378
+ 'salto_site_user',
7379
+ 'latch_user',
7380
+ ],
7381
+ type: 'string',
7382
+ },
7383
+ external_type_display_name: { type: 'string' },
7384
+ full_name: { type: 'string' },
7385
+ hid_acs_system_id: { format: 'uuid', type: 'string' },
7386
+ is_latest_desired_state_synced_with_provider: {
7387
+ type: 'boolean',
7388
+ },
7389
+ is_managed: { enum: [false], type: 'boolean' },
7390
+ is_suspended: { type: 'boolean' },
7391
+ latest_desired_state_synced_with_provider_at: {
7392
+ format: 'date-time',
7393
+ type: 'string',
7394
+ },
7395
+ phone_number: { type: 'string' },
7396
+ user_identity_email_address: {
7397
+ nullable: true,
7398
+ type: 'string',
7399
+ },
7400
+ user_identity_full_name: {
7401
+ nullable: true,
7402
+ type: 'string',
7403
+ },
7404
+ user_identity_id: { type: 'string' },
7405
+ user_identity_phone_number: {
7406
+ nullable: true,
7407
+ type: 'string',
7408
+ },
7409
+ warnings: {
7410
+ items: {
7411
+ properties: {
7412
+ created_at: {
7413
+ format: 'date-time',
7414
+ type: 'string',
7415
+ },
7416
+ message: { type: 'string' },
7417
+ warning_code: {
7418
+ enum: ['being_deleted'],
7419
+ type: 'string',
7420
+ },
7421
+ },
7422
+ required: [
7423
+ 'created_at',
7424
+ 'message',
7425
+ 'warning_code',
7426
+ ],
7427
+ type: 'object',
7428
+ },
7429
+ type: 'array',
7430
+ },
7431
+ workspace_id: { format: 'uuid', type: 'string' },
7432
+ },
7433
+ required: [
7434
+ 'acs_user_id',
7435
+ 'acs_system_id',
7436
+ 'workspace_id',
7437
+ 'created_at',
7438
+ 'display_name',
7439
+ 'is_suspended',
7440
+ 'warnings',
7441
+ 'is_managed',
7442
+ ],
7443
+ type: 'object',
7444
+ },
7011
7445
  type: 'array',
7012
7446
  },
7013
7447
  ok: { type: 'boolean' },
@@ -7023,7 +7457,6 @@ export default {
7023
7457
  401: { description: 'Unauthorized' },
7024
7458
  },
7025
7459
  security: [
7026
- { client_session: [] },
7027
7460
  { pat_with_workspace: [] },
7028
7461
  { console_session: [] },
7029
7462
  { api_key: [] },