@seamapi/types 1.379.0 → 1.380.0

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

@@ -16520,7 +16520,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -17262,7 +17261,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -21207,7 +21205,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -21911,7 +21908,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -22653,7 +22649,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -23356,7 +23351,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -26059,7 +26053,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -26762,7 +26755,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -32803,7 +32795,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -35487,7 +35478,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -36190,7 +36180,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -40007,16 +39996,16 @@ export interface Routes {
         jsonBody: {};
         commonParams: ({
             /** ID of user identity for whom access is being granted. */
-            user_identity_id?: string | undefined;
+            user_identity_id: string;
         } | {
             /** When used, creates a new user identity with the given details, and grants them access. */
-            user_identity?: {
+            user_identity: {
                 /** Unique email address for the user identity. */
                 email_address?: (string | null) | undefined;
                 /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
                 phone_number?: (string | null) | undefined;
                 full_name?: (string | null) | undefined;
-            } | undefined;
+            };
         }) & {
             /** Set of IDs of existing locations to which access is being granted. */
             location_ids?: string[] | undefined;
@@ -40048,18 +40037,16 @@ export interface Routes {
                 user_identity_id: string;
                 /** IDs of the locations to which access is being given. */
                 location_ids: string[];
-                /** Access methods associated with this access grant. */
-                access_methods: Array<{
-                    /** Key for the access method - unique within an access grant. */
-                    access_method_key: string;
+                /** Access methods that the user requested for this access grant. */
+                requested_access_methods: Array<{
                     /** Display name of the access method. */
                     display_name: string;
                     /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
                     mode: 'code' | 'card' | 'mobile_key';
-                    /** Date and time at which the access method was created. */
+                    /** Date and time at which the requested access method was added to this access grant. */
                     created_at: string;
-                    /** Date and time at which the access method was issued. */
-                    issued_at: string | null;
+                    /** IDs of the locations to which access is being given. */
+                    provisioned_access_method_ids: string[];
                 }>;
                 /** Display name of the access grant. */
                 display_name: string;
@@ -40068,6 +40055,116 @@ export interface Routes {
             };
         };
     };
+    '/unstable_access_grants/get': {
+        route: '/unstable_access_grants/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of access grant to get. */
+            access_grant_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /**  */
+            access_grant: {
+                /** Unique identifier for the Seam workspace associated with the access grant. */
+                workspace_id: string;
+                /** ID of the access grant. */
+                access_grant_id: string;
+                /** ID of user identity to which access is being granted. */
+                user_identity_id: string;
+                /** IDs of the locations to which access is being given. */
+                location_ids: string[];
+                /** Access methods that the user requested for this access grant. */
+                requested_access_methods: Array<{
+                    /** Display name of the access method. */
+                    display_name: string;
+                    /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                    mode: 'code' | 'card' | 'mobile_key';
+                    /** Date and time at which the requested access method was added to this access grant. */
+                    created_at: string;
+                    /** IDs of the locations to which access is being given. */
+                    provisioned_access_method_ids: string[];
+                }>;
+                /** Display name of the access grant. */
+                display_name: string;
+                /** Date and time at which the access grant was created. */
+                created_at: string;
+            };
+        };
+    };
+    '/unstable_access_grants/list': {
+        route: '/unstable_access_grants/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of user identity to filter list of access grants by. */
+            user_identity_id?: string | undefined;
+            /** ID of system to filter list of access grants by. */
+            acs_system_id?: string | undefined;
+            /** ID of entrance to filter list of access grants by. */
+            acs_entrance_id?: string | undefined;
+            /** ID of location to filter list of access grants by. */
+            location_id?: string | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            access_grants: Array<{
+                /** Unique identifier for the Seam workspace associated with the access grant. */
+                workspace_id: string;
+                /** ID of the access grant. */
+                access_grant_id: string;
+                /** ID of user identity to which access is being granted. */
+                user_identity_id: string;
+                /** IDs of the locations to which access is being given. */
+                location_ids: string[];
+                /** Access methods that the user requested for this access grant. */
+                requested_access_methods: Array<{
+                    /** Display name of the access method. */
+                    display_name: string;
+                    /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                    mode: 'code' | 'card' | 'mobile_key';
+                    /** Date and time at which the requested access method was added to this access grant. */
+                    created_at: string;
+                    /** IDs of the locations to which access is being given. */
+                    provisioned_access_method_ids: string[];
+                }>;
+                /** Display name of the access grant. */
+                display_name: string;
+                /** Date and time at which the access grant was created. */
+                created_at: string;
+            }>;
+        };
+    };
+    '/unstable_access_grants/list_access_methods': {
+        route: '/unstable_access_grants/list_access_methods';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of access grant to list access methods for. */
+            access_grant_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            access_methods: Array<{
+                /** Unique identifier for the Seam workspace associated with the access grant. */
+                workspace_id: string;
+                /** ID of the access method. */
+                access_method_id: string;
+                /** Display name of the access method. */
+                display_name: string;
+                /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                mode: 'code' | 'card' | 'mobile_key';
+                /** Date and time at which the access method was created. */
+                created_at: string;
+                /** Date and time at which the access method was issued. */
+                issued_at: string | null;
+            }>;
+        };
+    };
     '/unstable_locations/add_devices': {
         route: '/unstable_locations/add_devices';
         method: 'POST' | 'PUT';
@@ -40594,7 +40691,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -41299,7 +41395,6 @@ export interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {

package/package.json

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

package/src/lib/seam/connect/models/access-grants/access-grant.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 
-import { access_method } from './access-method.js'
+import { requested_access_method } from './requested-access-method.js'
 
 export const access_grant = z.object({
   workspace_id: z
@@ -17,9 +17,9 @@ export const access_grant = z.object({
   location_ids: z
     .array(z.string().uuid())
     .describe('IDs of the locations to which access is being given.'),
-  access_methods: z
-    .array(access_method)
-    .describe('Access methods associated with this access grant.'),
+  requested_access_methods: z
+    .array(requested_access_method)
+    .describe('Access methods that the user requested for this access grant.'),
   display_name: z.string().describe('Display name of the access grant.'),
   created_at: z
     .string()

package/src/lib/seam/connect/models/access-grants/access-method.ts

@@ -1,9 +1,13 @@
 import { z } from 'zod'
 
 export const access_method = z.object({
-  access_method_key: z
+  workspace_id: z
     .string()
-    .describe('Key for the access method - unique within an access grant.'),
+    .uuid()
+    .describe(
+      'Unique identifier for the Seam workspace associated with the access grant.',
+    ),
+  access_method_id: z.string().uuid().describe('ID of the access method.'),
   display_name: z.string().describe('Display name of the access method.'),
   mode: z
     .enum(['code', 'card', 'mobile_key'])

package/src/lib/seam/connect/models/access-grants/requested-access-method.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod'
+
+export const requested_access_method = z.object({
+  display_name: z.string().describe('Display name of the access method.'),
+  mode: z
+    .enum(['code', 'card', 'mobile_key'])
+    .describe(
+      'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the requested access method was added to this access grant.',
+    ),
+  provisioned_access_method_ids: z
+    .array(z.string().uuid())
+    .describe('IDs of the locations to which access is being given.'),
+}).describe(`
+  ---
+  undocumented: Unreleased.
+  ---
+  `)
+
+export type RequestedAccessMethod = z.infer<typeof requested_access_method>

package/src/lib/seam/connect/models/devices/device-metadata.ts

@@ -42,7 +42,6 @@ export const device_metadata = z
     schlage_metadata: z.object({
       device_id: z.string(),
       device_name: z.string(),
-      access_code_length: z.number().nullable(),
       model: z.string().optional(),
     }),
 

package/src/lib/seam/connect/models/events/acs/credentials.ts

@@ -43,7 +43,8 @@ export const acs_credential_invalidated = acs_credential_event.extend({
   ---
   route_path: /acs/credentials
   ---
-  An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was invalidated.
+  An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was invalidated. That is, the credential cannot be used anymore.
+
 `)
 
 export const acs_credential_events = [