@seamapi/http 2.0.0 → 2.2.0

package/src/lib/seam/connect/routes/acs/access-groups/access-groups.ts

@@ -163,6 +163,9 @@ export class SeamHttpAcsAccessGroups {
     await clientSessions.get()
   }
 
+  /**
+   * Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+   */
   addUser(
     parameters: AcsAccessGroupsAddUserParameters,
     options: AcsAccessGroupsAddUserOptions = {},
@@ -176,6 +179,9 @@ export class SeamHttpAcsAccessGroups {
     })
   }
 
+  /**
+   * Deletes a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+   */
   delete(
     parameters: AcsAccessGroupsDeleteParameters,
     options: AcsAccessGroupsDeleteOptions = {},
@@ -189,6 +195,9 @@ export class SeamHttpAcsAccessGroups {
     })
   }
 
+  /**
+   * Returns a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+   */
   get(
     parameters: AcsAccessGroupsGetParameters,
     options: AcsAccessGroupsGetOptions = {},
@@ -202,6 +211,9 @@ export class SeamHttpAcsAccessGroups {
     })
   }
 
+  /**
+   * Returns a list of all [access groups](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+   */
   list(
     parameters?: AcsAccessGroupsListParameters,
     options: AcsAccessGroupsListOptions = {},
@@ -215,6 +227,9 @@ export class SeamHttpAcsAccessGroups {
     })
   }
 
+  /**
+   * Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+   */
   listAccessibleEntrances(
     parameters: AcsAccessGroupsListAccessibleEntrancesParameters,
     options: AcsAccessGroupsListAccessibleEntrancesOptions = {},
@@ -228,6 +243,9 @@ export class SeamHttpAcsAccessGroups {
     })
   }
 
+  /**
+   * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+   */
   listUsers(
     parameters: AcsAccessGroupsListUsersParameters,
     options: AcsAccessGroupsListUsersOptions = {},
@@ -241,6 +259,9 @@ export class SeamHttpAcsAccessGroups {
     })
   }
 
+  /**
+   * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+   */
   removeUser(
     parameters: AcsAccessGroupsRemoveUserParameters,
     options: AcsAccessGroupsRemoveUserOptions = {},
@@ -256,9 +277,18 @@ export class SeamHttpAcsAccessGroups {
 }
 
 export type AcsAccessGroupsAddUserParameters = {
+  /**
+   * ID of the access group to which you want to add an access system user.
+   */
   acs_access_group_id: string
 
+  /**
+   * ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the desired user identity that you want to add to an access group. 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
 }
 
@@ -272,6 +302,9 @@ export type AcsAccessGroupsAddUserRequest = SeamHttpRequest<void, undefined>
 export interface AcsAccessGroupsAddUserOptions {}
 
 export type AcsAccessGroupsDeleteParameters = {
+  /**
+   * ID of the access group that you want to delete.
+   */
   acs_access_group_id: string
 }
 
@@ -285,6 +318,9 @@ export type AcsAccessGroupsDeleteRequest = SeamHttpRequest<void, undefined>
 export interface AcsAccessGroupsDeleteOptions {}
 
 export type AcsAccessGroupsGetParameters = {
+  /**
+   * ID of the access group that you want to get.
+   */
   acs_access_group_id: string
 }
 
@@ -301,9 +337,21 @@ export type AcsAccessGroupsGetRequest = SeamHttpRequest<
 export interface AcsAccessGroupsGetOptions {}
 
 export type AcsAccessGroupsListParameters = {
+  /**
+   * ID of the access system for which you want to retrieve all access groups.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the access system user for which you want to retrieve all access groups.
+   */
   acs_user_id?: string | undefined
+  /**
+   * String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`.
+   */
   search?: string | undefined
+  /**
+   * ID of the user identity for which you want to retrieve all access groups.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -322,6 +370,9 @@ export type AcsAccessGroupsListRequest = SeamHttpRequest<
 export interface AcsAccessGroupsListOptions {}
 
 export type AcsAccessGroupsListAccessibleEntrancesParameters = {
+  /**
+   * ID of the access group for which you want to retrieve all accessible entrances.
+   */
   acs_access_group_id: string
 }
 
@@ -340,6 +391,9 @@ export type AcsAccessGroupsListAccessibleEntrancesRequest = SeamHttpRequest<
 export interface AcsAccessGroupsListAccessibleEntrancesOptions {}
 
 export type AcsAccessGroupsListUsersParameters = {
+  /**
+   * ID of the access group for which you want to retrieve all access system users.
+   */
   acs_access_group_id: string
 }
 
@@ -356,9 +410,18 @@ export type AcsAccessGroupsListUsersRequest = SeamHttpRequest<
 export interface AcsAccessGroupsListUsersOptions {}
 
 export type AcsAccessGroupsRemoveUserParameters = {
+  /**
+   * ID of the access group from which you want to remove an access system user.
+   */
   acs_access_group_id: string
 
+  /**
+   * ID of the access system user that you want to remove from an access group.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the user identity associated with the user that you want to remove from an access group.
+   */
   user_identity_id?: string | undefined
 }
 

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

@@ -162,6 +162,9 @@ export class SeamHttpAcsCredentials {
     await clientSessions.get()
   }
 
+  /**
+   * Assigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+   */
   assign(
     parameters: AcsCredentialsAssignParameters,
     options: AcsCredentialsAssignOptions = {},
@@ -175,6 +178,9 @@ export class SeamHttpAcsCredentials {
     })
   }
 
+  /**
+   * Creates a new [credential](https://docs.seam.co/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
+   */
   create(
     parameters: AcsCredentialsCreateParameters,
     options: AcsCredentialsCreateOptions = {},
@@ -188,6 +194,9 @@ export class SeamHttpAcsCredentials {
     })
   }
 
+  /**
+   * Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+   */
   delete(
     parameters: AcsCredentialsDeleteParameters,
     options: AcsCredentialsDeleteOptions = {},
@@ -201,6 +210,9 @@ export class SeamHttpAcsCredentials {
     })
   }
 
+  /**
+   * Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+   */
   get(
     parameters: AcsCredentialsGetParameters,
     options: AcsCredentialsGetOptions = {},
@@ -214,6 +226,9 @@ export class SeamHttpAcsCredentials {
     })
   }
 
+  /**
+   * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+   */
   list(
     parameters?: AcsCredentialsListParameters,
     options: AcsCredentialsListOptions = {},
@@ -227,6 +242,9 @@ export class SeamHttpAcsCredentials {
     })
   }
 
+  /**
+   * Returns a list of all [entrances](https://docs.seam.co/api/acs/entrances) to which a [credential](https://docs.seam.co/api/acs/credentials) grants access.
+   */
   listAccessibleEntrances(
     parameters: AcsCredentialsListAccessibleEntrancesParameters,
     options: AcsCredentialsListAccessibleEntrancesOptions = {},
@@ -240,6 +258,9 @@ export class SeamHttpAcsCredentials {
     })
   }
 
+  /**
+   * Unassigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+   */
   unassign(
     parameters: AcsCredentialsUnassignParameters,
     options: AcsCredentialsUnassignOptions = {},
@@ -253,6 +274,9 @@ export class SeamHttpAcsCredentials {
     })
   }
 
+  /**
+   * Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+   */
   update(
     parameters: AcsCredentialsUpdateParameters,
     options: AcsCredentialsUpdateOptions = {},
@@ -268,9 +292,18 @@ export class SeamHttpAcsCredentials {
 }
 
 export type AcsCredentialsAssignParameters = {
+  /**
+   * ID of the credential that you want to assign to an access system user.
+   */
   acs_credential_id: string
 
+  /**
+   * ID of the access system user to whom you want to assign a credential. 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 assign a credential. 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 credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -284,36 +317,85 @@ export type AcsCredentialsAssignRequest = SeamHttpRequest<void, undefined>
 export interface AcsCredentialsAssignOptions {}
 
 export type AcsCredentialsCreateParameters = {
+  /**
+   * Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+   */
   access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
 
+  /**
+   * ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
+   */
   acs_user_id?: string | undefined
+  /**
+   * Set of IDs of the [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access.
+   */
   allowed_acs_entrance_ids?: Array<string> | undefined
+  /**
+   * Vostio-specific metadata for the new credential.
+   */
   assa_abloy_vostio_metadata?:
     | {
         auto_join?: boolean | undefined
+
         join_all_guest_acs_entrances?: boolean | undefined
+
         override_all_guest_acs_entrances?: boolean | undefined
+
         override_guest_acs_entrance_ids?: Array<string> | undefined
       }
     | undefined
+  /**
+   * Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/device-and-system-integration-guides).
+   */
   code?: string | undefined
+  /**
+   * ACS system ID of the credential manager for the new credential.
+   */
   credential_manager_acs_system_id?: string | undefined
+  /**
+   * Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+   */
   ends_at?: string | undefined
+  /**
+   * Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+   */
   is_multi_phone_sync_credential?: boolean | undefined
+  /**
+   * Salto Space-specific metadata for the new credential.
+   */
   salto_space_metadata?:
     | {
+        /**
+         * Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).
+         */
         assign_new_key?: boolean | undefined
       }
     | undefined
+  /**
+   * Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   starts_at?: string | undefined
+  /**
+   * ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.
+   */
   user_identity_id?: string | undefined
+  /**
+   * Visionline-specific metadata for the new credential.
+   */
   visionline_metadata?:
     | {
         auto_join?: boolean | undefined
+
         card_format?: 'TLCode' | 'rfid48' | undefined
+
         card_function_type?: 'guest' | 'staff' | undefined
+
         joiner_acs_credential_ids?: Array<string> | undefined
+
         override?: boolean | undefined
       }
     | undefined
@@ -332,6 +414,9 @@ export type AcsCredentialsCreateRequest = SeamHttpRequest<
 export interface AcsCredentialsCreateOptions {}
 
 export type AcsCredentialsDeleteParameters = {
+  /**
+   * ID of the credential that you want to delete.
+   */
   acs_credential_id: string
 }
 
@@ -345,6 +430,9 @@ export type AcsCredentialsDeleteRequest = SeamHttpRequest<void, undefined>
 export interface AcsCredentialsDeleteOptions {}
 
 export type AcsCredentialsGetParameters = {
+  /**
+   * ID of the credential that you want to get.
+   */
   acs_credential_id: string
 }
 
@@ -361,13 +449,37 @@ export type AcsCredentialsGetRequest = SeamHttpRequest<
 export interface AcsCredentialsGetOptions {}
 
 export type AcsCredentialsListParameters = {
+  /**
+   * ID of the access system user for which you want to retrieve all credentials.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the access system for which you want to retrieve all credentials.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the user identity for which you want to retrieve all credentials.
+   */
   user_identity_id?: string | undefined
+  /**
+   * Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.
+   */
   created_before?: string | undefined
+  /**
+   * Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.
+   */
   is_multi_phone_sync_credential?: boolean | undefined
+  /**
+   * Number of credentials to return.
+   */
   limit?: number | 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 credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.
+   */
   search?: string | undefined
 }
 
@@ -386,6 +498,9 @@ export type AcsCredentialsListRequest = SeamHttpRequest<
 export interface AcsCredentialsListOptions {}
 
 export type AcsCredentialsListAccessibleEntrancesParameters = {
+  /**
+   * ID of the credential for which you want to retrieve all entrances to which the credential grants access.
+   */
   acs_credential_id: string
 }
 
@@ -404,9 +519,18 @@ export type AcsCredentialsListAccessibleEntrancesRequest = SeamHttpRequest<
 export interface AcsCredentialsListAccessibleEntrancesOptions {}
 
 export type AcsCredentialsUnassignParameters = {
+  /**
+   * ID of the credential that you want to unassign from an access system user.
+   */
   acs_credential_id: string
 
+  /**
+   * ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -420,9 +544,18 @@ export type AcsCredentialsUnassignRequest = SeamHttpRequest<void, undefined>
 export interface AcsCredentialsUnassignOptions {}
 
 export type AcsCredentialsUpdateParameters = {
+  /**
+   * ID of the credential that you want to update.
+   */
   acs_credential_id: string
 
+  /**
+   * Replacement access (PIN) code for the credential that you want to update.
+   */
   code?: string | undefined
+  /**
+   * Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential.
+   */
   ends_at?: string | undefined
 }
 

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

@@ -168,6 +168,9 @@ export class SeamHttpAcsEncoders {
     return SeamHttpAcsEncodersSimulate.fromClient(this.client, this.defaults)
   }
 
+  /**
+   * Encodes an existing [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
+   */
   encodeCredential(
     parameters: AcsEncodersEncodeCredentialParameters,
     options: AcsEncodersEncodeCredentialOptions = {},
@@ -181,6 +184,9 @@ export class SeamHttpAcsEncoders {
     })
   }
 
+  /**
+   * Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+   */
   get(
     parameters: AcsEncodersGetParameters,
     options: AcsEncodersGetOptions = {},
@@ -194,6 +200,9 @@ export class SeamHttpAcsEncoders {
     })
   }
 
+  /**
+   * Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+   */
   list(
     parameters?: AcsEncodersListParameters,
     options: AcsEncodersListOptions = {},
@@ -207,6 +216,9 @@ export class SeamHttpAcsEncoders {
     })
   }
 
+  /**
+   * Scans an encoded [acs_credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+   */
   scanCredential(
     parameters: AcsEncodersScanCredentialParameters,
     options: AcsEncodersScanCredentialOptions = {},
@@ -220,6 +232,9 @@ export class SeamHttpAcsEncoders {
     })
   }
 
+  /**
+   * Scans a physical card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
+   */
   scanToAssignCredential(
     parameters: AcsEncodersScanToAssignCredentialParameters,
     options: AcsEncodersScanToAssignCredentialOptions = {},
@@ -235,8 +250,17 @@ export class SeamHttpAcsEncoders {
 }
 
 export type AcsEncodersEncodeCredentialParameters = {
+  /**
+   * ID of the `access_method` to encode onto a card.
+   */
   access_method_id?: string | undefined
+  /**
+   * ID of the `acs_credential` to encode onto a card.
+   */
   acs_credential_id?: string | undefined
+  /**
+   * ID of the `acs_encoder` to use to encode the `acs_credential`.
+   */
   acs_encoder_id: string
 }
 
@@ -258,6 +282,9 @@ export type AcsEncodersEncodeCredentialOptions = Pick<
 >
 
 export type AcsEncodersGetParameters = {
+  /**
+   * ID of the encoder that you want to get.
+   */
   acs_encoder_id: string
 }
 
@@ -274,10 +301,25 @@ export type AcsEncodersGetRequest = SeamHttpRequest<
 export interface AcsEncodersGetOptions {}
 
 export type AcsEncodersListParameters = {
+  /**
+   * ID of the access system for which you want to retrieve all encoders.
+   */
   acs_system_id?: string | undefined
+  /**
+   * IDs of the access systems for which you want to retrieve all encoders.
+   */
   acs_system_ids?: Array<string> | undefined
+  /**
+   * IDs of the encoders that you want to retrieve.
+   */
   acs_encoder_ids?: Array<string> | undefined
+  /**
+   * Number of encoders to return.
+   */
   limit?: number | undefined
+  /**
+   * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+   */
   page_cursor?: string | undefined
 }
 
@@ -294,10 +336,19 @@ export type AcsEncodersListRequest = SeamHttpRequest<
 export interface AcsEncodersListOptions {}
 
 export type AcsEncodersScanCredentialParameters = {
+  /**
+   * ID of the encoder to use for the scan.
+   */
   acs_encoder_id: string
 
+  /**
+   * Salto KS-specific metadata for the scan action.
+   */
   salto_ks_metadata?:
     | {
+        /**
+         * When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.
+         */
         detect_new_tags?: boolean | undefined
       }
     | undefined
@@ -321,14 +372,29 @@ export type AcsEncodersScanCredentialOptions = Pick<
 >
 
 export type AcsEncodersScanToAssignCredentialParameters = {
+  /**
+   * ID of the `acs_encoder` to use to scan the credential.
+   */
   acs_encoder_id: string
 
+  /**
+   * ID of the `acs_user` to assign the scanned credential to.
+   */
   acs_user_id?: string | undefined
+  /**
+   * Salto KS-specific metadata for the scan action.
+   */
   salto_ks_metadata?:
     | {
+        /**
+         * When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.
+         */
         detect_new_tags?: boolean | undefined
       }
     | undefined
+  /**
+   * ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.
+   */
   user_identity_id?: string | undefined
 }