@seamapi/types 1.792.0 → 1.794.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.
@@ -333,6 +333,200 @@ declare const _default: {
333
333
  nullable: boolean;
334
334
  type: string;
335
335
  };
336
+ pending_mutations: {
337
+ description: string;
338
+ items: {
339
+ discriminator: {
340
+ propertyName: string;
341
+ };
342
+ oneOf: ({
343
+ description: string;
344
+ properties: {
345
+ created_at: {
346
+ description: string;
347
+ format: string;
348
+ type: string;
349
+ };
350
+ message: {
351
+ description: string;
352
+ type: string;
353
+ };
354
+ mutation_code: {
355
+ description: string;
356
+ enum: string[];
357
+ type: string;
358
+ };
359
+ from?: never;
360
+ to?: never;
361
+ };
362
+ required: string[];
363
+ type: string;
364
+ } | {
365
+ description: string;
366
+ properties: {
367
+ created_at: {
368
+ description: string;
369
+ format: string;
370
+ type: string;
371
+ };
372
+ from: {
373
+ description: string;
374
+ properties: {
375
+ code: {
376
+ description: string;
377
+ nullable: boolean;
378
+ type: string;
379
+ };
380
+ name?: never;
381
+ ends_at?: never;
382
+ starts_at?: never;
383
+ };
384
+ required: string[];
385
+ type: string;
386
+ };
387
+ message: {
388
+ description: string;
389
+ type: string;
390
+ };
391
+ mutation_code: {
392
+ description: string;
393
+ enum: string[];
394
+ type: string;
395
+ };
396
+ to: {
397
+ description: string;
398
+ properties: {
399
+ code: {
400
+ description: string;
401
+ nullable: boolean;
402
+ type: string;
403
+ };
404
+ name?: never;
405
+ ends_at?: never;
406
+ starts_at?: never;
407
+ };
408
+ required: string[];
409
+ type: string;
410
+ };
411
+ };
412
+ required: string[];
413
+ type: string;
414
+ } | {
415
+ description: string;
416
+ properties: {
417
+ created_at: {
418
+ description: string;
419
+ format: string;
420
+ type: string;
421
+ };
422
+ from: {
423
+ description: string;
424
+ properties: {
425
+ name: {
426
+ description: string;
427
+ nullable: boolean;
428
+ type: string;
429
+ };
430
+ code?: never;
431
+ ends_at?: never;
432
+ starts_at?: never;
433
+ };
434
+ required: string[];
435
+ type: string;
436
+ };
437
+ message: {
438
+ description: string;
439
+ type: string;
440
+ };
441
+ mutation_code: {
442
+ description: string;
443
+ enum: string[];
444
+ type: string;
445
+ };
446
+ to: {
447
+ description: string;
448
+ properties: {
449
+ name: {
450
+ description: string;
451
+ nullable: boolean;
452
+ type: string;
453
+ };
454
+ code?: never;
455
+ ends_at?: never;
456
+ starts_at?: never;
457
+ };
458
+ required: string[];
459
+ type: string;
460
+ };
461
+ };
462
+ required: string[];
463
+ type: string;
464
+ } | {
465
+ description: string;
466
+ properties: {
467
+ created_at: {
468
+ description: string;
469
+ format: string;
470
+ type: string;
471
+ };
472
+ from: {
473
+ description: string;
474
+ properties: {
475
+ ends_at: {
476
+ description: string;
477
+ format: string;
478
+ nullable: boolean;
479
+ type: string;
480
+ };
481
+ starts_at: {
482
+ description: string;
483
+ format: string;
484
+ nullable: boolean;
485
+ type: string;
486
+ };
487
+ code?: never;
488
+ name?: never;
489
+ };
490
+ required: string[];
491
+ type: string;
492
+ };
493
+ message: {
494
+ description: string;
495
+ type: string;
496
+ };
497
+ mutation_code: {
498
+ description: string;
499
+ enum: string[];
500
+ type: string;
501
+ };
502
+ to: {
503
+ description: string;
504
+ properties: {
505
+ ends_at: {
506
+ description: string;
507
+ format: string;
508
+ nullable: boolean;
509
+ type: string;
510
+ };
511
+ starts_at: {
512
+ description: string;
513
+ format: string;
514
+ nullable: boolean;
515
+ type: string;
516
+ };
517
+ code?: never;
518
+ name?: never;
519
+ };
520
+ required: string[];
521
+ type: string;
522
+ };
523
+ };
524
+ required: string[];
525
+ type: string;
526
+ })[];
527
+ };
528
+ type: string;
529
+ };
336
530
  pulled_backup_access_code_id: {
337
531
  description: string;
338
532
  format: string;
@@ -69053,15 +69247,23 @@ declare const _default: {
69053
69247
  };
69054
69248
  };
69055
69249
  security: ({
69250
+ client_session: never[];
69251
+ api_key?: never;
69252
+ pat_with_workspace?: never;
69253
+ console_session_with_workspace?: never;
69254
+ } | {
69056
69255
  api_key: never[];
69256
+ client_session?: never;
69057
69257
  pat_with_workspace?: never;
69058
69258
  console_session_with_workspace?: never;
69059
69259
  } | {
69060
69260
  pat_with_workspace: never[];
69261
+ client_session?: never;
69061
69262
  api_key?: never;
69062
69263
  console_session_with_workspace?: never;
69063
69264
  } | {
69064
69265
  console_session_with_workspace: never[];
69266
+ client_session?: never;
69065
69267
  api_key?: never;
69066
69268
  pat_with_workspace?: never;
69067
69269
  })[];
@@ -69132,15 +69334,23 @@ declare const _default: {
69132
69334
  };
69133
69335
  };
69134
69336
  security: ({
69337
+ client_session: never[];
69338
+ api_key?: never;
69339
+ pat_with_workspace?: never;
69340
+ console_session_with_workspace?: never;
69341
+ } | {
69135
69342
  api_key: never[];
69343
+ client_session?: never;
69136
69344
  pat_with_workspace?: never;
69137
69345
  console_session_with_workspace?: never;
69138
69346
  } | {
69139
69347
  pat_with_workspace: never[];
69348
+ client_session?: never;
69140
69349
  api_key?: never;
69141
69350
  console_session_with_workspace?: never;
69142
69351
  } | {
69143
69352
  console_session_with_workspace: never[];
69353
+ client_session?: never;
69144
69354
  api_key?: never;
69145
69355
  pat_with_workspace?: never;
69146
69356
  })[];
@@ -1187,6 +1187,224 @@ export default {
1187
1187
  nullable: true,
1188
1188
  type: 'string',
1189
1189
  },
1190
+ pending_mutations: {
1191
+ description: 'Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device.',
1192
+ items: {
1193
+ discriminator: { propertyName: 'mutation_code' },
1194
+ oneOf: [
1195
+ {
1196
+ description: 'Seam is in the process of setting an access code on the device.',
1197
+ properties: {
1198
+ created_at: {
1199
+ description: 'Date and time at which the mutation was created.',
1200
+ format: 'date-time',
1201
+ type: 'string',
1202
+ },
1203
+ message: {
1204
+ description: 'Detailed description of the mutation.',
1205
+ type: 'string',
1206
+ },
1207
+ mutation_code: {
1208
+ description: 'Mutation code to indicate that Seam is in the process of setting an access code on the device.',
1209
+ enum: ['creating'],
1210
+ type: 'string',
1211
+ },
1212
+ },
1213
+ required: ['created_at', 'message', 'mutation_code'],
1214
+ type: 'object',
1215
+ },
1216
+ {
1217
+ description: 'Seam is in the process of removing an access code from the device.',
1218
+ properties: {
1219
+ created_at: {
1220
+ description: 'Date and time at which the mutation was created.',
1221
+ format: 'date-time',
1222
+ type: 'string',
1223
+ },
1224
+ message: {
1225
+ description: 'Detailed description of the mutation.',
1226
+ type: 'string',
1227
+ },
1228
+ mutation_code: {
1229
+ description: 'Mutation code to indicate that Seam is in the process of removing an access code from the device.',
1230
+ enum: ['deleting'],
1231
+ type: 'string',
1232
+ },
1233
+ },
1234
+ required: ['created_at', 'message', 'mutation_code'],
1235
+ type: 'object',
1236
+ },
1237
+ {
1238
+ description: 'Seam is in the process of pushing an updated PIN code to the device.',
1239
+ properties: {
1240
+ created_at: {
1241
+ description: 'Date and time at which the mutation was created.',
1242
+ format: 'date-time',
1243
+ type: 'string',
1244
+ },
1245
+ from: {
1246
+ description: 'Previous code configuration.',
1247
+ properties: {
1248
+ code: {
1249
+ description: 'Previous PIN code.',
1250
+ nullable: true,
1251
+ type: 'string',
1252
+ },
1253
+ },
1254
+ required: ['code'],
1255
+ type: 'object',
1256
+ },
1257
+ message: {
1258
+ description: 'Detailed description of the mutation.',
1259
+ type: 'string',
1260
+ },
1261
+ mutation_code: {
1262
+ description: 'Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device.',
1263
+ enum: ['updating_code'],
1264
+ type: 'string',
1265
+ },
1266
+ to: {
1267
+ description: 'New code configuration.',
1268
+ properties: {
1269
+ code: {
1270
+ description: 'New PIN code.',
1271
+ nullable: true,
1272
+ type: 'string',
1273
+ },
1274
+ },
1275
+ required: ['code'],
1276
+ type: 'object',
1277
+ },
1278
+ },
1279
+ required: [
1280
+ 'created_at',
1281
+ 'message',
1282
+ 'mutation_code',
1283
+ 'from',
1284
+ 'to',
1285
+ ],
1286
+ type: 'object',
1287
+ },
1288
+ {
1289
+ description: 'Seam is in the process of pushing an updated access code name to the device.',
1290
+ properties: {
1291
+ created_at: {
1292
+ description: 'Date and time at which the mutation was created.',
1293
+ format: 'date-time',
1294
+ type: 'string',
1295
+ },
1296
+ from: {
1297
+ description: 'Previous name configuration.',
1298
+ properties: {
1299
+ name: {
1300
+ description: 'Previous access code name.',
1301
+ nullable: true,
1302
+ type: 'string',
1303
+ },
1304
+ },
1305
+ required: ['name'],
1306
+ type: 'object',
1307
+ },
1308
+ message: {
1309
+ description: 'Detailed description of the mutation.',
1310
+ type: 'string',
1311
+ },
1312
+ mutation_code: {
1313
+ description: 'Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device.',
1314
+ enum: ['updating_name'],
1315
+ type: 'string',
1316
+ },
1317
+ to: {
1318
+ description: 'New name configuration.',
1319
+ properties: {
1320
+ name: {
1321
+ description: 'New access code name.',
1322
+ nullable: true,
1323
+ type: 'string',
1324
+ },
1325
+ },
1326
+ required: ['name'],
1327
+ type: 'object',
1328
+ },
1329
+ },
1330
+ required: [
1331
+ 'created_at',
1332
+ 'message',
1333
+ 'mutation_code',
1334
+ 'from',
1335
+ 'to',
1336
+ ],
1337
+ type: 'object',
1338
+ },
1339
+ {
1340
+ description: 'Seam is in the process of pushing an updated time frame to the device.',
1341
+ properties: {
1342
+ created_at: {
1343
+ description: 'Date and time at which the mutation was created.',
1344
+ format: 'date-time',
1345
+ type: 'string',
1346
+ },
1347
+ from: {
1348
+ description: 'Previous time frame configuration.',
1349
+ properties: {
1350
+ ends_at: {
1351
+ description: 'Previous end time for the access code.',
1352
+ format: 'date-time',
1353
+ nullable: true,
1354
+ type: 'string',
1355
+ },
1356
+ starts_at: {
1357
+ description: 'Previous start time for the access code.',
1358
+ format: 'date-time',
1359
+ nullable: true,
1360
+ type: 'string',
1361
+ },
1362
+ },
1363
+ required: ['starts_at', 'ends_at'],
1364
+ type: 'object',
1365
+ },
1366
+ message: {
1367
+ description: 'Detailed description of the mutation.',
1368
+ type: 'string',
1369
+ },
1370
+ mutation_code: {
1371
+ description: 'Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device.',
1372
+ enum: ['updating_time_frame'],
1373
+ type: 'string',
1374
+ },
1375
+ to: {
1376
+ description: 'New time frame configuration.',
1377
+ properties: {
1378
+ ends_at: {
1379
+ description: 'New end time for the access code.',
1380
+ format: 'date-time',
1381
+ nullable: true,
1382
+ type: 'string',
1383
+ },
1384
+ starts_at: {
1385
+ description: 'New start time for the access code.',
1386
+ format: 'date-time',
1387
+ nullable: true,
1388
+ type: 'string',
1389
+ },
1390
+ },
1391
+ required: ['starts_at', 'ends_at'],
1392
+ type: 'object',
1393
+ },
1394
+ },
1395
+ required: [
1396
+ 'created_at',
1397
+ 'message',
1398
+ 'mutation_code',
1399
+ 'from',
1400
+ 'to',
1401
+ ],
1402
+ type: 'object',
1403
+ },
1404
+ ],
1405
+ },
1406
+ type: 'array',
1407
+ },
1190
1408
  pulled_backup_access_code_id: {
1191
1409
  description: 'Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.',
1192
1410
  format: 'uuid',
@@ -1566,6 +1784,7 @@ export default {
1566
1784
  'is_external_modification_allowed',
1567
1785
  'is_one_time_use',
1568
1786
  'is_offline_access_code',
1787
+ 'pending_mutations',
1569
1788
  ],
1570
1789
  type: 'object',
1571
1790
  'x-route-path': '/access_codes',
@@ -72630,7 +72849,7 @@ export default {
72630
72849
  },
72631
72850
  '/user_identities/list_accessible_devices': {
72632
72851
  get: {
72633
- description: 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
72852
+ description: 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity.',
72634
72853
  operationId: 'userIdentitiesListAccessibleDevicesGet',
72635
72854
  parameters: [
72636
72855
  {
@@ -72673,6 +72892,7 @@ export default {
72673
72892
  401: { description: 'Unauthorized' },
72674
72893
  },
72675
72894
  security: [
72895
+ { client_session: [] },
72676
72896
  { api_key: [] },
72677
72897
  { pat_with_workspace: [] },
72678
72898
  { console_session_with_workspace: [] },
@@ -72686,7 +72906,7 @@ export default {
72686
72906
  'x-title': 'List Accessible Devices for a User Identity',
72687
72907
  },
72688
72908
  post: {
72689
- description: 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
72909
+ description: 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity.',
72690
72910
  operationId: 'userIdentitiesListAccessibleDevicesPost',
72691
72911
  requestBody: {
72692
72912
  content: {
@@ -72734,6 +72954,7 @@ export default {
72734
72954
  401: { description: 'Unauthorized' },
72735
72955
  },
72736
72956
  security: [
72957
+ { client_session: [] },
72737
72958
  { api_key: [] },
72738
72959
  { pat_with_workspace: [] },
72739
72960
  { console_session_with_workspace: [] },