@extrahorizon/javascript-sdk 8.2.0-test

package/build/types/services/users/activationRequests/types.d.ts

@@ -0,0 +1,70 @@
+import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../../types';
+export interface ActivationRequestsService {
+    /**
+     * Retrieve a list of activation requests
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_ACTIVATION_REQUESTS` | global | **Required** for this endpoint
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<ActivationRequest>>;
+    /**
+     * Find an activation request
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_ACTIVATION_REQUESTS` | global | **Required** for this endpoint
+     */
+    findFirst(options?: OptionsWithRql): Promise<ActivationRequest>;
+    /**
+     * Find an activation request by its id
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_ACTIVATION_REQUESTS` | global | **Required** for this endpoint
+     */
+    findById(id: string, options?: OptionsWithRql): Promise<ActivationRequest>;
+    /**
+     * Find an activation request for a user id
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_ACTIVATION_REQUESTS` | global | **Required** for this endpoint
+     */
+    findByUserId(userId: string, options?: OptionsWithRql): Promise<ActivationRequest>;
+    /**
+     * Remove an activation request
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `DELETE_ACTIVATION_REQUEST` | global | **Required** for this endpoint
+     */
+    remove(id: string, options?: OptionsBase): Promise<AffectedRecords>;
+}
+export interface ActivationRequest {
+    id: string;
+    userId: string;
+    mode?: 'hash' | 'pin_code';
+    /**
+     * The amount of times the account activation flow was initiated without completion.
+     */
+    requestCount?: number;
+    /**
+     * The last time the account activation flow was initiated.
+     */
+    lastRequestTimestamp?: number;
+    /**
+     * (Pin code mode only) the amount of attempts with an incorrect pin code for the current activation request.
+     */
+    failedAttempts?: number;
+    /**
+     * (Pin code mode only) the last time an incorrect pin code for the current activation request.
+     */
+    lastFailedAttemptTimestamp?: Date;
+    /**
+     * The time until which the activation request can be used.
+     */
+    expiryTimestamp?: Date;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}

package/build/types/services/users/forgotPasswordRequests/index.d.ts

@@ -0,0 +1,4 @@
+import { HttpInstance } from '../../../types';
+import { HttpClient } from '../../http-client';
+import { ForgotPasswordRequestsService } from './types';
+export declare const forgotPasswordRequestsService: (client: HttpClient, httpWithAuth: HttpInstance) => ForgotPasswordRequestsService;

package/build/types/services/users/forgotPasswordRequests/types.d.ts

@@ -0,0 +1,70 @@
+import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../../types';
+export interface ForgotPasswordRequestsService {
+    /**
+     * Retrieve a list of forgot password requests
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_FORGOT_PASSWORD_REQUESTS` | global | **Required** for this endpoint
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<ForgotPasswordRequest>>;
+    /**
+     * Find a forgot password request
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_FORGOT_PASSWORD_REQUESTS` | global | **Required** for this endpoint
+     */
+    findFirst(options?: OptionsWithRql): Promise<ForgotPasswordRequest>;
+    /**
+     * Find a forgot password request by its id
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_FORGOT_PASSWORD_REQUESTS` | global | **Required** for this endpoint
+     */
+    findById(id: string, options?: OptionsWithRql): Promise<ForgotPasswordRequest>;
+    /**
+     * Find a forgot password request for a user id
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_FORGOT_PASSWORD_REQUESTS` | global | **Required** for this endpoint
+     */
+    findByUserId(userId: string, options?: OptionsWithRql): Promise<ForgotPasswordRequest>;
+    /**
+     * Remove a forgot password request
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `DELETE_FORGOT_PASSWORD_REQUEST` | global | **Required** for this endpoint
+     */
+    remove(id: string, options?: OptionsBase): Promise<AffectedRecords>;
+}
+export interface ForgotPasswordRequest {
+    id: string;
+    userId: string;
+    mode?: 'hash' | 'pin_code';
+    /**
+     * The amount of times the account forgot password flow was initiated without completion.
+     */
+    requestCount?: number;
+    /**
+     * The last time the account forgot password flow was initiated.
+     */
+    lastRequestTimestamp?: number;
+    /**
+     * (Pin code mode only) the amount of attempts with an incorrect pin code for the current forgot password request.
+     */
+    failedAttempts?: number;
+    /**
+     * (Pin code mode only) the last time an incorrect pin code for the current forgot password request.
+     */
+    lastFailedAttemptTimestamp?: Date;
+    /**
+     * The time until which the forgot password request can be used.
+     */
+    expiryTimestamp?: Date;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}

package/build/types/services/users/globalRoles.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { UsersGlobalRolesService } from './types';
+declare const _default: (client: HttpClient, httpWithAuth: HttpInstance) => UsersGlobalRolesService;
+export default _default;

package/build/types/services/users/groupRoles.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { UsersGroupRolesService } from './types';
+declare const _default: (client: HttpClient, httpWithAuth: HttpInstance) => UsersGroupRolesService;
+export default _default;

package/build/types/services/users/health.d.ts

@@ -0,0 +1,9 @@
+import type { HttpInstance } from '../../types';
+declare const _default: (userClient: any, http: HttpInstance) => {
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+};
+export default _default;

package/build/types/services/users/index.d.ts

@@ -0,0 +1,16 @@
+import type { HttpInstance } from '../../types';
+import { ActivationRequestsService } from './activationRequests/types';
+import { ForgotPasswordRequestsService } from './forgotPasswordRequests/types';
+import globalRoles from './globalRoles';
+import groupRoles from './groupRoles';
+import health from './health';
+import { SettingsService } from './settings/types';
+import { UsersGlobalRolesService, UsersGroupRolesService } from './types';
+import users from './users';
+export declare const usersService: (httpWithAuth: HttpInstance, http: HttpInstance) => ReturnType<typeof users> & ReturnType<typeof health> & {
+    globalRoles: UsersGlobalRolesService;
+    groupRoles: UsersGroupRolesService;
+    activationRequests: ActivationRequestsService;
+    forgotPasswordRequests: ForgotPasswordRequestsService;
+    settings: SettingsService;
+};

package/build/types/services/users/settings/index.d.ts

@@ -0,0 +1,4 @@
+import { HttpInstance } from '../../../types';
+import { HttpClient } from '../../http-client';
+import { SettingsService } from './types';
+export declare const settingsService: (client: HttpClient, httpWithAuth: HttpInstance) => SettingsService;

package/build/types/services/users/settings/types.d.ts

@@ -0,0 +1,47 @@
+import { OptionsBase } from '../../types';
+export interface SettingsService {
+    /**
+     * Retrieve the verification settings
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_USER_VERIFICATION_SETTINGS` | global | **Required** for this endpoint
+     */
+    getVerificationSettings(options?: OptionsBase): Promise<VerificationSettings>;
+    /**
+     * Update the verification settings
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_USER_VERIFICATION_SETTINGS` | global | **Required** for this endpoint
+     */
+    updateVerificationSettings(data: Partial<VerificationSettings>, options?: OptionsBase): Promise<VerificationSettings>;
+}
+export interface VerificationSettings {
+    /**
+     * Allow use of the pin code mode for the account activation flow.
+     */
+    enablePinCodeActivationRequests: boolean;
+    /**
+     * Allow use of the pin code mode for the forgot password flow.
+     */
+    enablePinCodeForgotPasswordRequests: boolean;
+    /**
+     * Turns on the following limits for the account activation flow in hash mode:
+     * - Limits the time a hash is valid to 60 minutes.
+     * - Limits the amount of times the flow can be initiated without success to 5.
+     * - Requires the time between initiations to be at least 5 minutes.
+     *
+     * @deprecated Security feature. Only should be disabled while existing applications implement the feature, otherwise this feature should always be enabled.
+     */
+    limitHashActivationRequests: boolean;
+    /**
+     * Turns on the following limits for the forgot password flow in hash mode:
+     * - Limits the time a hash is valid to 60 minutes.
+     * - Limits the amount of times the flow can be initiated without success to 5.
+     * - Requires the time between initiations to be at least 5 minutes.
+     *
+     * @deprecated Security feature. Only should be disabled while existing applications implement the feature, otherwise this feature should always be enabled.
+     */
+    limitHashForgotPasswordRequests: boolean;
+}