@seamapi/types 1.445.0 → 1.445.1

package/dist/connect.d.cts

@@ -86721,41 +86721,41 @@ interface Routes {
         };
         formData: {};
         jsonResponse: {
-            /** Represents an access grant. Access grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an access grant for an existing user identity, or you can create a new user identity *while* creating the new access grant. */
+            /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
             access_grant: {
-                /** ID of the Seam workspace associated with the access grant. */
+                /** ID of the Seam workspace associated with the Access Grant. */
                 workspace_id: string;
-                /** ID of the access grant. */
+                /** ID of the Access Grant. */
                 access_grant_id: string;
-                /** ID of user identity to which the access grant gives access. */
+                /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
                  * @deprecated Use `space_ids`. */
                 location_ids: string[];
-                /** IDs of the spaces to which the access grant gives access. */
+                /** IDs of the spaces to which the Access Grant gives access. */
                 space_ids: string[];
-                /** Access methods that the user requested for the access grant. */
+                /** Access methods that the user requested for the 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 the access grant. */
+                    /** Date and time at which the requested access method was added to the Access Grant. */
                     created_at: string;
                     /** IDs of the access methods created for the requested access method. */
                     created_access_method_ids: string[];
                 }>;
-                /** IDs of the access methods created for the access grant. */
+                /** IDs of the access methods created for the Access Grant. */
                 access_method_ids: string[];
-                /** Display name of the access grant. */
+                /** Display name of the Access Grant. */
                 display_name: string;
-                /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method.  */
+                /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
                 instant_key_url?: string | undefined;
-                /** Date and time at which the access grant was created. */
+                /** Date and time at which the Access Grant was created. */
                 created_at: string;
-                /** Date and time at which the access grant starts. */
+                /** Date and time at which the Access Grant starts. */
                 starts_at?: string | undefined;
-                /** Date and time at which the access grant ends. */
+                /** Date and time at which the Access Grant ends. */
                 ends_at?: string | undefined;
             };
         };
@@ -86766,7 +86766,7 @@ interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of access grant to delete. */
+            /** ID of Access Grant to delete. */
             access_grant_id: string;
         };
         formData: {};
@@ -86778,46 +86778,46 @@ interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of access grant to get. */
+            /** ID of Access Grant to get. */
             access_grant_id: string;
         };
         formData: {};
         jsonResponse: {
-            /** Represents an access grant. Access grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an access grant for an existing user identity, or you can create a new user identity *while* creating the new access grant. */
+            /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
             access_grant: {
-                /** ID of the Seam workspace associated with the access grant. */
+                /** ID of the Seam workspace associated with the Access Grant. */
                 workspace_id: string;
-                /** ID of the access grant. */
+                /** ID of the Access Grant. */
                 access_grant_id: string;
-                /** ID of user identity to which the access grant gives access. */
+                /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
                  * @deprecated Use `space_ids`. */
                 location_ids: string[];
-                /** IDs of the spaces to which the access grant gives access. */
+                /** IDs of the spaces to which the Access Grant gives access. */
                 space_ids: string[];
-                /** Access methods that the user requested for the access grant. */
+                /** Access methods that the user requested for the 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 the access grant. */
+                    /** Date and time at which the requested access method was added to the Access Grant. */
                     created_at: string;
                     /** IDs of the access methods created for the requested access method. */
                     created_access_method_ids: string[];
                 }>;
-                /** IDs of the access methods created for the access grant. */
+                /** IDs of the access methods created for the Access Grant. */
                 access_method_ids: string[];
-                /** Display name of the access grant. */
+                /** Display name of the Access Grant. */
                 display_name: string;
-                /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method.  */
+                /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
                 instant_key_url?: string | undefined;
-                /** Date and time at which the access grant was created. */
+                /** Date and time at which the Access Grant was created. */
                 created_at: string;
-                /** Date and time at which the access grant starts. */
+                /** Date and time at which the Access Grant starts. */
                 starts_at?: string | undefined;
-                /** Date and time at which the access grant ends. */
+                /** Date and time at which the Access Grant ends. */
                 ends_at?: string | undefined;
             };
         };
@@ -86828,54 +86828,54 @@ interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of user identity to filter list of access grants by. */
+            /** ID of user identity by which you want to filter the list of Access Grants. */
             user_identity_id?: string | undefined;
-            /** ID of system to filter list of access grants by. */
+            /** ID of the access system by which you want to filter the list of Access Grants. */
             acs_system_id?: string | undefined;
-            /** ID of entrance to filter list of access grants by. */
+            /** ID of the entrance by which you want to filter the list of Access Grants. */
             acs_entrance_id?: string | undefined;
             /**
              * @deprecated Use `space_id`. */
             location_id?: string | undefined;
-            /** ID of space to filter list of access grants by. */
+            /** ID of the space by which you want to filter the list of Access Grants. */
             space_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
             access_grants: Array<{
-                /** ID of the Seam workspace associated with the access grant. */
+                /** ID of the Seam workspace associated with the Access Grant. */
                 workspace_id: string;
-                /** ID of the access grant. */
+                /** ID of the Access Grant. */
                 access_grant_id: string;
-                /** ID of user identity to which the access grant gives access. */
+                /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
                  * @deprecated Use `space_ids`. */
                 location_ids: string[];
-                /** IDs of the spaces to which the access grant gives access. */
+                /** IDs of the spaces to which the Access Grant gives access. */
                 space_ids: string[];
-                /** Access methods that the user requested for the access grant. */
+                /** Access methods that the user requested for the 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 the access grant. */
+                    /** Date and time at which the requested access method was added to the Access Grant. */
                     created_at: string;
                     /** IDs of the access methods created for the requested access method. */
                     created_access_method_ids: string[];
                 }>;
-                /** IDs of the access methods created for the access grant. */
+                /** IDs of the access methods created for the Access Grant. */
                 access_method_ids: string[];
-                /** Display name of the access grant. */
+                /** Display name of the Access Grant. */
                 display_name: string;
-                /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method.  */
+                /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
                 instant_key_url?: string | undefined;
-                /** Date and time at which the access grant was created. */
+                /** Date and time at which the Access Grant was created. */
                 created_at: string;
-                /** Date and time at which the access grant starts. */
+                /** Date and time at which the Access Grant starts. */
                 starts_at?: string | undefined;
-                /** Date and time at which the access grant ends. */
+                /** Date and time at which the Access Grant ends. */
                 ends_at?: string | undefined;
             }>;
         };
@@ -86886,7 +86886,7 @@ interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the access grant to update. */
+            /** ID of the Access Grant to update. */
             access_grant_id: string;
             /** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             starts_at?: (string | null) | undefined;
@@ -86914,7 +86914,7 @@ interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the `acs_encoder` to use to encode the `acs_credential`. */
+            /** ID of the `acs_encoder` to use to encode the `access_method`. */
             acs_encoder_id: string;
             /** ID of the `access_method` to encode onto a card. */
             access_method_id: string;
@@ -88179,7 +88179,7 @@ interface Routes {
         };
         formData: {};
         jsonResponse: {
-            /** Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
+            /** Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
             access_method: {
                 /** ID of the Seam workspace associated with the access method. */
                 workspace_id: string;
@@ -88208,7 +88208,7 @@ interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of access grant to list access methods for. */
+            /** ID of Access Grant to list access methods for. */
             access_grant_id: string;
             /** ID of the device for which you want to retrieve all access methods. */
             device_id?: string | undefined;
@@ -103153,7 +103153,7 @@ interface Routes {
                 created_at: string;
                 /** Date and time at which the event occurred. */
                 occurred_at: string;
-                /** ID of the affected access grant. */
+                /** ID of the affected Access Grant. */
                 access_grant_id: string;
                 event_type: 'access_grant.created';
             } | {
@@ -103165,7 +103165,7 @@ interface Routes {
                 created_at: string;
                 /** Date and time at which the event occurred. */
                 occurred_at: string;
-                /** ID of the affected access grant. */
+                /** ID of the affected Access Grant. */
                 access_grant_id: string;
                 event_type: 'access_grant.deleted';
             } | {
@@ -103177,7 +103177,7 @@ interface Routes {
                 created_at: string;
                 /** Date and time at which the event occurred. */
                 occurred_at: string;
-                /** ID of the affected access grant. */
+                /** ID of the affected Access Grant. */
                 access_grant_id: string;
                 event_type: 'access_grant.access_granted_to_all_doors';
             } | {
@@ -103189,7 +103189,7 @@ interface Routes {
                 created_at: string;
                 /** Date and time at which the event occurred. */
                 occurred_at: string;
-                /** ID of the affected access grant. */
+                /** ID of the affected Access Grant. */
                 access_grant_id: string;
                 event_type: 'access_grant.access_granted_to_door';
                 /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -103203,7 +103203,7 @@ interface Routes {
                 created_at: string;
                 /** Date and time at which the event occurred. */
                 occurred_at: string;
-                /** ID of the affected access grant. */
+                /** ID of the affected Access Grant. */
                 access_grant_id: string;
                 event_type: 'access_grant.access_to_door_lost';
                 /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -104805,7 +104805,7 @@ interface Routes {
                 created_at: string;
                 /** Date and time at which the event occurred. */
                 occurred_at: string;
-                /** ID of the affected access grant. */
+                /** ID of the affected Access Grant. */
                 access_grant_id: string;
                 event_type: 'access_grant.created';
             } | {
@@ -104817,7 +104817,7 @@ interface Routes {
                 created_at: string;
                 /** Date and time at which the event occurred. */
                 occurred_at: string;
-                /** ID of the affected access grant. */
+                /** ID of the affected Access Grant. */
                 access_grant_id: string;
                 event_type: 'access_grant.deleted';
             } | {
@@ -104829,7 +104829,7 @@ interface Routes {
                 created_at: string;
                 /** Date and time at which the event occurred. */
                 occurred_at: string;
-                /** ID of the affected access grant. */
+                /** ID of the affected Access Grant. */
                 access_grant_id: string;
                 event_type: 'access_grant.access_granted_to_all_doors';
             } | {
@@ -104841,7 +104841,7 @@ interface Routes {
                 created_at: string;
                 /** Date and time at which the event occurred. */
                 occurred_at: string;
-                /** ID of the affected access grant. */
+                /** ID of the affected Access Grant. */
                 access_grant_id: string;
                 event_type: 'access_grant.access_granted_to_door';
                 /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -104855,7 +104855,7 @@ interface Routes {
                 created_at: string;
                 /** Date and time at which the event occurred. */
                 occurred_at: string;
-                /** ID of the affected access grant. */
+                /** ID of the affected Access Grant. */
                 access_grant_id: string;
                 event_type: 'access_grant.access_to_door_lost';
                 /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -140214,41 +140214,41 @@ interface Routes {
         };
         formData: {};
         jsonResponse: {
-            /** Represents an access grant. Access grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an access grant for an existing user identity, or you can create a new user identity *while* creating the new access grant. */
+            /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
             access_grant: {
-                /** ID of the Seam workspace associated with the access grant. */
+                /** ID of the Seam workspace associated with the Access Grant. */
                 workspace_id: string;
-                /** ID of the access grant. */
+                /** ID of the Access Grant. */
                 access_grant_id: string;
-                /** ID of user identity to which the access grant gives access. */
+                /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
                  * @deprecated Use `space_ids`. */
                 location_ids: string[];
-                /** IDs of the spaces to which the access grant gives access. */
+                /** IDs of the spaces to which the Access Grant gives access. */
                 space_ids: string[];
-                /** Access methods that the user requested for the access grant. */
+                /** Access methods that the user requested for the 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 the access grant. */
+                    /** Date and time at which the requested access method was added to the Access Grant. */
                     created_at: string;
                     /** IDs of the access methods created for the requested access method. */
                     created_access_method_ids: string[];
                 }>;
-                /** IDs of the access methods created for the access grant. */
+                /** IDs of the access methods created for the Access Grant. */
                 access_method_ids: string[];
-                /** Display name of the access grant. */
+                /** Display name of the Access Grant. */
                 display_name: string;
-                /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method.  */
+                /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
                 instant_key_url?: string | undefined;
-                /** Date and time at which the access grant was created. */
+                /** Date and time at which the Access Grant was created. */
                 created_at: string;
-                /** Date and time at which the access grant starts. */
+                /** Date and time at which the Access Grant starts. */
                 starts_at?: string | undefined;
-                /** Date and time at which the access grant ends. */
+                /** Date and time at which the Access Grant ends. */
                 ends_at?: string | undefined;
             };
         };
@@ -140276,41 +140276,41 @@ interface Routes {
         };
         formData: {};
         jsonResponse: {
-            /** Represents an access grant. Access grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an access grant for an existing user identity, or you can create a new user identity *while* creating the new access grant. */
+            /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
             access_grant: {
-                /** ID of the Seam workspace associated with the access grant. */
+                /** ID of the Seam workspace associated with the Access Grant. */
                 workspace_id: string;
-                /** ID of the access grant. */
+                /** ID of the Access Grant. */
                 access_grant_id: string;
-                /** ID of user identity to which the access grant gives access. */
+                /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
                  * @deprecated Use `space_ids`. */
                 location_ids: string[];
-                /** IDs of the spaces to which the access grant gives access. */
+                /** IDs of the spaces to which the Access Grant gives access. */
                 space_ids: string[];
-                /** Access methods that the user requested for the access grant. */
+                /** Access methods that the user requested for the 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 the access grant. */
+                    /** Date and time at which the requested access method was added to the Access Grant. */
                     created_at: string;
                     /** IDs of the access methods created for the requested access method. */
                     created_access_method_ids: string[];
                 }>;
-                /** IDs of the access methods created for the access grant. */
+                /** IDs of the access methods created for the Access Grant. */
                 access_method_ids: string[];
-                /** Display name of the access grant. */
+                /** Display name of the Access Grant. */
                 display_name: string;
-                /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method.  */
+                /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
                 instant_key_url?: string | undefined;
-                /** Date and time at which the access grant was created. */
+                /** Date and time at which the Access Grant was created. */
                 created_at: string;
-                /** Date and time at which the access grant starts. */
+                /** Date and time at which the Access Grant starts. */
                 starts_at?: string | undefined;
-                /** Date and time at which the access grant ends. */
+                /** Date and time at which the Access Grant ends. */
                 ends_at?: string | undefined;
             };
         };
@@ -140336,39 +140336,39 @@ interface Routes {
         formData: {};
         jsonResponse: {
             access_grants: Array<{
-                /** ID of the Seam workspace associated with the access grant. */
+                /** ID of the Seam workspace associated with the Access Grant. */
                 workspace_id: string;
-                /** ID of the access grant. */
+                /** ID of the Access Grant. */
                 access_grant_id: string;
-                /** ID of user identity to which the access grant gives access. */
+                /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
                  * @deprecated Use `space_ids`. */
                 location_ids: string[];
-                /** IDs of the spaces to which the access grant gives access. */
+                /** IDs of the spaces to which the Access Grant gives access. */
                 space_ids: string[];
-                /** Access methods that the user requested for the access grant. */
+                /** Access methods that the user requested for the 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 the access grant. */
+                    /** Date and time at which the requested access method was added to the Access Grant. */
                     created_at: string;
                     /** IDs of the access methods created for the requested access method. */
                     created_access_method_ids: string[];
                 }>;
-                /** IDs of the access methods created for the access grant. */
+                /** IDs of the access methods created for the Access Grant. */
                 access_method_ids: string[];
-                /** Display name of the access grant. */
+                /** Display name of the Access Grant. */
                 display_name: string;
-                /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method.  */
+                /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
                 instant_key_url?: string | undefined;
-                /** Date and time at which the access grant was created. */
+                /** Date and time at which the Access Grant was created. */
                 created_at: string;
-                /** Date and time at which the access grant starts. */
+                /** Date and time at which the Access Grant starts. */
                 starts_at?: string | undefined;
-                /** Date and time at which the access grant ends. */
+                /** Date and time at which the Access Grant ends. */
                 ends_at?: string | undefined;
             }>;
         };
@@ -140396,7 +140396,7 @@ interface Routes {
         };
         formData: {};
         jsonResponse: {
-            /** Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
+            /** Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
             access_method: {
                 /** ID of the Seam workspace associated with the access method. */
                 workspace_id: string;