@seamapi/http 2.0.0 → 2.2.0

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

@@ -162,6 +162,9 @@ export class SeamHttpAcsUsers {
     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).
+   */
   addToAccessGroup(
     parameters: AcsUsersAddToAccessGroupParameters,
     options: AcsUsersAddToAccessGroupOptions = {},
@@ -175,6 +178,9 @@ export class SeamHttpAcsUsers {
     })
   }
 
+  /**
+   * Creates a new [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+   */
   create(
     parameters: AcsUsersCreateParameters,
     options: AcsUsersCreateOptions = {},
@@ -188,6 +194,9 @@ export class SeamHttpAcsUsers {
     })
   }
 
+  /**
+   * Deletes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+   */
   delete(
     parameters?: AcsUsersDeleteParameters,
     options: AcsUsersDeleteOptions = {},
@@ -201,6 +210,9 @@ export class SeamHttpAcsUsers {
     })
   }
 
+  /**
+   * Returns a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+   */
   get(
     parameters?: AcsUsersGetParameters,
     options: AcsUsersGetOptions = {},
@@ -214,6 +226,9 @@ export class SeamHttpAcsUsers {
     })
   }
 
+  /**
+   * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management).
+   */
   list(
     parameters?: AcsUsersListParameters,
     options: AcsUsersListOptions = {},
@@ -227,6 +242,9 @@ export class SeamHttpAcsUsers {
     })
   }
 
+  /**
+   * Lists the [entrances](https://docs.seam.co/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) has access.
+   */
   listAccessibleEntrances(
     parameters?: AcsUsersListAccessibleEntrancesParameters,
     options: AcsUsersListAccessibleEntrancesOptions = {},
@@ -240,6 +258,9 @@ export class SeamHttpAcsUsers {
     })
   }
 
+  /**
+   * 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).
+   */
   removeFromAccessGroup(
     parameters: AcsUsersRemoveFromAccessGroupParameters,
     options: AcsUsersRemoveFromAccessGroupOptions = {},
@@ -253,6 +274,9 @@ export class SeamHttpAcsUsers {
     })
   }
 
+  /**
+   * Revokes access to all [entrances](https://docs.seam.co/api/acs/entrances) for a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+   */
   revokeAccessToAllEntrances(
     parameters?: AcsUsersRevokeAccessToAllEntrancesParameters,
     options: AcsUsersRevokeAccessToAllEntrancesOptions = {},
@@ -266,6 +290,9 @@ export class SeamHttpAcsUsers {
     })
   }
 
+  /**
+   * [Suspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/api/acs/users/unsuspend) them.
+   */
   suspend(
     parameters?: AcsUsersSuspendParameters,
     options: AcsUsersSuspendOptions = {},
@@ -279,6 +306,9 @@ export class SeamHttpAcsUsers {
     })
   }
 
+  /**
+   * [Unsuspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.
+   */
   unsuspend(
     parameters?: AcsUsersUnsuspendParameters,
     options: AcsUsersUnsuspendOptions = {},
@@ -292,6 +322,9 @@ export class SeamHttpAcsUsers {
     })
   }
 
+  /**
+   * Updates the properties of a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+   */
   update(
     parameters?: AcsUsersUpdateParameters,
     options: AcsUsersUpdateOptions = {},
@@ -307,8 +340,14 @@ export class SeamHttpAcsUsers {
 }
 
 export type AcsUsersAddToAccessGroupParameters = {
+  /**
+   * 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.
+   */
   acs_user_id: string
 }
 
@@ -322,20 +361,50 @@ export type AcsUsersAddToAccessGroupRequest = SeamHttpRequest<void, undefined>
 export interface AcsUsersAddToAccessGroupOptions {}
 
 export type AcsUsersCreateParameters = {
+  /**
+   * `starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
+   */
   access_schedule?:
     | {
+        /**
+         * Ending timestamp for the new access system user's access.
+         */
         ends_at?: string | undefined
+        /**
+         * Starting timestamp for the new access system user's access.
+         */
         starts_at?: string | undefined
       }
     | undefined
+  /**
+   * Array of access group IDs to indicate the access groups to which you want to add the new access system user.
+   */
   acs_access_group_ids?: Array<string> | undefined
+  /**
+   * ID of the access system to which you want to add the new access system user.
+   */
   acs_system_id: string
 
+  /**
+   * @deprecated use email_address.
+   */
   email?: string | undefined
+  /**
+   * Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+   */
   email_address?: string | undefined
+  /**
+   * Full name of the new access system user.
+   */
   full_name: string
 
+  /**
+   * Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+   */
   phone_number?: string | undefined
+  /**
+   * ID of the user identity with which you want to associate the new access system user.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -352,8 +421,17 @@ export type AcsUsersCreateRequest = SeamHttpRequest<
 export interface AcsUsersCreateOptions {}
 
 export type AcsUsersDeleteParameters = {
+  /**
+   * ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -367,8 +445,17 @@ export type AcsUsersDeleteRequest = SeamHttpRequest<void, undefined>
 export interface AcsUsersDeleteOptions {}
 
 export type AcsUsersGetParameters = {
+  /**
+   * ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -385,13 +472,37 @@ export type AcsUsersGetRequest = SeamHttpRequest<
 export interface AcsUsersGetOptions {}
 
 export type AcsUsersListParameters = {
+  /**
+   * ID of the `acs_system` for which you want to retrieve all access system users.
+   */
   acs_system_id?: string | undefined
+  /**
+   * Timestamp by which to limit returned access system users. Returns users created before this timestamp.
+   */
   created_before?: string | undefined
+  /**
+   * Maximum number of records to return per page.
+   */
   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 access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.
+   */
   search?: string | undefined
+  /**
+   * Email address of the user identity for which you want to retrieve all access system users.
+   */
   user_identity_email_address?: string | undefined
+  /**
+   * ID of the user identity for which you want to retrieve all access system users.
+   */
   user_identity_id?: string | undefined
+  /**
+   * Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).
+   */
   user_identity_phone_number?: string | undefined
 }
 
@@ -408,8 +519,17 @@ export type AcsUsersListRequest = SeamHttpRequest<
 export interface AcsUsersListOptions {}
 
 export type AcsUsersListAccessibleEntrancesParameters = {
+  /**
+   * ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -428,9 +548,18 @@ export type AcsUsersListAccessibleEntrancesRequest = SeamHttpRequest<
 export interface AcsUsersListAccessibleEntrancesOptions {}
 
 export type AcsUsersRemoveFromAccessGroupParameters = {
+  /**
+   * 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. You can only provide acs_user_id or user_identity_id.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -447,8 +576,17 @@ export type AcsUsersRemoveFromAccessGroupRequest = SeamHttpRequest<
 export interface AcsUsersRemoveFromAccessGroupOptions {}
 
 export type AcsUsersRevokeAccessToAllEntrancesParameters = {
+  /**
+   * ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -465,8 +603,17 @@ export type AcsUsersRevokeAccessToAllEntrancesRequest = SeamHttpRequest<
 export interface AcsUsersRevokeAccessToAllEntrancesOptions {}
 
 export type AcsUsersSuspendParameters = {
+  /**
+   * ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -480,8 +627,17 @@ export type AcsUsersSuspendRequest = SeamHttpRequest<void, undefined>
 export interface AcsUsersSuspendOptions {}
 
 export type AcsUsersUnsuspendParameters = {
+  /**
+   * ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+   */
   acs_user_id?: string | undefined
+  /**
+   * ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+   */
   user_identity_id?: string | undefined
 }
 
@@ -495,19 +651,52 @@ export type AcsUsersUnsuspendRequest = SeamHttpRequest<void, undefined>
 export interface AcsUsersUnsuspendOptions {}
 
 export type AcsUsersUpdateParameters = {
+  /**
+   * `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
+   */
   access_schedule?:
     | {
+        /**
+         * Ending timestamp for the access system user's access.
+         */
         ends_at?: string | undefined
+        /**
+         * Starting timestamp for the access system user's access.
+         */
         starts_at?: string | undefined
       }
     | undefined
+  /**
+   * ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.
+   */
   acs_system_id?: string | undefined
+  /**
+   * ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.
+   */
   acs_user_id?: string | undefined
+  /**
+   * @deprecated use email_address.
+   */
   email?: string | undefined
+  /**
+   * Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+   */
   email_address?: string | undefined
+  /**
+   * Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+   */
   full_name?: string | undefined
+  /**
+   * ID of the HID access control system associated with the user.
+   */
   hid_acs_system_id?: string | undefined
+  /**
+   * Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+   */
   phone_number?: string | undefined
+  /**
+   * ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
+   */
   user_identity_id?: string | undefined
 }
 

package/src/lib/seam/connect/routes/action-attempts/action-attempts.ts

@@ -161,6 +161,9 @@ export class SeamHttpActionAttempts {
     await clientSessions.get()
   }
 
+  /**
+   * Returns a specified [action attempt](https://docs.seam.co/core-concepts/action-attempts).
+   */
   get(
     parameters: ActionAttemptsGetParameters,
     options: ActionAttemptsGetOptions = {},
@@ -174,6 +177,9 @@ export class SeamHttpActionAttempts {
     })
   }
 
+  /**
+   * Returns a list of the [action attempts](https://docs.seam.co/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.
+   */
   list(
     parameters?: ActionAttemptsListParameters,
     options: ActionAttemptsListOptions = {},
@@ -189,6 +195,9 @@ export class SeamHttpActionAttempts {
 }
 
 export type ActionAttemptsGetParameters = {
+  /**
+   * ID of the action attempt that you want to get.
+   */
   action_attempt_id: string
 }
 
@@ -208,9 +217,21 @@ export type ActionAttemptsGetOptions = Pick<
 >
 
 export type ActionAttemptsListParameters = {
+  /**
+   * IDs of the action attempts that you want to retrieve.
+   */
   action_attempt_ids?: Array<string> | undefined
+  /**
+   * ID of the device to filter action attempts by.
+   */
   device_id?: string | undefined
+  /**
+   * Maximum number of records to return per page.
+   */
   limit?: number | undefined
+  /**
+   * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+   */
   page_cursor?: string | undefined
 }
 

package/src/lib/seam/connect/routes/client-sessions/client-sessions.ts

@@ -160,6 +160,9 @@ export class SeamHttpClientSessions {
     await clientSessions.get()
   }
 
+  /**
+   * Creates a new [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+   */
   create(
     parameters?: ClientSessionsCreateParameters,
     options: ClientSessionsCreateOptions = {},
@@ -173,6 +176,9 @@ export class SeamHttpClientSessions {
     })
   }
 
+  /**
+   * Deletes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+   */
   delete(
     parameters: ClientSessionsDeleteParameters,
     options: ClientSessionsDeleteOptions = {},
@@ -186,6 +192,9 @@ export class SeamHttpClientSessions {
     })
   }
 
+  /**
+   * Returns a specified [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+   */
   get(
     parameters?: ClientSessionsGetParameters,
     options: ClientSessionsGetOptions = {},
@@ -199,6 +208,9 @@ export class SeamHttpClientSessions {
     })
   }
 
+  /**
+   * Returns a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist.
+   */
   getOrCreate(
     parameters?: ClientSessionsGetOrCreateParameters,
     options: ClientSessionsGetOrCreateOptions = {},
@@ -212,6 +224,9 @@ export class SeamHttpClientSessions {
     })
   }
 
+  /**
+   * Grants a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews), [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.
+   */
   grantAccess(
     parameters?: ClientSessionsGrantAccessParameters,
     options: ClientSessionsGrantAccessOptions = {},
@@ -225,6 +240,9 @@ export class SeamHttpClientSessions {
     })
   }
 
+  /**
+   * Returns a list of all [client sessions](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+   */
   list(
     parameters?: ClientSessionsListParameters,
     options: ClientSessionsListOptions = {},
@@ -238,6 +256,11 @@ export class SeamHttpClientSessions {
     })
   }
 
+  /**
+   * Revokes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+   *
+   * Note that [deleting a client session](https://docs.seam.co/api/client_sessions/delete) is a separate action.
+   */
   revoke(
     parameters: ClientSessionsRevokeParameters,
     options: ClientSessionsRevokeOptions = {},
@@ -253,13 +276,38 @@ export class SeamHttpClientSessions {
 }
 
 export type ClientSessionsCreateParameters = {
+  /**
+   * IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) for which you want to create a client session.
+   */
   connect_webview_ids?: Array<string> | undefined
+  /**
+   * IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) for which you want to create a client session.
+   */
   connected_account_ids?: Array<string> | undefined
+  /**
+   * Customer ID that you want to associate with the new client session.
+   */
   customer_id?: string | undefined
+  /**
+   * Customer key that you want to associate with the new client session.
+   */
   customer_key?: string | undefined
+  /**
+   * Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   expires_at?: string | undefined
+  /**
+   * Your user ID for the user for whom you want to create a client session.
+   */
   user_identifier_key?: string | undefined
+  /**
+   * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.
+   */
   user_identity_id?: string | undefined
+  /**
+   * IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+   * @deprecated Use `user_identity_id` instead.
+   */
   user_identity_ids?: Array<string> | undefined
 }
 
@@ -276,6 +324,9 @@ export type ClientSessionsCreateRequest = SeamHttpRequest<
 export interface ClientSessionsCreateOptions {}
 
 export type ClientSessionsDeleteParameters = {
+  /**
+   * ID of the client session that you want to delete.
+   */
   client_session_id: string
 }
 
@@ -289,7 +340,13 @@ export type ClientSessionsDeleteRequest = SeamHttpRequest<void, undefined>
 export interface ClientSessionsDeleteOptions {}
 
 export type ClientSessionsGetParameters = {
+  /**
+   * ID of the client session that you want to get.
+   */
   client_session_id?: string | undefined
+  /**
+   * User identifier key associated with the client session that you want to get.
+   */
   user_identifier_key?: string | undefined
 }
 
@@ -306,11 +363,30 @@ export type ClientSessionsGetRequest = SeamHttpRequest<
 export interface ClientSessionsGetOptions {}
 
 export type ClientSessionsGetOrCreateParameters = {
+  /**
+   * IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).
+   */
   connect_webview_ids?: Array<string> | undefined
+  /**
+   * IDs of the [connected accounts](https://docs.seam.co/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session).
+   */
   connected_account_ids?: Array<string> | undefined
+  /**
+   * Date and time at which the client session should expire in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. If the client session already exists, this will update the expiration before returning it.
+   */
   expires_at?: string | undefined
+  /**
+   * Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).
+   */
   user_identifier_key?: string | undefined
+  /**
+   * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).
+   */
   user_identity_id?: string | undefined
+  /**
+   * IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+   * @deprecated Use `user_identity_id`.
+   */
   user_identity_ids?: Array<string> | undefined
 }
 
@@ -329,11 +405,30 @@ export type ClientSessionsGetOrCreateRequest = SeamHttpRequest<
 export interface ClientSessionsGetOrCreateOptions {}
 
 export type ClientSessionsGrantAccessParameters = {
+  /**
+   * ID of the client session to which you want to grant access to resources.
+   */
   client_session_id?: string | undefined
+  /**
+   * IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) that you want to associate with the client session.
+   */
   connect_webview_ids?: Array<string> | undefined
+  /**
+   * IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that you want to associate with the client session.
+   */
   connected_account_ids?: Array<string> | undefined
+  /**
+   * Your user ID for the user that you want to associate with the client session.
+   */
   user_identifier_key?: string | undefined
+  /**
+   * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+   */
   user_identity_id?: string | undefined
+  /**
+   * IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+   * @deprecated Use `user_identity_id`.
+   */
   user_identity_ids?: Array<string> | undefined
 }
 
@@ -347,10 +442,25 @@ export type ClientSessionsGrantAccessRequest = SeamHttpRequest<void, undefined>
 export interface ClientSessionsGrantAccessOptions {}
 
 export type ClientSessionsListParameters = {
+  /**
+   * ID of the client session that you want to retrieve.
+   */
   client_session_id?: string | undefined
+  /**
+   * ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions.
+   */
   connect_webview_id?: string | undefined
+  /**
+   * Your user ID for the user by which you want to filter client sessions.
+   */
   user_identifier_key?: string | undefined
+  /**
+   * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions.
+   */
   user_identity_id?: string | undefined
+  /**
+   * Indicates whether to retrieve only client sessions without associated user identifier keys.
+   */
   without_user_identifier_key?: boolean | undefined
 }
 
@@ -369,6 +479,9 @@ export type ClientSessionsListRequest = SeamHttpRequest<
 export interface ClientSessionsListOptions {}
 
 export type ClientSessionsRevokeParameters = {
+  /**
+   * ID of the client session that you want to revoke.
+   */
   client_session_id: string
 }