@equisoft/account-service-sdk-typescript 4.5.1-snapshot.20230206204303 → 6.6.0

package/dist/esm/apis/UserApi.d.ts

@@ -0,0 +1,409 @@
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ApplyPermissionsPayload, AuthenticationUserAccount, CreateUserAccountPayload, Id, LoginPayload, NewPasswordPayload, Organization, PasswordPolicy, PermissionList, SendResetPasswordLinkPayload, SessionPolicy, SetPasswordByConfirmationHashPayload, SetUserAccountPasswordPayload, SignupHash, UpdateUserAccountPayload, UpdateUserAccountSsoPayload, User, UserAccountRoleAttributions, UserAccountSearchResult, UserPermissions, UserUuid } from '../models/index';
+export interface AcceptAgreementRequest {
+    uuid: string;
+}
+export interface AcceptSignupInvitationRequest {
+    hash: string;
+    newPasswordPayload: NewPasswordPayload;
+}
+export interface ActivateRequest {
+    uuid: string;
+}
+export interface AddUpdateSsoRequest {
+    uuid: string;
+    updateUserAccountSsoPayload: UpdateUserAccountSsoPayload;
+}
+export interface AddUserAccountRoleAttributionRequest {
+    uuid: string;
+    organizationUuid: string;
+    roleUuid: string;
+}
+export interface ApplyPermissionsOnResource1Request {
+    uuid: string;
+    applyPermissionsPayload: ApplyPermissionsPayload;
+}
+export interface CreateSignupInvitationRequest {
+    uuid: string;
+}
+export interface CreateUserRequest {
+    createUserAccountPayload: CreateUserAccountPayload;
+}
+export interface DeactivateRequest {
+    uuid: string;
+}
+export interface DeleteSignupInvitationRequest {
+    uuid: string;
+}
+export interface DeleteSsoRequest {
+    uuid: string;
+}
+export interface DeleteUserAccountRequest {
+    uuid: string;
+}
+export interface DeleteUserAccountRoleAttributionRequest {
+    uuid: string;
+    organizationUuid: string;
+    roleUuid: string;
+}
+export interface DeleteUserSessionsRequest {
+    uuid: string;
+}
+export interface DisablePasswordLoginRequest {
+    uuid: string;
+}
+export interface EnablePasswordLoginRequest {
+    uuid: string;
+}
+export interface GetOwnerOrganizationRequest {
+    uuid: string;
+}
+export interface GetUserRequest {
+    uuid: string;
+}
+export interface GetUserAccountRoleAttributionsRequest {
+    uuid: string;
+}
+export interface GetUserByResetHashRequest {
+    hash: string;
+}
+export interface GetUserBySignupInvitationHashRequest {
+    hash: string;
+}
+export interface GetUserPermissionsRequest {
+    uuid: string;
+}
+export interface GetUuidByIdRequest {
+    id: number;
+}
+export interface InvalidatePasswordRequest {
+    uuid: string;
+}
+export interface ListUsersRequest {
+    identifierOrEmail?: string | null;
+    identifier?: string | null;
+    email?: string | null;
+    includeDeleted?: boolean | null;
+    query?: string | null;
+}
+export interface LoginRequest {
+    loginPayload: LoginPayload;
+}
+export interface RequestAgreementRequest {
+    uuid: string;
+}
+export interface SendPasswordResetLinkRequest {
+    uuid: string;
+    sendResetPasswordLinkPayload: SendResetPasswordLinkPayload;
+}
+export interface SetPasswordRequest {
+    uuid: string;
+    setUserAccountPasswordPayload: SetUserAccountPasswordPayload;
+}
+export interface SetPasswordPolicyRequest {
+    uuid: string;
+    passwordPolicy: PasswordPolicy;
+}
+export interface SetSessionPolicyRequest {
+    uuid: string;
+    sessionPolicy: SessionPolicy;
+}
+export interface SetUserPasswordByConfirmationHashRequest {
+    hash: string;
+    setPasswordByConfirmationHashPayload: SetPasswordByConfirmationHashPayload;
+}
+export interface UnlockRequest {
+    uuid: string;
+}
+export interface UpdateUserRequest {
+    uuid: string;
+    updateUserAccountPayload: UpdateUserAccountPayload;
+}
+/**
+ *
+ */
+export declare class UserApi extends runtime.BaseAPI {
+    /**
+     * accept user account legal agreement.
+     */
+    acceptAgreementRaw(requestParameters: AcceptAgreementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * accept user account legal agreement.
+     */
+    acceptAgreement(requestParameters: AcceptAgreementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Attribute user password with signup hash.
+     */
+    acceptSignupInvitationRaw(requestParameters: AcceptSignupInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Attribute user password with signup hash.
+     */
+    acceptSignupInvitation(requestParameters: AcceptSignupInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Activate user account.
+     */
+    activateRaw(requestParameters: ActivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Activate user account.
+     */
+    activate(requestParameters: ActivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update user account sso.
+     */
+    addUpdateSsoRaw(requestParameters: AddUpdateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update user account sso.
+     */
+    addUpdateSso(requestParameters: AddUpdateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Add a role attribution for a user and organization
+     */
+    addUserAccountRoleAttributionRaw(requestParameters: AddUserAccountRoleAttributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Add a role attribution for a user and organization
+     */
+    addUserAccountRoleAttribution(requestParameters: AddUserAccountRoleAttributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get permissions of a user on a user or an organization.
+     */
+    applyPermissionsOnResource1Raw(requestParameters: ApplyPermissionsOnResource1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PermissionList>>;
+    /**
+     * Get permissions of a user on a user or an organization.
+     */
+    applyPermissionsOnResource1(requestParameters: ApplyPermissionsOnResource1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PermissionList>;
+    /**
+     * Create signup invitation for user.
+     */
+    createSignupInvitationRaw(requestParameters: CreateSignupInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignupHash>>;
+    /**
+     * Create signup invitation for user.
+     */
+    createSignupInvitation(requestParameters: CreateSignupInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignupHash>;
+    /**
+     * Create a user account
+     */
+    createUserRaw(requestParameters: CreateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserUuid>>;
+    /**
+     * Create a user account
+     */
+    createUser(requestParameters: CreateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserUuid>;
+    /**
+     * Deactivate user account.
+     */
+    deactivateRaw(requestParameters: DeactivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deactivate user account.
+     */
+    deactivate(requestParameters: DeactivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Delete pending signup invitation for user.
+     */
+    deleteSignupInvitationRaw(requestParameters: DeleteSignupInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete pending signup invitation for user.
+     */
+    deleteSignupInvitation(requestParameters: DeleteSignupInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * delete user account sso.
+     */
+    deleteSsoRaw(requestParameters: DeleteSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * delete user account sso.
+     */
+    deleteSso(requestParameters: DeleteSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Delete a user account.
+     */
+    deleteUserAccountRaw(requestParameters: DeleteUserAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a user account.
+     */
+    deleteUserAccount(requestParameters: DeleteUserAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Remove a role attribution for a user and organization
+     */
+    deleteUserAccountRoleAttributionRaw(requestParameters: DeleteUserAccountRoleAttributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove a role attribution for a user and organization
+     */
+    deleteUserAccountRoleAttribution(requestParameters: DeleteUserAccountRoleAttributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Delete all sessions for the user.
+     */
+    deleteUserSessionsRaw(requestParameters: DeleteUserSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete all sessions for the user.
+     */
+    deleteUserSessions(requestParameters: DeleteUserSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Disable password login
+     */
+    disablePasswordLoginRaw(requestParameters: DisablePasswordLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Disable password login
+     */
+    disablePasswordLogin(requestParameters: DisablePasswordLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Enable password login
+     */
+    enablePasswordLoginRaw(requestParameters: EnablePasswordLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Enable password login
+     */
+    enablePasswordLogin(requestParameters: EnablePasswordLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get user\'s owner organization
+     */
+    getOwnerOrganizationRaw(requestParameters: GetOwnerOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Organization>>;
+    /**
+     * Get user\'s owner organization
+     */
+    getOwnerOrganization(requestParameters: GetOwnerOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Organization>;
+    /**
+     * Get detailed information about a user account.
+     */
+    getUserRaw(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<User>>;
+    /**
+     * Get detailed information about a user account.
+     */
+    getUser(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<User>;
+    /**
+     * Get user role attributions
+     */
+    getUserAccountRoleAttributionsRaw(requestParameters: GetUserAccountRoleAttributionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserAccountRoleAttributions>>;
+    /**
+     * Get user role attributions
+     */
+    getUserAccountRoleAttributions(requestParameters: GetUserAccountRoleAttributionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserAccountRoleAttributions>;
+    /**
+     * Get password info for a user based on unique hash.
+     */
+    getUserByResetHashRaw(requestParameters: GetUserByResetHashRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthenticationUserAccount>>;
+    /**
+     * Get password info for a user based on unique hash.
+     */
+    getUserByResetHash(requestParameters: GetUserByResetHashRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthenticationUserAccount>;
+    /**
+     * Get user signup invitation information.
+     */
+    getUserBySignupInvitationHashRaw(requestParameters: GetUserBySignupInvitationHashRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthenticationUserAccount>>;
+    /**
+     * Get user signup invitation information.
+     */
+    getUserBySignupInvitationHash(requestParameters: GetUserBySignupInvitationHashRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthenticationUserAccount>;
+    /**
+     * Get user permissions
+     */
+    getUserPermissionsRaw(requestParameters: GetUserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserPermissions>>;
+    /**
+     * Get user permissions
+     */
+    getUserPermissions(requestParameters: GetUserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserPermissions>;
+    /**
+     * Find an uuid by id.
+     */
+    getUuidByIdRaw(requestParameters: GetUuidByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Id>>;
+    /**
+     * Find an uuid by id.
+     */
+    getUuidById(requestParameters: GetUuidByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Id>;
+    /**
+     * Invalidate user account password.
+     */
+    invalidatePasswordRaw(requestParameters: InvalidatePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Invalidate user account password.
+     */
+    invalidatePassword(requestParameters: InvalidatePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Searches accounts that match ALL params. If no search parameters are provided, returns all users.
+     */
+    listUsersRaw(requestParameters: ListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<UserAccountSearchResult>>>;
+    /**
+     * Searches accounts that match ALL params. If no search parameters are provided, returns all users.
+     */
+    listUsers(requestParameters?: ListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<UserAccountSearchResult>>;
+    /**
+     * User account login
+     */
+    loginRaw(requestParameters: LoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthenticationUserAccount>>;
+    /**
+     * User account login
+     */
+    login(requestParameters: LoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthenticationUserAccount>;
+    /**
+     * request user account legal agreement.
+     */
+    requestAgreementRaw(requestParameters: RequestAgreementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * request user account legal agreement.
+     */
+    requestAgreement(requestParameters: RequestAgreementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Sends an email or sms with a time limited unique link to reset user\'s password
+     */
+    sendPasswordResetLinkRaw(requestParameters: SendPasswordResetLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sends an email or sms with a time limited unique link to reset user\'s password
+     */
+    sendPasswordResetLink(requestParameters: SendPasswordResetLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * set user account password.
+     */
+    setPasswordRaw(requestParameters: SetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * set user account password.
+     */
+    setPassword(requestParameters: SetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * set user account password policy
+     */
+    setPasswordPolicyRaw(requestParameters: SetPasswordPolicyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * set user account password policy
+     */
+    setPasswordPolicy(requestParameters: SetPasswordPolicyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Set user account session policy
+     */
+    setSessionPolicyRaw(requestParameters: SetSessionPolicyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Set user account session policy
+     */
+    setSessionPolicy(requestParameters: SetSessionPolicyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Set password for a user identified by a unique hash.
+     */
+    setUserPasswordByConfirmationHashRaw(requestParameters: SetUserPasswordByConfirmationHashRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Set password for a user identified by a unique hash.
+     */
+    setUserPasswordByConfirmationHash(requestParameters: SetUserPasswordByConfirmationHashRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Unlock user account.
+     */
+    unlockRaw(requestParameters: UnlockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unlock user account.
+     */
+    unlock(requestParameters: UnlockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * update user account.
+     */
+    updateUserRaw(requestParameters: UpdateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * update user account.
+     */
+    updateUser(requestParameters: UpdateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}