@seamapi/types 1.259.1 → 1.261.0

package/lib/seam/connect/route-types.d.ts

@@ -87,9 +87,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -118,7 +116,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -693,9 +691,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -724,7 +720,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -1456,9 +1452,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -1487,7 +1481,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -2049,9 +2043,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -2080,7 +2072,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -2514,9 +2506,13 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_entrances: Array<{
+                /** ID of the access control system that contains the entrance. */
                 acs_system_id: string;
+                /** ID of the entrance. */
                 acs_entrance_id: string;
+                /** Date and time at which the entrance was created. */
                 created_at: string;
+                /** Display name for the entrance. */
                 display_name: string;
                 errors: Array<{
                     error_code: string;
@@ -3028,9 +3024,13 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_entrances: Array<{
+                /** ID of the access control system that contains the entrance. */
                 acs_system_id: string;
+                /** ID of the entrance. */
                 acs_entrance_id: string;
+                /** Date and time at which the entrance was created. */
                 created_at: string;
+                /** Display name for the entrance. */
                 display_name: string;
                 errors: Array<{
                     error_code: string;
@@ -3360,9 +3360,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -3391,7 +3389,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -4211,6 +4209,7 @@ export interface Routes {
             acs_system_id: string;
             device_name: string;
         } | {
+            acs_system_id: string;
             device_id: string;
         };
         formData: {};
@@ -4277,9 +4276,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -4308,7 +4305,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -4671,9 +4668,13 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_entrance: {
+                /** ID of the access control system that contains the entrance. */
                 acs_system_id: string;
+                /** ID of the entrance. */
                 acs_entrance_id: string;
+                /** Date and time at which the entrance was created. */
                 created_at: string;
+                /** Display name for the entrance. */
                 display_name: string;
                 errors: Array<{
                     error_code: string;
@@ -4730,9 +4731,13 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_entrances: Array<{
+                /** ID of the access control system that contains the entrance. */
                 acs_system_id: string;
+                /** ID of the entrance. */
                 acs_entrance_id: string;
+                /** Date and time at which the entrance was created. */
                 created_at: string;
+                /** Display name for the entrance. */
                 display_name: string;
                 errors: Array<{
                     error_code: string;
@@ -5490,9 +5495,13 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_entrances: Array<{
+                /** ID of the access control system that contains the entrance. */
                 acs_system_id: string;
+                /** ID of the entrance. */
                 acs_entrance_id: string;
+                /** Date and time at which the entrance was created. */
                 created_at: string;
+                /** Display name for the entrance. */
                 display_name: string;
                 errors: Array<{
                     error_code: string;
@@ -5878,9 +5887,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -5909,7 +5916,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -6333,9 +6340,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -6364,7 +6369,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -10334,9 +10339,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -10365,7 +10368,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -10790,9 +10793,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -10821,7 +10822,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -12188,9 +12189,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -12219,7 +12218,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -12654,9 +12653,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -12685,7 +12682,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -13159,9 +13156,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -13190,7 +13185,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -13797,9 +13792,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -13828,7 +13821,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -14255,9 +14248,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -14286,7 +14277,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -15197,9 +15188,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -15228,7 +15217,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -15657,9 +15646,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -15688,7 +15675,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -16577,9 +16564,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -16608,7 +16593,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -17154,9 +17139,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -17185,7 +17168,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -19079,9 +19062,7 @@ export interface Routes {
                 error: null;
                 action_type: 'READ_CARD';
                 result: {
-                    /** Matching acs_credential currently encoded on this card. */
-                    acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {
@@ -19110,7 +19091,7 @@ export interface Routes {
                 result: {
                     /** Matching acs_credential currently encoded on this card. */
                     acs_credential_id: string | null;
-                    /** A number or sting that physically identifies this card. */
+                    /** A number or string that physically identifies this card. */
                     card_number: string | null;
                 };
             } | {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.259.1",
+  "version": "1.261.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/acs/acs-entrance.ts

@@ -7,10 +7,16 @@ import {
 } from './metadata/index.js'
 
 export const acs_entrance = z.object({
-  acs_system_id: z.string().uuid(),
-  acs_entrance_id: z.string().uuid(),
-  created_at: z.string().datetime(),
-  display_name: z.string(),
+  acs_system_id: z
+    .string()
+    .uuid()
+    .describe('ID of the access control system that contains the entrance.'),
+  acs_entrance_id: z.string().uuid().describe('ID of the entrance.'),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the entrance was created.'),
+  display_name: z.string().describe('Display name for the entrance.'),
   errors: z.array(
     z.object({
       error_code: z.string(),

package/src/lib/seam/connect/models/action-attempts/encode-card.ts

@@ -22,7 +22,7 @@ const result = z.object({
   card_number: z
     .string()
     .nullable()
-    .describe('A number or sting that physically identifies this card.'),
+    .describe('A number or string that physically identifies this card.'),
   // TODO visionline_metadata: visionline_credential_metadata,
 })
 

package/src/lib/seam/connect/models/action-attempts/read-card.ts

@@ -14,15 +14,15 @@ const error = z.object({
 })
 
 const result = z.object({
-  acs_credential_id: z
-    .string()
-    .uuid()
-    .nullable()
-    .describe('Matching acs_credential currently encoded on this card.'),
+  // TODO acs_credential_id: z
+  //   .string()
+  //   .uuid()
+  //   .nullable()
+  //   .describe("Matching acs_credential currently encoded on this card."),
   card_number: z
     .string()
     .nullable()
-    .describe('A number or sting that physically identifies this card.'),
+    .describe('A number or string that physically identifies this card.'),
   // TODO visionline_metadata: visionline_credential_metadata,
 })
 

package/src/lib/seam/connect/openapi.ts

@@ -376,10 +376,26 @@ export default {
       },
       acs_entrance: {
         properties: {
-          acs_entrance_id: { format: 'uuid', type: 'string' },
-          acs_system_id: { format: 'uuid', type: 'string' },
-          created_at: { format: 'date-time', type: 'string' },
-          display_name: { type: 'string' },
+          acs_entrance_id: {
+            description: 'ID of the entrance.',
+            format: 'uuid',
+            type: 'string',
+          },
+          acs_system_id: {
+            description:
+              'ID of the access control system that contains the entrance.',
+            format: 'uuid',
+            type: 'string',
+          },
+          created_at: {
+            description: 'Date and time at which the entrance was created.',
+            format: 'date-time',
+            type: 'string',
+          },
+          display_name: {
+            description: 'Display name for the entrance.',
+            type: 'string',
+          },
           errors: {
             items: {
               properties: {
@@ -1234,21 +1250,14 @@ export default {
               error: { nullable: true },
               result: {
                 properties: {
-                  acs_credential_id: {
-                    description:
-                      'Matching acs_credential currently encoded on this card.',
-                    format: 'uuid',
-                    nullable: true,
-                    type: 'string',
-                  },
                   card_number: {
                     description:
-                      'A number or sting that physically identifies this card.',
+                      'A number or string that physically identifies this card.',
                     nullable: true,
                     type: 'string',
                   },
                 },
-                required: ['acs_credential_id', 'card_number'],
+                required: ['card_number'],
                 type: 'object',
               },
               status: { enum: ['success'], type: 'string' },
@@ -1337,7 +1346,7 @@ export default {
                   },
                   card_number: {
                     description:
-                      'A number or sting that physically identifies this card.',
+                      'A number or string that physically identifies this card.',
                     nullable: true,
                     type: 'string',
                   },
@@ -7628,9 +7637,10 @@ export default {
                   },
                   {
                     properties: {
+                      acs_system_id: { format: 'uuid', type: 'string' },
                       device_id: { format: 'uuid', type: 'string' },
                     },
-                    required: ['device_id'],
+                    required: ['acs_system_id', 'device_id'],
                     type: 'object',
                   },
                 ],