@seamapi/types 1.259.1 → 1.260.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.
@@ -2514,9 +2514,13 @@ export interface Routes {
2514
2514
  formData: {};
2515
2515
  jsonResponse: {
2516
2516
  acs_entrances: Array<{
2517
+ /** ID of the access control system that contains the entrance. */
2517
2518
  acs_system_id: string;
2519
+ /** ID of the entrance. */
2518
2520
  acs_entrance_id: string;
2521
+ /** Date and time at which the entrance was created. */
2519
2522
  created_at: string;
2523
+ /** Display name for the entrance. */
2520
2524
  display_name: string;
2521
2525
  errors: Array<{
2522
2526
  error_code: string;
@@ -3028,9 +3032,13 @@ export interface Routes {
3028
3032
  formData: {};
3029
3033
  jsonResponse: {
3030
3034
  acs_entrances: Array<{
3035
+ /** ID of the access control system that contains the entrance. */
3031
3036
  acs_system_id: string;
3037
+ /** ID of the entrance. */
3032
3038
  acs_entrance_id: string;
3039
+ /** Date and time at which the entrance was created. */
3033
3040
  created_at: string;
3041
+ /** Display name for the entrance. */
3034
3042
  display_name: string;
3035
3043
  errors: Array<{
3036
3044
  error_code: string;
@@ -4671,9 +4679,13 @@ export interface Routes {
4671
4679
  formData: {};
4672
4680
  jsonResponse: {
4673
4681
  acs_entrance: {
4682
+ /** ID of the access control system that contains the entrance. */
4674
4683
  acs_system_id: string;
4684
+ /** ID of the entrance. */
4675
4685
  acs_entrance_id: string;
4686
+ /** Date and time at which the entrance was created. */
4676
4687
  created_at: string;
4688
+ /** Display name for the entrance. */
4677
4689
  display_name: string;
4678
4690
  errors: Array<{
4679
4691
  error_code: string;
@@ -4730,9 +4742,13 @@ export interface Routes {
4730
4742
  formData: {};
4731
4743
  jsonResponse: {
4732
4744
  acs_entrances: Array<{
4745
+ /** ID of the access control system that contains the entrance. */
4733
4746
  acs_system_id: string;
4747
+ /** ID of the entrance. */
4734
4748
  acs_entrance_id: string;
4749
+ /** Date and time at which the entrance was created. */
4735
4750
  created_at: string;
4751
+ /** Display name for the entrance. */
4736
4752
  display_name: string;
4737
4753
  errors: Array<{
4738
4754
  error_code: string;
@@ -5490,9 +5506,13 @@ export interface Routes {
5490
5506
  formData: {};
5491
5507
  jsonResponse: {
5492
5508
  acs_entrances: Array<{
5509
+ /** ID of the access control system that contains the entrance. */
5493
5510
  acs_system_id: string;
5511
+ /** ID of the entrance. */
5494
5512
  acs_entrance_id: string;
5513
+ /** Date and time at which the entrance was created. */
5495
5514
  created_at: string;
5515
+ /** Display name for the entrance. */
5496
5516
  display_name: string;
5497
5517
  errors: Array<{
5498
5518
  error_code: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.259.1",
3
+ "version": "1.260.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -7,10 +7,16 @@ import {
7
7
  } from './metadata/index.js'
8
8
 
9
9
  export const acs_entrance = z.object({
10
- acs_system_id: z.string().uuid(),
11
- acs_entrance_id: z.string().uuid(),
12
- created_at: z.string().datetime(),
13
- display_name: z.string(),
10
+ acs_system_id: z
11
+ .string()
12
+ .uuid()
13
+ .describe('ID of the access control system that contains the entrance.'),
14
+ acs_entrance_id: z.string().uuid().describe('ID of the entrance.'),
15
+ created_at: z
16
+ .string()
17
+ .datetime()
18
+ .describe('Date and time at which the entrance was created.'),
19
+ display_name: z.string().describe('Display name for the entrance.'),
14
20
  errors: z.array(
15
21
  z.object({
16
22
  error_code: z.string(),
@@ -376,10 +376,26 @@ export default {
376
376
  },
377
377
  acs_entrance: {
378
378
  properties: {
379
- acs_entrance_id: { format: 'uuid', type: 'string' },
380
- acs_system_id: { format: 'uuid', type: 'string' },
381
- created_at: { format: 'date-time', type: 'string' },
382
- display_name: { type: 'string' },
379
+ acs_entrance_id: {
380
+ description: 'ID of the entrance.',
381
+ format: 'uuid',
382
+ type: 'string',
383
+ },
384
+ acs_system_id: {
385
+ description:
386
+ 'ID of the access control system that contains the entrance.',
387
+ format: 'uuid',
388
+ type: 'string',
389
+ },
390
+ created_at: {
391
+ description: 'Date and time at which the entrance was created.',
392
+ format: 'date-time',
393
+ type: 'string',
394
+ },
395
+ display_name: {
396
+ description: 'Display name for the entrance.',
397
+ type: 'string',
398
+ },
383
399
  errors: {
384
400
  items: {
385
401
  properties: {
@@ -2778,9 +2778,13 @@ export interface Routes {
2778
2778
  formData: {}
2779
2779
  jsonResponse: {
2780
2780
  acs_entrances: Array<{
2781
+ /** ID of the access control system that contains the entrance. */
2781
2782
  acs_system_id: string
2783
+ /** ID of the entrance. */
2782
2784
  acs_entrance_id: string
2785
+ /** Date and time at which the entrance was created. */
2783
2786
  created_at: string
2787
+ /** Display name for the entrance. */
2784
2788
  display_name: string
2785
2789
  errors: Array<{
2786
2790
  error_code: string
@@ -3389,9 +3393,13 @@ export interface Routes {
3389
3393
  formData: {}
3390
3394
  jsonResponse: {
3391
3395
  acs_entrances: Array<{
3396
+ /** ID of the access control system that contains the entrance. */
3392
3397
  acs_system_id: string
3398
+ /** ID of the entrance. */
3393
3399
  acs_entrance_id: string
3400
+ /** Date and time at which the entrance was created. */
3394
3401
  created_at: string
3402
+ /** Display name for the entrance. */
3395
3403
  display_name: string
3396
3404
  errors: Array<{
3397
3405
  error_code: string
@@ -5378,9 +5386,13 @@ export interface Routes {
5378
5386
  formData: {}
5379
5387
  jsonResponse: {
5380
5388
  acs_entrance: {
5389
+ /** ID of the access control system that contains the entrance. */
5381
5390
  acs_system_id: string
5391
+ /** ID of the entrance. */
5382
5392
  acs_entrance_id: string
5393
+ /** Date and time at which the entrance was created. */
5383
5394
  created_at: string
5395
+ /** Display name for the entrance. */
5384
5396
  display_name: string
5385
5397
  errors: Array<{
5386
5398
  error_code: string
@@ -5450,9 +5462,13 @@ export interface Routes {
5450
5462
  formData: {}
5451
5463
  jsonResponse: {
5452
5464
  acs_entrances: Array<{
5465
+ /** ID of the access control system that contains the entrance. */
5453
5466
  acs_system_id: string
5467
+ /** ID of the entrance. */
5454
5468
  acs_entrance_id: string
5469
+ /** Date and time at which the entrance was created. */
5455
5470
  created_at: string
5471
+ /** Display name for the entrance. */
5456
5472
  display_name: string
5457
5473
  errors: Array<{
5458
5474
  error_code: string
@@ -6382,9 +6398,13 @@ export interface Routes {
6382
6398
  formData: {}
6383
6399
  jsonResponse: {
6384
6400
  acs_entrances: Array<{
6401
+ /** ID of the access control system that contains the entrance. */
6385
6402
  acs_system_id: string
6403
+ /** ID of the entrance. */
6386
6404
  acs_entrance_id: string
6405
+ /** Date and time at which the entrance was created. */
6387
6406
  created_at: string
6407
+ /** Display name for the entrance. */
6388
6408
  display_name: string
6389
6409
  errors: Array<{
6390
6410
  error_code: string