@seamapi/http 2.1.0 → 2.2.0

package/src/lib/seam/connect/routes/acs/encoders/simulate/simulate.ts

@@ -160,6 +160,9 @@ export class SeamHttpAcsEncodersSimulate {
     await clientSessions.get()
   }
 
+  /**
+   * Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+   */
   nextCredentialEncodeWillFail(
     parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters,
     options: AcsEncodersSimulateNextCredentialEncodeWillFailOptions = {},
@@ -173,6 +176,9 @@ export class SeamHttpAcsEncodersSimulate {
     })
   }
 
+  /**
+   * Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+   */
   nextCredentialEncodeWillSucceed(
     parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters,
     options: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions = {},
@@ -186,6 +192,9 @@ export class SeamHttpAcsEncodersSimulate {
     })
   }
 
+  /**
+   * Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+   */
   nextCredentialScanWillFail(
     parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters,
     options: AcsEncodersSimulateNextCredentialScanWillFailOptions = {},
@@ -199,6 +208,9 @@ export class SeamHttpAcsEncodersSimulate {
     })
   }
 
+  /**
+   * Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+   */
   nextCredentialScanWillSucceed(
     parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters,
     options: AcsEncodersSimulateNextCredentialScanWillSucceedOptions = {},
@@ -214,14 +226,23 @@ export class SeamHttpAcsEncodersSimulate {
 }
 
 export type AcsEncodersSimulateNextCredentialEncodeWillFailParameters = {
+  /**
+   * ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
+   */
   acs_encoder_id: string
 
+  /**
+   * Code of the error to simulate.
+   */
   error_code?:
     | 'no_credential_on_encoder'
     | 'encoding_interrupted'
     | 'uncategorized_error'
     | 'action_attempt_expired'
     | undefined
+  /**
+   * ID of the `acs_credential` that will fail to be encoded onto a card in the next request.
+   */
   acs_credential_id?: string | undefined
 }
 
@@ -236,8 +257,14 @@ export type AcsEncodersSimulateNextCredentialEncodeWillFailRequest =
 export interface AcsEncodersSimulateNextCredentialEncodeWillFailOptions {}
 
 export type AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters = {
+  /**
+   * ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
+   */
   acs_encoder_id: string
 
+  /**
+   * Scenario to simulate.
+   */
   scenario?: 'credential_is_issued' | undefined
 }
 
@@ -252,6 +279,9 @@ export type AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest =
 export interface AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions {}
 
 export type AcsEncodersSimulateNextCredentialScanWillFailParameters = {
+  /**
+   * ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.
+   */
   acs_encoder_id: string
 
   error_code?:
@@ -259,6 +289,7 @@ export type AcsEncodersSimulateNextCredentialScanWillFailParameters = {
     | 'uncategorized_error'
     | 'action_attempt_expired'
     | undefined
+
   acs_credential_id_on_seam?: string | undefined
 }
 
@@ -273,9 +304,18 @@ export type AcsEncodersSimulateNextCredentialScanWillFailRequest =
 export interface AcsEncodersSimulateNextCredentialScanWillFailOptions {}
 
 export type AcsEncodersSimulateNextCredentialScanWillSucceedParameters = {
+  /**
+   * ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.
+   */
   acs_credential_id_on_seam?: string | undefined
+  /**
+   * ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.
+   */
   acs_encoder_id: string
 
+  /**
+   * Scenario to simulate.
+   */
   scenario?:
     | 'credential_exists_on_seam'
     | 'credential_on_encoder_needs_update'

package/src/lib/seam/connect/routes/acs/entrances/entrances.ts

@@ -163,6 +163,9 @@ export class SeamHttpAcsEntrances {
     await clientSessions.get()
   }
 
+  /**
+   * Returns a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+   */
   get(
     parameters: AcsEntrancesGetParameters,
     options: AcsEntrancesGetOptions = {},
@@ -176,6 +179,9 @@ export class SeamHttpAcsEntrances {
     })
   }
 
+  /**
+   * Grants a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+   */
   grantAccess(
     parameters: AcsEntrancesGrantAccessParameters,
     options: AcsEntrancesGrantAccessOptions = {},
@@ -189,6 +195,9 @@ export class SeamHttpAcsEntrances {
     })
   }
 
+  /**
+   * Returns a list of all [access system entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+   */
   list(
     parameters?: AcsEntrancesListParameters,
     options: AcsEntrancesListOptions = {},
@@ -202,6 +211,9 @@ export class SeamHttpAcsEntrances {
     })
   }
 
+  /**
+   * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+   */
   listCredentialsWithAccess(
     parameters: AcsEntrancesListCredentialsWithAccessParameters,
     options: AcsEntrancesListCredentialsWithAccessOptions = {},
@@ -215,6 +227,9 @@ export class SeamHttpAcsEntrances {
     })
   }
 
+  /**
+   * Remotely unlocks a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.
+   */
   unlock(
     parameters: AcsEntrancesUnlockParameters,
     options: AcsEntrancesUnlockOptions = {},
@@ -230,6 +245,9 @@ export class SeamHttpAcsEntrances {
 }
 
 export type AcsEntrancesGetParameters = {
+  /**
+   * ID of the entrance that you want to get.
+   */
   acs_entrance_id: string
 }
 
@@ -246,9 +264,18 @@ export type AcsEntrancesGetRequest = SeamHttpRequest<
 export interface AcsEntrancesGetOptions {}
 
 export type AcsEntrancesGrantAccessParameters = {
+  /**
+   * ID of the entrance to which you want to grant an access system user access.
+   */
   acs_entrance_id: string
 
+  /**
+   * ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -262,16 +289,49 @@ export type AcsEntrancesGrantAccessRequest = SeamHttpRequest<void, undefined>
 export interface AcsEntrancesGrantAccessOptions {}
 
 export type AcsEntrancesListParameters = {
+  /**
+   * ID of the access method for which you want to retrieve all entrances to which it grants access.
+   */
   access_method_id?: string | undefined
+  /**
+   * ID of the credential for which you want to retrieve all entrances.
+   */
   acs_credential_id?: string | undefined
+  /**
+   * IDs of the entrances for which you want to retrieve all entrances.
+   */
   acs_entrance_ids?: Array<string> | undefined
+  /**
+   * ID of the access system for which you want to retrieve all entrances.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the connected account for which you want to retrieve all entrances.
+   */
   connected_account_id?: string | undefined
+  /**
+   * Customer key for which you want to list entrances.
+   */
   customer_key?: string | undefined
+  /**
+   * Maximum number of records to return per page.
+   */
   limit?: number | undefined
+  /**
+   * @deprecated Use `space_id`.
+   */
   location_id?: string | undefined
+  /**
+   * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+   */
   page_cursor?: string | undefined
+  /**
+   * String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`.
+   */
   search?: string | undefined
+  /**
+   * ID of the space for which you want to list entrances.
+   */
   space_id?: string | undefined
 }
 
@@ -288,8 +348,14 @@ export type AcsEntrancesListRequest = SeamHttpRequest<
 export interface AcsEntrancesListOptions {}
 
 export type AcsEntrancesListCredentialsWithAccessParameters = {
+  /**
+   * ID of the entrance for which you want to list all credentials that grant access.
+   */
   acs_entrance_id: string
 
+  /**
+   * Conditions that credentials must meet to be included in the returned list.
+   */
   include_if?: Array<'visionline_metadata.is_valid'> | undefined
 }
 
@@ -308,8 +374,14 @@ export type AcsEntrancesListCredentialsWithAccessRequest = SeamHttpRequest<
 export interface AcsEntrancesListCredentialsWithAccessOptions {}
 
 export type AcsEntrancesUnlockParameters = {
+  /**
+   * ID of the cloud_key credential to use for the unlock operation.
+   */
   acs_credential_id: string
 
+  /**
+   * ID of the entrance to unlock.
+   */
   acs_entrance_id: string
 }
 

package/src/lib/seam/connect/routes/acs/systems/systems.ts

@@ -161,6 +161,9 @@ export class SeamHttpAcsSystems {
     await clientSessions.get()
   }
 
+  /**
+   * Returns a specified [access system](https://docs.seam.co/low-level-apis/access-systems).
+   */
   get(
     parameters: AcsSystemsGetParameters,
     options: AcsSystemsGetOptions = {},
@@ -174,6 +177,11 @@ export class SeamHttpAcsSystems {
     })
   }
 
+  /**
+   * Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems).
+   *
+   * To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.
+   */
   list(
     parameters?: AcsSystemsListParameters,
     options: AcsSystemsListOptions = {},
@@ -187,6 +195,11 @@ export class SeamHttpAcsSystems {
     })
   }
 
+  /**
+   * Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/low-level-apis/access-systems).
+   *
+   * Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.
+   */
   listCompatibleCredentialManagerAcsSystems(
     parameters: AcsSystemsListCompatibleCredentialManagerAcsSystemsParameters,
     options: AcsSystemsListCompatibleCredentialManagerAcsSystemsOptions = {},
@@ -200,6 +213,9 @@ export class SeamHttpAcsSystems {
     })
   }
 
+  /**
+   * Reports ACS system device status including encoders and entrances.
+   */
   reportDevices(
     parameters: AcsSystemsReportDevicesParameters,
     options: AcsSystemsReportDevicesOptions = {},
@@ -215,6 +231,9 @@ export class SeamHttpAcsSystems {
 }
 
 export type AcsSystemsGetParameters = {
+  /**
+   * ID of the access system that you want to get.
+   */
   acs_system_id: string
 }
 
@@ -231,8 +250,17 @@ export type AcsSystemsGetRequest = SeamHttpRequest<
 export interface AcsSystemsGetOptions {}
 
 export type AcsSystemsListParameters = {
+  /**
+   * ID of the connected account by which you want to filter the list of access systems.
+   */
   connected_account_id?: string | undefined
+  /**
+   * Customer key for which you want to list access systems.
+   */
   customer_key?: string | undefined
+  /**
+   * String for which to search. Filters returned access systems to include all records that satisfy a partial match using `name` or `acs_system_id`.
+   */
   search?: string | undefined
 }
 
@@ -249,6 +277,9 @@ export type AcsSystemsListRequest = SeamHttpRequest<
 export interface AcsSystemsListOptions {}
 
 export type AcsSystemsListCompatibleCredentialManagerAcsSystemsParameters = {
+  /**
+   * ID of the access system for which you want to retrieve all compatible credential manager systems.
+   */
   acs_system_id: string
 }
 
@@ -268,28 +299,61 @@ export type AcsSystemsListCompatibleCredentialManagerAcsSystemsRequest =
 export interface AcsSystemsListCompatibleCredentialManagerAcsSystemsOptions {}
 
 export type AcsSystemsReportDevicesParameters = {
+  /**
+   * Array of ACS encoders to report
+   */
   acs_encoders?:
     | Array<{
+        /**
+         * Hotek-specific metadata associated with the entrance.
+         */
         hotek_metadata?:
           | {
+              /**
+               * The encoder number determined by the USB port connection.
+               */
               encoder_number?: string | undefined
             }
           | undefined
+        /**
+         * Whether the encoder is removed
+         */
         is_removed?: boolean | undefined
       }>
     | undefined
+  /**
+   * Array of ACS entrances to report
+   */
   acs_entrances?:
     | Array<{
+        /**
+         * Hotek-specific metadata associated with the entrance.
+         */
         hotek_metadata?:
           | {
+              /**
+               * The common area name
+               */
               common_area_name?: string | undefined
+              /**
+               * The room number identifier
+               */
               common_area_number?: string | undefined
+              /**
+               * The room number identifier
+               */
               room_number?: string | undefined
             }
           | undefined
+        /**
+         * Whether the entrance is removed
+         */
         is_removed?: boolean | undefined
       }>
     | undefined
+  /**
+   * ID of the ACS system to report resources for
+   */
   acs_system_id: string
 }