/* * Automatically generated by codegen/smith.ts. * Do not edit this file or add other files to this directory. */ import { seamApiLtsVersion } from 'lib/lts-version.js' import { getAuthHeadersForClientSessionToken, warnOnInsecureuserIdentifierKey, } from 'lib/seam/connect/auth.js' import { type Client, createClient } from 'lib/seam/connect/client.js' import { isSeamHttpOptionsWithApiKey, isSeamHttpOptionsWithClient, isSeamHttpOptionsWithClientSessionToken, isSeamHttpOptionsWithConsoleSessionToken, isSeamHttpOptionsWithPersonalAccessToken, type SeamHttpFromPublishableKeyOptions, SeamHttpInvalidOptionsError, type SeamHttpOptions, type SeamHttpOptionsWithApiKey, type SeamHttpOptionsWithClient, type SeamHttpOptionsWithClientSessionToken, type SeamHttpOptionsWithConsoleSessionToken, type SeamHttpOptionsWithPersonalAccessToken, type SeamHttpRequestOptions, } from 'lib/seam/connect/options.js' import { limitToSeamHttpRequestOptions, parseOptions, } from 'lib/seam/connect/parse-options.js' import type { AcsAccessGroup } from 'lib/seam/connect/resources/acs-access-group.js' import type { AcsEntrance } from 'lib/seam/connect/resources/acs-entrance.js' import type { AcsUser } from 'lib/seam/connect/resources/acs-user.js' import { SeamHttpClientSessions } from 'lib/seam/connect/routes/client-sessions/index.js' import { SeamHttpRequest } from 'lib/seam/connect/seam-http-request.js' import { SeamPaginator } from 'lib/seam/connect/seam-paginator.js' export class SeamHttpAcsAccessGroups { client: Client readonly defaults: Required readonly ltsVersion = seamApiLtsVersion static ltsVersion = seamApiLtsVersion constructor(apiKeyOrOptions: string | SeamHttpOptions = {}) { const options = parseOptions(apiKeyOrOptions) this.client = 'client' in options ? options.client : createClient(options) this.defaults = limitToSeamHttpRequestOptions(options) } static fromClient( client: SeamHttpOptionsWithClient['client'], options: Omit = {}, ): SeamHttpAcsAccessGroups { const constructorOptions = { ...options, client } if (!isSeamHttpOptionsWithClient(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing client') } return new SeamHttpAcsAccessGroups(constructorOptions) } static fromApiKey( apiKey: SeamHttpOptionsWithApiKey['apiKey'], options: Omit = {}, ): SeamHttpAcsAccessGroups { const constructorOptions = { ...options, apiKey } if (!isSeamHttpOptionsWithApiKey(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing apiKey') } return new SeamHttpAcsAccessGroups(constructorOptions) } static fromClientSessionToken( clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], options: Omit< SeamHttpOptionsWithClientSessionToken, 'clientSessionToken' > = {}, ): SeamHttpAcsAccessGroups { const constructorOptions = { ...options, clientSessionToken } if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing clientSessionToken') } return new SeamHttpAcsAccessGroups(constructorOptions) } static async fromPublishableKey( publishableKey: string, userIdentifierKey: string, options: SeamHttpFromPublishableKeyOptions = {}, ): Promise { warnOnInsecureuserIdentifierKey(userIdentifierKey) const clientOptions = parseOptions({ ...options, publishableKey }) if (isSeamHttpOptionsWithClient(clientOptions)) { throw new SeamHttpInvalidOptionsError( 'The client option cannot be used with SeamHttpAcsAccessGroups.fromPublishableKey', ) } const client = createClient(clientOptions) const clientSessions = SeamHttpClientSessions.fromClient(client) const { token } = await clientSessions.getOrCreate({ user_identifier_key: userIdentifierKey, }) return SeamHttpAcsAccessGroups.fromClientSessionToken(token, options) } static fromConsoleSessionToken( consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options: Omit< SeamHttpOptionsWithConsoleSessionToken, 'consoleSessionToken' | 'workspaceId' > = {}, ): SeamHttpAcsAccessGroups { const constructorOptions = { ...options, consoleSessionToken, workspaceId } if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError( 'Missing consoleSessionToken or workspaceId', ) } return new SeamHttpAcsAccessGroups(constructorOptions) } static fromPersonalAccessToken( personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options: Omit< SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId' > = {}, ): SeamHttpAcsAccessGroups { const constructorOptions = { ...options, personalAccessToken, workspaceId } if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError( 'Missing personalAccessToken or workspaceId', ) } return new SeamHttpAcsAccessGroups(constructorOptions) } createPaginator( request: SeamHttpRequest, ): SeamPaginator { return new SeamPaginator(this, request) } async updateClientSessionToken( clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], ): Promise { const { headers } = this.client.defaults const authHeaders = getAuthHeadersForClientSessionToken({ clientSessionToken, }) for (const key of Object.keys(authHeaders)) { if (headers[key] == null) { throw new Error( 'Cannot update a clientSessionToken on a client created without a clientSessionToken', ) } } this.client.defaults.headers = { ...headers, ...authHeaders } const clientSessions = SeamHttpClientSessions.fromClient(this.client) 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 = {}, ): AcsAccessGroupsAddUserRequest { return new SeamHttpRequest(this, { pathname: '/acs/access_groups/add_user', method: 'PUT', body: parameters, responseKey: undefined, options, }) } /** * 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 = {}, ): AcsAccessGroupsDeleteRequest { return new SeamHttpRequest(this, { pathname: '/acs/access_groups/delete', method: 'POST', body: parameters, responseKey: undefined, options, }) } /** * 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 = {}, ): AcsAccessGroupsGetRequest { return new SeamHttpRequest(this, { pathname: '/acs/access_groups/get', method: 'POST', body: parameters, responseKey: 'acs_access_group', options, }) } /** * 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 = {}, ): AcsAccessGroupsListRequest { return new SeamHttpRequest(this, { pathname: '/acs/access_groups/list', method: 'POST', body: parameters, responseKey: 'acs_access_groups', options, }) } /** * 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 = {}, ): AcsAccessGroupsListAccessibleEntrancesRequest { return new SeamHttpRequest(this, { pathname: '/acs/access_groups/list_accessible_entrances', method: 'POST', body: parameters, responseKey: 'acs_entrances', options, }) } /** * 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 = {}, ): AcsAccessGroupsListUsersRequest { return new SeamHttpRequest(this, { pathname: '/acs/access_groups/list_users', method: 'POST', body: parameters, responseKey: 'acs_users', options, }) } /** * 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 = {}, ): AcsAccessGroupsRemoveUserRequest { return new SeamHttpRequest(this, { pathname: '/acs/access_groups/remove_user', method: 'POST', body: parameters, responseKey: undefined, options, }) } } 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 } /** * @deprecated Use AcsAccessGroupsAddUserRequest instead. */ export type AcsAccessGroupsAddUserResponse = void export type AcsAccessGroupsAddUserRequest = SeamHttpRequest export interface AcsAccessGroupsAddUserOptions {} export type AcsAccessGroupsDeleteParameters = { /** * ID of the access group that you want to delete. */ acs_access_group_id: string } /** * @deprecated Use AcsAccessGroupsDeleteRequest instead. */ export type AcsAccessGroupsDeleteResponse = void export type AcsAccessGroupsDeleteRequest = SeamHttpRequest export interface AcsAccessGroupsDeleteOptions {} export type AcsAccessGroupsGetParameters = { /** * ID of the access group that you want to get. */ acs_access_group_id: string } /** * @deprecated Use AcsAccessGroupsGetRequest instead. */ export type AcsAccessGroupsGetResponse = { acs_access_group: AcsAccessGroup } export type AcsAccessGroupsGetRequest = SeamHttpRequest< AcsAccessGroupsGetResponse, 'acs_access_group' > 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 } /** * @deprecated Use AcsAccessGroupsListRequest instead. */ export type AcsAccessGroupsListResponse = { acs_access_groups: Array } export type AcsAccessGroupsListRequest = SeamHttpRequest< AcsAccessGroupsListResponse, 'acs_access_groups' > 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 } /** * @deprecated Use AcsAccessGroupsListAccessibleEntrancesRequest instead. */ export type AcsAccessGroupsListAccessibleEntrancesResponse = { acs_entrances: Array } export type AcsAccessGroupsListAccessibleEntrancesRequest = SeamHttpRequest< AcsAccessGroupsListAccessibleEntrancesResponse, 'acs_entrances' > 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 } /** * @deprecated Use AcsAccessGroupsListUsersRequest instead. */ export type AcsAccessGroupsListUsersResponse = { acs_users: Array } export type AcsAccessGroupsListUsersRequest = SeamHttpRequest< AcsAccessGroupsListUsersResponse, 'acs_users' > 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 } /** * @deprecated Use AcsAccessGroupsRemoveUserRequest instead. */ export type AcsAccessGroupsRemoveUserResponse = void export type AcsAccessGroupsRemoveUserRequest = SeamHttpRequest export interface AcsAccessGroupsRemoveUserOptions {}