@seamapi/types 1.194.0 → 1.196.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.
Files changed (30) hide show
  1. package/dist/connect.cjs +147 -48
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +280 -8
  4. package/lib/seam/connect/models/acs/acs-system.js +84 -29
  5. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  6. package/lib/seam/connect/models/events/access-codes.d.ts +102 -0
  7. package/lib/seam/connect/models/events/acs/common.d.ts +3 -0
  8. package/lib/seam/connect/models/events/acs/credentials.d.ts +6 -0
  9. package/lib/seam/connect/models/events/acs/index.d.ts +9 -0
  10. package/lib/seam/connect/models/events/acs/systems.d.ts +6 -0
  11. package/lib/seam/connect/models/events/acs/users.d.ts +6 -0
  12. package/lib/seam/connect/models/events/action-attempts.d.ts +6 -0
  13. package/lib/seam/connect/models/events/client-sessions.d.ts +6 -0
  14. package/lib/seam/connect/models/events/common.d.ts +3 -0
  15. package/lib/seam/connect/models/events/common.js +6 -0
  16. package/lib/seam/connect/models/events/common.js.map +1 -1
  17. package/lib/seam/connect/models/events/connected-accounts.d.ts +42 -0
  18. package/lib/seam/connect/models/events/devices.d.ts +150 -0
  19. package/lib/seam/connect/models/events/enrollment-automations.d.ts +6 -0
  20. package/lib/seam/connect/models/events/phones.d.ts +6 -0
  21. package/lib/seam/connect/models/events/seam-event.d.ts +165 -0
  22. package/lib/seam/connect/openapi.d.ts +22 -0
  23. package/lib/seam/connect/openapi.js +79 -18
  24. package/lib/seam/connect/openapi.js.map +1 -1
  25. package/lib/seam/connect/route-types.d.ts +93 -8
  26. package/package.json +1 -1
  27. package/src/lib/seam/connect/models/acs/acs-system.ts +105 -26
  28. package/src/lib/seam/connect/models/events/common.ts +6 -0
  29. package/src/lib/seam/connect/openapi.ts +98 -18
  30. package/src/lib/seam/connect/route-types.ts +93 -8
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -423,24 +423,31 @@ declare const _default: {
423
423
  type: string;
424
424
  };
425
425
  acs_system: {
426
+ description: string;
426
427
  properties: {
427
428
  acs_system_id: {
429
+ description: string;
428
430
  format: string;
429
431
  type: string;
430
432
  };
431
433
  can_add_acs_users_to_acs_access_groups: {
434
+ description: string;
432
435
  type: string;
433
436
  };
434
437
  can_automate_enrollment: {
438
+ description: string;
435
439
  type: string;
436
440
  };
437
441
  can_create_acs_access_groups: {
442
+ description: string;
438
443
  type: string;
439
444
  };
440
445
  can_remove_acs_users_from_acs_access_groups: {
446
+ description: string;
441
447
  type: string;
442
448
  };
443
449
  connected_account_ids: {
450
+ description: string;
444
451
  items: {
445
452
  format: string;
446
453
  type: string;
@@ -448,22 +455,29 @@ declare const _default: {
448
455
  type: string;
449
456
  };
450
457
  created_at: {
458
+ description: string;
451
459
  format: string;
452
460
  type: string;
453
461
  };
454
462
  errors: {
463
+ description: string;
455
464
  items: {
465
+ description: string;
456
466
  oneOf: {
467
+ description: string;
457
468
  properties: {
458
469
  created_at: {
470
+ description: string;
459
471
  format: string;
460
472
  type: string;
461
473
  };
462
474
  error_code: {
475
+ description: string;
463
476
  enum: string[];
464
477
  type: string;
465
478
  };
466
479
  message: {
480
+ description: string;
467
481
  type: string;
468
482
  };
469
483
  };
@@ -474,19 +488,24 @@ declare const _default: {
474
488
  type: string;
475
489
  };
476
490
  external_type: {
491
+ description: string;
477
492
  enum: string[];
478
493
  type: string;
479
494
  };
480
495
  external_type_display_name: {
496
+ description: string;
481
497
  type: string;
482
498
  };
483
499
  image_alt_text: {
500
+ description: string;
484
501
  type: string;
485
502
  };
486
503
  image_url: {
504
+ description: string;
487
505
  type: string;
488
506
  };
489
507
  name: {
508
+ description: string;
490
509
  type: string;
491
510
  };
492
511
  system_type: {
@@ -502,12 +521,15 @@ declare const _default: {
502
521
  };
503
522
  warnings: {
504
523
  items: {
524
+ description: string;
505
525
  properties: {};
506
526
  type: string;
507
527
  };
508
528
  type: string;
529
+ 'x-undocumented': string;
509
530
  };
510
531
  workspace_id: {
532
+ description: string;
511
533
  format: string;
512
534
  type: string;
513
535
  };
package/lib/seam/connect/openapi.js CHANGED
@@ -372,40 +372,82 @@ export default {
372
372
  type: 'object',
373
373
  },
374
374
  acs_system: {
375
+ description: 'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
375
376
  properties: {
376
- acs_system_id: { format: 'uuid', type: 'string' },
377
- can_add_acs_users_to_acs_access_groups: { type: 'boolean' },
378
- can_automate_enrollment: { type: 'boolean' },
379
- can_create_acs_access_groups: { type: 'boolean' },
380
- can_remove_acs_users_from_acs_access_groups: { type: 'boolean' },
377
+ acs_system_id: {
378
+ description: 'ID of the `acs_system`.',
379
+ format: 'uuid',
380
+ type: 'string',
381
+ },
382
+ can_add_acs_users_to_acs_access_groups: {
383
+ description: 'Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
384
+ type: 'boolean',
385
+ },
386
+ can_automate_enrollment: {
387
+ description: 'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`.',
388
+ type: 'boolean',
389
+ },
390
+ can_create_acs_access_groups: {
391
+ description: 'Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
392
+ type: 'boolean',
393
+ },
394
+ can_remove_acs_users_from_acs_access_groups: {
395
+ description: 'Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
396
+ type: 'boolean',
397
+ },
381
398
  connected_account_ids: {
399
+ description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.',
382
400
  items: { format: 'uuid', type: 'string' },
383
401
  type: 'array',
384
402
  },
385
- created_at: { format: 'date-time', type: 'string' },
403
+ created_at: {
404
+ description: 'Date and time at which the `acs_system` was created.',
405
+ format: 'date-time',
406
+ type: 'string',
407
+ },
386
408
  errors: {
409
+ description: 'Errors associated with the `acs_system`.',
387
410
  items: {
411
+ description: 'Error associated with the `acs_system`.',
388
412
  oneOf: [
389
413
  {
414
+ description: 'Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
390
415
  properties: {
391
- created_at: { format: 'date-time', type: 'string' },
416
+ created_at: {
417
+ description: 'Date and time at which Seam created the error.',
418
+ format: 'date-time',
419
+ type: 'string',
420
+ },
392
421
  error_code: {
422
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
393
423
  enum: ['seam_bridge_disconnected'],
394
424
  type: 'string',
395
425
  },
396
- message: { type: 'string' },
426
+ message: {
427
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
428
+ type: 'string',
429
+ },
397
430
  },
398
431
  required: ['created_at', 'message', 'error_code'],
399
432
  type: 'object',
400
433
  },
401
434
  {
435
+ description: 'Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).',
402
436
  properties: {
403
- created_at: { format: 'date-time', type: 'string' },
437
+ created_at: {
438
+ description: 'Date and time at which Seam created the error.',
439
+ format: 'date-time',
440
+ type: 'string',
441
+ },
404
442
  error_code: {
443
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
405
444
  enum: ['visionline_instance_unreachable'],
406
445
  type: 'string',
407
446
  },
408
- message: { type: 'string' },
447
+ message: {
448
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
449
+ type: 'string',
450
+ },
409
451
  },
410
452
  required: ['created_at', 'message', 'error_code'],
411
453
  type: 'object',
@@ -415,6 +457,7 @@ export default {
415
457
  type: 'array',
416
458
  },
417
459
  external_type: {
460
+ description: 'Brand-specific terminology for the `acs_system` type.',
418
461
  enum: [
419
462
  'pti_site',
420
463
  'alta_org',
@@ -427,10 +470,19 @@ export default {
427
470
  ],
428
471
  type: 'string',
429
472
  },
430
- external_type_display_name: { type: 'string' },
431
- image_alt_text: { type: 'string' },
432
- image_url: { type: 'string' },
433
- name: { type: 'string' },
473
+ external_type_display_name: {
474
+ description: 'Display name that corresponds to the brand-specific terminology for the `acs_system` type.',
475
+ type: 'string',
476
+ },
477
+ image_alt_text: {
478
+ description: 'Alternative text for the `acs_system` image.',
479
+ type: 'string',
480
+ },
481
+ image_url: {
482
+ description: 'URL for the image that represents the `acs_system`.',
483
+ type: 'string',
484
+ },
485
+ name: { description: 'Name of the `acs_system`.', type: 'string' },
434
486
  system_type: {
435
487
  deprecated: true,
436
488
  enum: [
@@ -444,18 +496,27 @@ export default {
444
496
  'latch_building',
445
497
  ],
446
498
  type: 'string',
447
- 'x-deprecated': 'use external_type',
499
+ 'x-deprecated': 'Use `external_type`.',
448
500
  },
449
501
  system_type_display_name: {
450
502
  deprecated: true,
451
503
  type: 'string',
452
- 'x-deprecated': 'use external_type_display_name',
504
+ 'x-deprecated': 'Use `external_type_display_name`.',
453
505
  },
454
506
  warnings: {
455
- items: { properties: {}, type: 'object' },
507
+ items: {
508
+ description: '\n ---\n undocumented: Currently, no warnings defined for `acs_system`s.\n ---\n ',
509
+ properties: {},
510
+ type: 'object',
511
+ },
456
512
  type: 'array',
513
+ 'x-undocumented': 'Currently, no warnings defined for `acs_system`s.',
514
+ },
515
+ workspace_id: {
516
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
517
+ format: 'uuid',
518
+ type: 'string',
457
519
  },
458
- workspace_id: { format: 'uuid', type: 'string' },
459
520
  },
460
521
  required: [
461
522
  'acs_system_id',