/** * User Service API * Solomon AI User Service API - Manages user profiles and authentication * * The version of the OpenAPI document: 1.0 * Contact: yoanyomba@solomon-ai.co * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /// import http from 'http'; import { AcceptTeamMemberInvitationBody } from '../model/acceptTeamMemberInvitationBody'; import { AcceptTeamMemberInvitationResponse } from '../model/acceptTeamMemberInvitationResponse'; import { AddOrganizationMemberToOrganizationBody } from '../model/addOrganizationMemberToOrganizationBody'; import { AddOrganizationMemberToOrganizationResponse } from '../model/addOrganizationMemberToOrganizationResponse'; import { AddRoleToTenantTeamBody } from '../model/addRoleToTenantTeamBody'; import { AddRoleToTenantTeamResponse } from '../model/addRoleToTenantTeamResponse'; import { AddTenantMemberBody } from '../model/addTenantMemberBody'; import { AddTenantMemberResponse } from '../model/addTenantMemberResponse'; import { AddUserToTeamBody } from '../model/addUserToTeamBody'; import { AddUserToTeamResponse } from '../model/addUserToTeamResponse'; import { BulkAddTeamMembersBody } from '../model/bulkAddTeamMembersBody'; import { BulkAddTeamMembersResponse } from '../model/bulkAddTeamMembersResponse'; import { BulkRemoveTeamMembersBody } from '../model/bulkRemoveTeamMembersBody'; import { BulkRemoveTeamMembersResponse } from '../model/bulkRemoveTeamMembersResponse'; import { BulkRevokeOrgAPIKeysRequest } from '../model/bulkRevokeOrgAPIKeysRequest'; import { BulkRevokeOrgAPIKeysResponse } from '../model/bulkRevokeOrgAPIKeysResponse'; import { CheckEmailAndAuth0UserIdExistsResponse } from '../model/checkEmailAndAuth0UserIdExistsResponse'; import { CheckEmailExistsV2Response } from '../model/checkEmailExistsV2Response'; import { CheckUsernameExistsV2Response } from '../model/checkUsernameExistsV2Response'; import { CreateOrganizationApiKeyRequest } from '../model/createOrganizationApiKeyRequest'; import { CreateOrganizationApiKeyResponse } from '../model/createOrganizationApiKeyResponse'; import { CreateOrganizationRequest } from '../model/createOrganizationRequest'; import { CreateOrganizationResponse } from '../model/createOrganizationResponse'; import { CreateRoleResponse } from '../model/createRoleResponse'; import { CreateTeamRequest } from '../model/createTeamRequest'; import { CreateTeamResponse } from '../model/createTeamResponse'; import { CreateTenantApiKeyRequest } from '../model/createTenantApiKeyRequest'; import { CreateTenantApiKeyResponse } from '../model/createTenantApiKeyResponse'; import { CreateTenantRequest } from '../model/createTenantRequest'; import { CreateTenantResponse } from '../model/createTenantResponse'; import { CreateTenantTeamRequest } from '../model/createTenantTeamRequest'; import { CreateTenantTeamResponse } from '../model/createTenantTeamResponse'; import { CreateUserV2Request } from '../model/createUserV2Request'; import { CreateUserV2Response } from '../model/createUserV2Response'; import { DeleteOrganizationApiKeyResponse } from '../model/deleteOrganizationApiKeyResponse'; import { DeleteOrganizationResponse } from '../model/deleteOrganizationResponse'; import { DeleteRoleFromTenantTeamResponse } from '../model/deleteRoleFromTenantTeamResponse'; import { DeleteRoleResponse } from '../model/deleteRoleResponse'; import { DeleteTeamResponse } from '../model/deleteTeamResponse'; import { DeleteTenantApiKeyResponse } from '../model/deleteTenantApiKeyResponse'; import { DeleteTenantResponse } from '../model/deleteTenantResponse'; import { DeleteTenantTeamResponse } from '../model/deleteTenantTeamResponse'; import { DeleteUserV2Response } from '../model/deleteUserV2Response'; import { GetBusinessSettingsResponse } from '../model/getBusinessSettingsResponse'; import { GetCannyUserSSOTokenResponse } from '../model/getCannyUserSSOTokenResponse'; import { GetOrgAPIKeyPermissionsResponse } from '../model/getOrgAPIKeyPermissionsResponse'; import { GetOrganizationMemberResponse } from '../model/getOrganizationMemberResponse'; import { GetOrganizationResponse } from '../model/getOrganizationResponse'; import { GetRoleResponse } from '../model/getRoleResponse'; import { GetTeamResponse } from '../model/getTeamResponse'; import { GetTenantResponse } from '../model/getTenantResponse'; import { GetTenantTeamResponse } from '../model/getTenantTeamResponse'; import { GetUserByAuth0IDResponse } from '../model/getUserByAuth0IDResponse'; import { GetUserByAuthnIDV2Response } from '../model/getUserByAuthnIDV2Response'; import { GetUserByEmailOrUsernameV2Response } from '../model/getUserByEmailOrUsernameV2Response'; import { GetUserByEmailV2Response } from '../model/getUserByEmailV2Response'; import { GetUserByUsernameV2Response } from '../model/getUserByUsernameV2Response'; import { GetUserIdV2Response } from '../model/getUserIdV2Response'; import { GetUserV2Response } from '../model/getUserV2Response'; import { HealthCheckResponse } from '../model/healthCheckResponse'; import { InviteTeamMemberBody } from '../model/inviteTeamMemberBody'; import { InviteTeamMemberResponse } from '../model/inviteTeamMemberResponse'; import { ListOrganizationApiKeysResponse } from '../model/listOrganizationApiKeysResponse'; import { ListOrganizationAuditLogsResponse } from '../model/listOrganizationAuditLogsResponse'; import { ListOrganizationMembersResponse } from '../model/listOrganizationMembersResponse'; import { ListOrganizationsResponse } from '../model/listOrganizationsResponse'; import { ListRolesFromTenantTeamResponse } from '../model/listRolesFromTenantTeamResponse'; import { ListRolesResponse } from '../model/listRolesResponse'; import { ListTeamInvitesResponse } from '../model/listTeamInvitesResponse'; import { ListTenantApiKeysResponse } from '../model/listTenantApiKeysResponse'; import { ListTenantAuditLogsResponse } from '../model/listTenantAuditLogsResponse'; import { ListTenantTeamMembersResponse } from '../model/listTenantTeamMembersResponse'; import { ListTenantsResponse } from '../model/listTenantsResponse'; import { Organization } from '../model/organization'; import { PasswordResetWebhookV2Response } from '../model/passwordResetWebhookV2Response'; import { ReadynessCheckResponse } from '../model/readynessCheckResponse'; import { RejectTeamMemberInvitationBody } from '../model/rejectTeamMemberInvitationBody'; import { RejectTeamMemberInvitationResponse } from '../model/rejectTeamMemberInvitationResponse'; import { RemoveOrganizationMemberFromOrganizationResponse } from '../model/removeOrganizationMemberFromOrganizationResponse'; import { RemoveTenantTeamMemberResponse } from '../model/removeTenantTeamMemberResponse'; import { RemoveUserFromTeamResponse } from '../model/removeUserFromTeamResponse'; import { Role } from '../model/role'; import { RotateOrgAPIKeyResponse } from '../model/rotateOrgAPIKeyResponse'; import { Team } from '../model/team'; import { UpdateOrganizationResponse } from '../model/updateOrganizationResponse'; import { UpdateRoleResponse } from '../model/updateRoleResponse'; import { UpdateTeamResponse } from '../model/updateTeamResponse'; import { UpdateTenantRequest } from '../model/updateTenantRequest'; import { UpdateTenantResponse } from '../model/updateTenantResponse'; import { UpdateTenantTeamMemberRequest } from '../model/updateTenantTeamMemberRequest'; import { UpdateTenantTeamMemberResponse } from '../model/updateTenantTeamMemberResponse'; import { UpdateTenantTeamResponse } from '../model/updateTenantTeamResponse'; import { UpdateUserV2Request } from '../model/updateUserV2Request'; import { UpdateUserV2Response } from '../model/updateUserV2Response'; import { VerifyOrgAPIKeyRequest } from '../model/verifyOrgAPIKeyRequest'; import { VerifyOrgAPIKeyResponse } from '../model/verifyOrgAPIKeyResponse'; import { VerifyUserV2Response } from '../model/verifyUserV2Response'; import { Authentication, Interceptor } from '../model/models'; import { ApiKeyAuth } from '../model/models'; export declare enum UserServiceV2ApiApiKeys { ApiKeyAuth = 0, Bearer = 1 } export declare class UserServiceV2Api { protected _basePath: string; protected _defaultHeaders: any; protected _useQuerystring: boolean; protected authentications: { default: Authentication; ApiKeyAuth: ApiKeyAuth; Bearer: ApiKeyAuth; }; protected interceptors: Interceptor[]; constructor(basePath?: string); set useQuerystring(value: boolean); set basePath(basePath: string); set defaultHeaders(defaultHeaders: any); get defaultHeaders(): any; get basePath(): string; setDefaultAuthentication(auth: Authentication): void; setApiKey(key: UserServiceV2ApiApiKeys, value: string): void; addInterceptor(interceptor: Interceptor): void; /** * This endpoint accepts an invitation for a member to join a tenant based on the provided tenant ID and member email.The acceptance process ensures that the member is properly associated with the tenant. * @summary Accepts a team member invitation * @param tenantId * @param acceptTeamMemberInvitationBody */ acceptTeamMemberInvitation(tenantId: string, acceptTeamMemberInvitationBody: AcceptTeamMemberInvitationBody, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AcceptTeamMemberInvitationResponse; }>; /** * This endpoint adds a member to an organization based on the provided organization ID and member ID.The addition process ensures that the member is properly associated with the organization. * @summary Adds a member to an organization * @param organizationId * @param addOrganizationMemberToOrganizationBody */ addOrganizationMemberToOrganization(organizationId: string, addOrganizationMemberToOrganizationBody: AddOrganizationMemberToOrganizationBody, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AddOrganizationMemberToOrganizationResponse; }>; /** * This endpoint adds a role to a team based on the provided tenant ID, team ID, and role details.The addition process ensures that the role is properly associated with the team. * @summary Adds a role to a team * @param tenantId * @param teamId * @param addRoleToTenantTeamBody */ addRoleToTenantTeam(tenantId: string, teamId: string, addRoleToTenantTeamBody: AddRoleToTenantTeamBody, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AddRoleToTenantTeamResponse; }>; /** * This endpoint adds a member to a tenant based on the provided tenant ID and member ID.The addition process ensures that the member is properly associated with the tenant. * @summary Adds a member to a tenant * @param tenantId * @param addTenantMemberBody */ addTenantMember(tenantId: string, addTenantMemberBody: AddTenantMemberBody, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AddTenantMemberResponse; }>; /** * This endpoint adds a user to a team based on the provided team ID and user ID.The addition process ensures that the user is properly associated with the team. * @summary Adds a user to a team * @param teamId * @param addUserToTeamBody */ addUserToTeam(teamId: string, addUserToTeamBody: AddUserToTeamBody, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AddUserToTeamResponse; }>; /** * Adds multiple members to a team in a single operation * @summary Bulk add team members * @param teamId Team identifier (required) * @param bulkAddTeamMembersBody */ bulkAddTeamMembers(teamId: string, bulkAddTeamMembersBody: BulkAddTeamMembersBody, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: BulkAddTeamMembersResponse; }>; /** * Removes multiple members from a team in a single operation * @summary Bulk remove team members * @param teamId Team identifier (required) * @param bulkRemoveTeamMembersBody */ bulkRemoveTeamMembers(teamId: string, bulkRemoveTeamMembersBody: BulkRemoveTeamMembersBody, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: BulkRemoveTeamMembersResponse; }>; /** * This endpoint revokes (deletes) multiple API keys in a single operation. It accepts a list of key IDs to be revoked. * @summary Revokes multiple API keys * @param bulkRevokeOrgAPIKeysRequest */ bulkRevokeOrgAPIKeys(bulkRevokeOrgAPIKeysRequest: BulkRevokeOrgAPIKeysRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: BulkRevokeOrgAPIKeysResponse; }>; /** * Checks if an email and auth0 user id exists or not * @summary Checks that an email and auth0 user id exists or not * @param email The email of the user of interest * @param supabaseAuth0UserId The auth0 user id of the user * @param organizationId * @param tenantId */ checkEmailAndAuth0UserIdExists(email: string, supabaseAuth0UserId: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CheckEmailAndAuth0UserIdExistsResponse; }>; /** * Checks if an email exists in the system with comprehensive validation * @summary Validate email existence * @param email * @param profileType the profile type of the given user we hope to query - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId */ checkEmailExistsV2(email: string, profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CheckEmailExistsV2Response; }>; /** * Checks if a username exists in the system with comprehensive validation * @summary Validate username existence * @param username The username of the user of interest * @param profileType the profile type of the given user we hope to query - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId */ checkUsernameExistsV2(username: string, profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CheckUsernameExistsV2Response; }>; /** * This endpoint adds a new organization to the system. It requires organization details such as name, description, and members.The creation process involves adding the organization to the database and initializing its members. * @summary Creates a new organization * @param createOrganizationRequest */ createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateOrganizationResponse; }>; /** * This endpoint creates a new API key for an organization. It requires details such as name, expiration, and permissions. * @summary Creates a new organization API key * @param createOrganizationApiKeyRequest */ createOrganizationApiKey(createOrganizationApiKeyRequest: CreateOrganizationApiKeyRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateOrganizationApiKeyResponse; }>; /** * This endpoint adds a new role to the system. It requires role details such as name, type, and permissions.The creation process involves adding the role to the database and initializing its permissions. * @summary Creates a new role * @param organizationId * @param tenantId * @param role */ createRole(organizationId: string, tenantId: string, role: Role, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateRoleResponse; }>; /** * This endpoint adds a new team to the system. It requires team details such as name, description, and members.The creation process involves adding the team to the database and initializing its members. * @summary Creates a new team * @param createTeamRequest */ createTeam(createTeamRequest: CreateTeamRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateTeamResponse; }>; /** * This endpoint adds a new tenant to the system. It requires tenant details such as name, description, and members.The creation process involves adding the tenant to the database and initializing its members. * @summary Creates a new tenant * @param createTenantRequest */ createTenant(createTenantRequest: CreateTenantRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateTenantResponse; }>; /** * This endpoint creates a new API key for a tenant. It requires details such as name, expiration, and permissions. * @summary Creates a new tenant API key * @param createTenantApiKeyRequest */ createTenantApiKey(createTenantApiKeyRequest: CreateTenantApiKeyRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateTenantApiKeyResponse; }>; /** * This endpoint adds a new team to the system. It requires team details such as name, description, and members.The creation process involves adding the team to the database and initializing its members. * @summary Creates a new team * @param createTenantTeamRequest */ createTenantTeam(createTenantTeamRequest: CreateTenantTeamRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateTenantTeamResponse; }>; /** * Creates a new user account with comprehensive setup across multiple services. Handles different account types and ensures proper initialization of all components. Includes security measures and validation. * @summary Create new user account * @param createUserV2Request CreateUserV2Request represents the request object for creating a user account in the user service (version 2). This message encapsulates all necessary information to create a user account, including authentication details, contact information, and profile preferences. */ createUserV2(createUserV2Request: CreateUserV2Request, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateUserV2Response; }>; /** * This endpoint deletes an organization from the system based on the provided organization ID.The deletion process ensures that all related data and members are properly removed. * @summary Deletes an organization * @param organizationId * @param ownerSupabaseAuthUserId */ deleteOrganization(organizationId: string, ownerSupabaseAuthUserId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteOrganizationResponse; }>; /** * This endpoint deletes an organization API key based on the provided key ID. * @summary Deletes an organization API key * @param organizationApiKeyId * @param organizationId * @param ownerSupabaseAuthUserId */ deleteOrganizationApiKey(organizationApiKeyId: string, organizationId: string, ownerSupabaseAuthUserId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteOrganizationApiKeyResponse; }>; /** * This endpoint deletes a role from the system based on the provided role ID.The deletion process ensures that all related data and permissions are properly removed. * @summary Deletes a role * @param id * @param organizationId * @param tenantId */ deleteRole(id: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteRoleResponse; }>; /** * This endpoint deletes a role from a team based on the provided tenant ID, team ID, and role ID.The deletion process ensures that the role is properly disassociated from the team. * @summary Deletes a role from a team * @param tenantId * @param teamId * @param organizationId * @param roleId */ deleteRoleFromTenantTeam(tenantId: string, teamId: string, organizationId: string, roleId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteRoleFromTenantTeamResponse; }>; /** * This endpoint deletes a team from the system based on the provided team ID.The deletion process ensures that all related data and members are properly removed. * @summary Deletes a team * @param teamId * @param adminSupabaseAuth0UserId * @param organizationId * @param tenantId */ deleteTeam(teamId: string, adminSupabaseAuth0UserId: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteTeamResponse; }>; /** * This endpoint deletes a tenant from the system based on the provided tenant ID.The deletion process ensures that all related data and members are properly removed. * @summary Deletes a tenant * @param tenantId * @param organizationId */ deleteTenant(tenantId: string, organizationId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteTenantResponse; }>; /** * This endpoint deletes a tenant API key based on the provided key ID. * @summary Deletes a tenant API key * @param tenantApiKeyId * @param organizationId * @param tenantId */ deleteTenantApiKey(tenantApiKeyId: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteTenantApiKeyResponse; }>; /** * This endpoint deletes a team from the system based on the provided team ID.The deletion process ensures that all related data and members are properly removed. * @summary Deletes a team * @param teamId * @param organizationId * @param tenantId */ deleteTenantTeam(teamId: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteTenantTeamResponse; }>; /** * Performs a complete deletion of a user account and associated data across all services. This operation is atomic and ensures consistency across all affected services. Includes comprehensive cleanup and audit trail creation. * @summary Delete user account and associated data * @param userId The account ID associated with the user to delete Validations: - user_id must be greater than 0 * @param profileType the profile type of the given user we hope to query - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId */ deleteUserV2(userId: string, profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteUserV2Response; }>; /** * Fetches a user sso token for canny * @summary Retrieves user sso token for canny * @param userId The account ID associated with the user * @param profileType Indicates the profile type to be queried. For example: \"username:testuser\" - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId */ getCannyUserSSOToken(userId: string, profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetCannyUserSSOTokenResponse; }>; /** * This endpoint fetches the permissions associated with a specific API key using the key ID. * @summary Retrieves permissions for an API key * @param keyId The unique identifier of the API key whose permissions are being requested * @param organizationId * @param tenantId */ getOrgAPIKeyPermissions(keyId: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetOrgAPIKeyPermissionsResponse; }>; /** * This endpoint fetches details of a specific organization using the organization ID.It retrieves the organization\'s name, description, members, and audit history. * @summary Retrieves an organization * @param organizationId */ getOrganization(organizationId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetOrganizationResponse; }>; /** * This endpoint fetches details of a specific member in an organization using the organization ID and member ID.It retrieves the member\'s name, email, role, and audit history. * @summary Retrieves a member of an organization * @param organizationId * @param organizationMemberId */ getOrganizationMember(organizationId: string, organizationMemberId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetOrganizationMemberResponse; }>; /** * This endpoint fetches details of a specific role using the role ID.It retrieves the role\'s name, type, permissions, and audit history. * @summary Retrieves a role * @param id * @param organizationId * @param tenantId */ getRole(id: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetRoleResponse; }>; /** * This endpoint fetches details of a specific team using the team ID.It retrieves the team\'s name, description, members, and audit history. * @summary Retrieves a team * @param teamId * @param organizationId * @param tenantId */ getTeam(teamId: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTeamResponse; }>; /** * This endpoint fetches details of a specific tenant using the tenant ID.It retrieves the tenant\'s name, description, members, and audit history. * @summary Retrieves a tenant * @param tenantId * @param organizationId */ getTenant(tenantId: string, organizationId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTenantResponse; }>; /** * This endpoint fetches details of a specific team using the team ID.It retrieves the team\'s name, description, members, and audit history. * @summary Retrieves a team * @param teamId * @param organizationId * @param tenantId */ getTenantTeam(teamId: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTenantTeamResponse; }>; /** * Fetches detailed information about a user account based on the specified authn ID. * @summary Retrieve user account details by auth0 id and profile type * @param supabaseAuth0UserId The account ID associated with the user * @param profileType Indicates the profile type to be queried. For example: \"username:testuser\" - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId */ getUserByAuth0ID(supabaseAuth0UserId: string, profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserByAuth0IDResponse; }>; /** * Fetches user information using authentication system identifiers. Includes security validation and data privacy controls. * @summary Retrieve user details by authentication ID * @param authnId Specifies the user\'s authn account ID. Validations: - Must be greater than 0. * @param profileType Indicates the profile type to be queried. For example: \"username:testuser\" - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId */ getUserByAuthnIDV2(authnId: string, profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserByAuthnIDV2Response; }>; /** * Fetches a user account using the provided email or username. Performs validation and security checks. * @summary Retrieve user account by email or username * @param profileType The profile type of the user - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId * @param email The email of the user of interest * @param username The username of the user of interest */ getUserByEmailOrUsernameV2(profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, email?: string, username?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserByEmailOrUsernameV2Response; }>; /** * Provides detailed information of a user based on the given email. * @summary Retrieve user details by email * @param email * @param profileType the profile type of the given user we hope to query - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId */ getUserByEmailV2(email: string, profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserByEmailV2Response; }>; /** * Provides detailed information of a user based on the given username. * @summary Retrieve user details by username * @param username The username of the user of interest * @param profileType The profile type of the user - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId */ getUserByUsernameV2(username: string, profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserByUsernameV2Response; }>; /** * Looks up user ID using flexible search criteria with comprehensive validation. Supports multiple search parameters and ensures accurate results. * @summary Retrieve user ID by search criteria * @param profileType - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId * @param email The email of the user of interest * @param username The username of the user of interest */ getUserIdV2(profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, email?: string, username?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserIdV2Response; }>; /** * Fetches detailed information about a user account based on the specified user ID. * @summary Retrieve user account details * @param userId Specifies the user\'s account ID. Validations: - Must be greater than 0. * @param profileType Indicates the profile type to be queried. For example: \"username:testuser\" - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. * @param organizationId * @param tenantId */ getUserV2(userId: string, profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserV2Response; }>; /** * This endpoint performs a healc check on the service * @summary health check */ healthCheck(options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: HealthCheckResponse; }>; /** * This endpoint sends an invitation to a member to join a tenant based on the provided tenant ID and member email.The invitation process ensures that the member receives an email with the invitation details. * @summary Invites a member to a tenant * @param tenantId * @param inviteTeamMemberBody */ inviteTeamMember(tenantId: string, inviteTeamMemberBody: InviteTeamMemberBody, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: InviteTeamMemberResponse; }>; /** * This endpoint retrieves a list of all API keys for an organization. It supports pagination to handle large sets of data. * @summary Lists all organization API keys * @param organizationId * @param ownerSupabaseAuthUserId * @param page * @param pageSize */ listOrganizationApiKeys(organizationId: string, ownerSupabaseAuthUserId: string, page?: number, pageSize?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListOrganizationApiKeysResponse; }>; /** * This endpoint retrieves a list of all audit logs for an organization. It supports pagination to handle large sets of data. * @summary Lists all organization audit logs * @param organizationId * @param ownerSupabaseAuthUserId * @param page * @param pageSize */ listOrganizationAuditLogs(organizationId: string, ownerSupabaseAuthUserId: string, page?: number, pageSize?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListOrganizationAuditLogsResponse; }>; /** * This endpoint retrieves a list of all members in an organization based on the provided organization ID.It supports pagination to handle large sets of data. * @summary Lists all members of an organization * @param organizationId * @param page * @param pageSize */ listOrganizationMembers(organizationId: string, page?: number, pageSize?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListOrganizationMembersResponse; }>; /** * This endpoint retrieves a list of all organizations in the system. It supports pagination to handle large sets of data.Each organization in the list includes details like name, description, and members. * @summary Lists all organizations * @param page * @param pageSize */ listOrganizations(page?: number, pageSize?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListOrganizationsResponse; }>; /** * This endpoint retrieves a list of all roles in the system. It supports pagination to handle large sets of data.Each role in the list includes details like name, type, and permissions. * @summary Lists all roles * @param page * @param pageSize * @param organizationId * @param tenantId */ listRoles(page: number, pageSize: number, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListRolesResponse; }>; /** * This endpoint retrieves a list of all roles in a team based on the provided tenant ID and team ID.It supports pagination to handle large sets of data. * @summary Lists all roles from a team * @param tenantId * @param teamId * @param organizationId * @param page * @param pageSize */ listRolesFromTenantTeam(tenantId: string, teamId: string, organizationId: string, page?: number, pageSize?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListRolesFromTenantTeamResponse; }>; /** * This endpoint retrieves a list of all team invites for a tenant based on the provided tenant ID.It supports pagination to handle large sets of data. * @summary Lists all team invites * @param tenantId Tenant identifier (required) * @param organizationId Organization identifier (required) * @param teamId Team identifier (required) * @param page Page number for pagination * @param pageSize Number of items per page */ listTeamInvites(tenantId: string, organizationId: string, teamId: string, page?: number, pageSize?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListTeamInvitesResponse; }>; /** * This endpoint retrieves a list of all API keys for a tenant. It supports pagination to handle large sets of data. * @summary Lists all tenant API keys * @param organizationId * @param tenantId * @param page * @param pageSize */ listTenantApiKeys(organizationId: string, tenantId: string, page?: number, pageSize?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListTenantApiKeysResponse; }>; /** * This endpoint retrieves a list of all audit logs for a tenant. It supports pagination to handle large sets of data. * @summary Lists all tenant audit logs * @param organizationId * @param tenantId * @param page * @param pageSize */ listTenantAuditLogs(organizationId: string, tenantId: string, page?: number, pageSize?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListTenantAuditLogsResponse; }>; /** * This endpoint retrieves a list of all members in a tenant based on the provided tenant ID.It supports pagination to handle large sets of data. * @summary Lists all members of a tenant * @param tenantId * @param organizationId * @param teamId * @param page * @param pageSize */ listTenantTeamMembers(tenantId: string, organizationId: string, teamId: string, page?: number, pageSize?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListTenantTeamMembersResponse; }>; /** * This endpoint retrieves a list of all tenants in the system. It supports pagination to handle large sets of data.Each tenant in the list includes details like name, description, and members. * @summary Lists all tenants * @param organizationId * @param page * @param pageSize */ listTenants(organizationId: string, page?: number, pageSize?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListTenantsResponse; }>; /** * Handles secure password reset operations through webhook integration. Includes comprehensive security measures and validation. * @summary Process password reset via webhook * @param organizationId * @param tenantId * @param accountId * @param token */ passwordResetWebhookV2(organizationId: string, tenantId: string, accountId?: string, token?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: PasswordResetWebhookV2Response; }>; /** * This endpoint performs a readiness check on the service * @summary readyness check */ readynessCheck(options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ReadynessCheckResponse; }>; /** * This endpoint rejects an invitation for a member to join a tenant based on the provided tenant ID and member email.The rejection process ensures that the member is not associated with the tenant. * @summary Rejects a team member invitation * @param tenantId * @param rejectTeamMemberInvitationBody */ rejectTeamMemberInvitation(tenantId: string, rejectTeamMemberInvitationBody: RejectTeamMemberInvitationBody, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: RejectTeamMemberInvitationResponse; }>; /** * This endpoint removes a member from an organization based on the provided organization ID and member ID.The removal process ensures that the member is properly disassociated from the organization. * @summary Removes a member from an organization * @param organizationId * @param ownerSupabaseAuthUserId * @param organizationMemberId */ removeOrganizationMemberFromOrganization(organizationId: string, ownerSupabaseAuthUserId: string, organizationMemberId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: RemoveOrganizationMemberFromOrganizationResponse; }>; /** * This endpoint removes a member from a tenant based on the provided tenant ID and member ID.The removal process ensures that the member is properly disassociated from the tenant. * @summary Removes a member from a tenant * @param tenantId * @param organizationId * @param tenantTeamId * @param tenantTeamMemberId */ removeTenantTeamMember(tenantId: string, organizationId: string, tenantTeamId: string, tenantTeamMemberId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: RemoveTenantTeamMemberResponse; }>; /** * This endpoint removes a user from a team based on the provided team ID and user ID.The removal process ensures that the user is properly disassociated from the team. * @summary Removes a user from a team * @param teamId * @param adminSupabaseAuth0UserId * @param userSupabaseAuth0UserId * @param organizationId * @param tenantId * @param profileType - PROFILE_TYPE_UNSPECIFIED: Default unspecified profile type. - PROFILE_TYPE_USER: Individual user profile. - PROFILE_TYPE_BUSINESS: Business profile. */ removeUserFromTeam(teamId: string, adminSupabaseAuth0UserId: string, userSupabaseAuth0UserId: string, organizationId: string, tenantId: string, profileType?: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: RemoveUserFromTeamResponse; }>; /** * Fetches business-specific account settings with authorization validation. Provides comprehensive configuration data for business accounts. * @summary Retrieve business account settings * @param userId The account ID associated with the user (business) * @param organizationId * @param tenantId */ retrieveBusinessSettings(userId: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetBusinessSettingsResponse; }>; /** * This endpoint rotates (replaces) an existing API key with a new one. The old key is invalidated, and a new key is generated with the same permissions and settings. * @summary Rotates an API key * @param keyId The unique identifier of the API key to rotate * @param organizationId * @param tenantId */ rotateOrgAPIKey(keyId: string, organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: RotateOrgAPIKeyResponse; }>; /** * This endpoint updates the details of an existing organization. The organization ID is used to identify the organization to be updated.The update operation can modify the organization\'s name, description, and members. * @summary Updates an existing organization * @param organization */ updateOrganization(organization: Organization, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateOrganizationResponse; }>; /** * This endpoint updates the details of an existing role. The role ID is used to identify the role to be updated.The update operation can modify the role\'s name, type, and permissions. * @summary Updates an existing role * @param role */ updateRole(role: Role, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateRoleResponse; }>; /** * This endpoint updates the details of an existing team. The team ID is used to identify the team to be updated.The update operation can modify the team\'s name, description, and members. * @summary Updates an existing team * @param team */ updateTeam(team: Team, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateTeamResponse; }>; /** * This endpoint updates the details of an existing tenant. The tenant ID is used to identify the tenant to be updated.The update operation can modify the tenant\'s name, description, and members. * @summary Updates an existing tenant * @param updateTenantRequest */ updateTenant(updateTenantRequest: UpdateTenantRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateTenantResponse; }>; /** * This endpoint updates the details of an existing team. The team ID is used to identify the team to be updated.The update operation can modify the team\'s name, description, and members. * @summary Updates an existing team * @param team */ updateTenantTeam(team: Team, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateTenantTeamResponse; }>; /** * This endpoint updates the details of an existing team member. The tenant ID and member ID are used to identify the member to be updated.The update operation can modify the member\'s role, permissions, and status. * @summary Updates a team member * @param updateTenantTeamMemberRequest */ updateTenantTeamMember(updateTenantTeamMemberRequest: UpdateTenantTeamMemberRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateTenantTeamMemberResponse; }>; /** * Performs comprehensive updates to user account information with multi-service coordination. Ensures data consistency and atomic updates across all affected services. Includes validation, authorization, and audit logging. * @summary Update user account information * @param updateUserV2Request */ updateUserV2(updateUserV2Request: UpdateUserV2Request, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateUserV2Response; }>; /** * This endpoint verifies the validity of an API key. It checks if the key exists, is not expired, and has not been revoked. * @summary Verifies an API key * @param verifyOrgAPIKeyRequest */ verifyOrgAPIKey(verifyOrgAPIKeyRequest: VerifyOrgAPIKeyRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: VerifyOrgAPIKeyResponse; }>; /** * Handles email verification process with security token validation. Updates account status and manages verification state. * @summary Verify user email address * @param userId The account ID associated with the user * @param profileType The profile type of the user * @param organizationId * @param tenantId */ verifyUserV2(userId: string, profileType: 'PROFILE_TYPE_UNSPECIFIED' | 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_BUSINESS', organizationId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: VerifyUserV2Response; }>; }