@extrahorizon/javascript-sdk 8.10.0-dev-159-0e9a0f1 → 8.10.0-dev-161-c1dd6ca

package/build/services/templates/types.d.ts

@@ -0,0 +1,237 @@
+/// <reference types="node" />
+import { FindAllIterator } from '../../services/helpers';
+import { ObjectId, LanguageCode, TimeZone, PagedResult, AffectedRecords, OptionsWithRql, OptionsBase } from '../types';
+export declare type TemplateOut = Template;
+export declare type TemplateIn = TemplateCreation;
+export interface Template {
+    id: ObjectId;
+    name: string;
+    description: string;
+    schema: TemplateObjectConfiguration;
+    fields: Record<string, string>;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}
+export interface TemplateCreation {
+    name: string;
+    description: string;
+    schema: TemplateObjectConfiguration;
+    fields: Record<string, string>;
+}
+export declare type TemplateTypeConfiguration = TemplateObjectConfiguration | TemplateArrayConfiguration | TemplateStringConfiguration | TemplateNumberConfiguration | TemplateBooleanConfiguration | TemplateObjectIdConfiguration | TemplateDateConfiguration;
+export interface TemplateObjectConfiguration {
+    type: 'object';
+    fields?: Record<string, TemplateTypeConfiguration>;
+    options?: TemplateObjectOption[];
+}
+export interface TemplateArrayConfiguration {
+    type: 'array';
+    type_configuration: TemplateTypeConfiguration;
+    options?: TemplateArrayOption[];
+}
+export interface TemplateStringConfiguration {
+    type: 'string';
+    options?: TemplateStringOption[];
+}
+export interface TemplateNumberConfiguration {
+    type: 'number';
+    options?: TemplateNumberOption[];
+}
+export interface TemplateBooleanConfiguration {
+    type: 'boolean';
+}
+export interface TemplateObjectIdConfiguration {
+    type: 'object_id';
+}
+export interface TemplateDateConfiguration {
+    type: 'date';
+    options?: TemplateDateOption[];
+}
+export declare type TemplateObjectOption = TemplateObjectMinBytesOption | TemplateObjectMaxBytesOption;
+export declare type TemplateObjectMinBytesOption = TemplateTypeOption<'min_bytes', number>;
+export declare type TemplateObjectMaxBytesOption = TemplateTypeOption<'max_bytes', number>;
+export declare type TemplateNumberOption = TemplateNumberInOption | TemplateNumberMaxOption | TemplateNumberMaxSizeOption | TemplateNumberMinOption | TemplateNumberMinSizeOption | TemplateNumberSizeOption;
+export declare type TemplateNumberInOption = TemplateTypeOption<'in', number[]>;
+export declare type TemplateNumberMaxOption = TemplateTypeOption<'max', number>;
+export declare type TemplateNumberMaxSizeOption = TemplateTypeOption<'max_size', number>;
+export declare type TemplateNumberMinOption = TemplateTypeOption<'min', number>;
+export declare type TemplateNumberMinSizeOption = TemplateTypeOption<'min_size', number>;
+export declare type TemplateNumberSizeOption = TemplateTypeOption<'size', number>;
+export declare type TemplateArrayOption = TemplateArrayMaxSizeOption | TemplateArrayMinSizeOption | TemplateArraySizeOption;
+export declare type TemplateArrayMaxSizeOption = TemplateTypeOption<'max_size', number>;
+export declare type TemplateArrayMinSizeOption = TemplateTypeOption<'min_size', number>;
+export declare type TemplateArraySizeOption = TemplateTypeOption<'size', number>;
+export declare type TemplateStringOption = TemplateStringInOption | TemplateStringMaxSizeOption | TemplateStringMinSizeOption | TemplateStringRegexOption | TemplateStringSizeOption;
+export declare type TemplateStringInOption = TemplateTypeOption<'in', string[]>;
+export declare type TemplateStringRegexOption = TemplateTypeOption<'regex', string>;
+export declare type TemplateStringMaxSizeOption = TemplateTypeOption<'max_size', number>;
+export declare type TemplateStringMinSizeOption = TemplateTypeOption<'min_size', number>;
+export declare type TemplateStringSizeOption = TemplateTypeOption<'size', number>;
+export declare type TemplateDateOption = TemplateDateMaxOption | TemplateDateMinOption;
+export declare type TemplateDateMaxOption = TemplateTypeOption<'max', number>;
+export declare type TemplateDateMinOption = TemplateTypeOption<'min', number>;
+interface TemplateTypeOption<T, V> {
+    type: T;
+    value: V;
+}
+export interface CreateFile {
+    /**
+     * If not present (or empty) we will first check the configured language in the users-service. If that is not present it will default to 'EN'
+     */
+    language?: LanguageCode;
+    /**
+     * If not present (or empty) we will first check the configured time_zone in the users-service. If that is not present it will default to 'Europe/Brussels'
+     */
+    timeZone?: TimeZone;
+    content: Record<string, any>;
+}
+export interface TemplatesService {
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+    /**
+     * Get all templates the service has to offer
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<TemplateOut>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<Template>>;
+    /**
+     * Request a list of all templates
+     *
+     * Do not pass in an rql with limit operator!
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns TemplateOut[]
+     */
+    findAll(options?: OptionsWithRql): Promise<Template[]>;
+    /**
+     * Request a list of all templates
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns TemplateOut[]
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<Template>;
+    /**
+     * Find By Id
+     * @param id the Id to search for
+     * @returns the first element found
+     */
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Template | undefined>;
+    /**
+     * Find By Name
+     * @param name the name to search for
+     * @returns the first element found
+     */
+    findByName(name: string, options?: OptionsWithRql): Promise<Template | undefined>;
+    /**
+     * Find First
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<Template | undefined>;
+    /**
+     * Create a new template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param requestBody TemplateIn
+     * @returns TemplateOut
+     */
+    create(requestBody: TemplateCreation, options?: OptionsBase): Promise<Template>;
+    /**
+     * Update an existing template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param templateId Id of the targeted template
+     * @param requestBody TemplateIn
+     * @returns TemplateOut
+     * @throws {ResourceUnknownError}
+     */
+    update(templateId: string, requestBody: TemplateCreation, options?: OptionsBase): Promise<Template>;
+    /**
+     * Delete a template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `DELETE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param templateId Id of the targeted template
+     * @returns AffectedRecords
+     * @throws {ResourceUnknownError}
+     */
+    remove(templateId: string, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Resolves a template and presents the result as a pdf file
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param templateId Id of the targeted template
+     * @param requestBody The file data
+     * @returns Buffer
+     * @throws {LocalizationKeyMissingError}
+     * @throws {TemplateFillingError}
+     * @throws {ResourceUnknownError}
+     */
+    resolveAsPdf(templateId: string, requestBody: CreateFile, options?: OptionsBase): Promise<Buffer>;
+    /**
+     * @deprecated
+     * Resolves a template and presents the result as a pdf file
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param templateId Id of the targeted template
+     * @param localizationCode Specifies the language the template must be resolved in
+     * @param requestBody The file data
+     * @returns Buffer
+     * @throws {LocalizationKeyMissingError}
+     * @throws {TemplateFillingError}
+     * @throws {ResourceUnknownError}
+     */
+    resolveAsPdfUsingCode(templateId: string, localizationCode: string, requestBody: CreateFile, options?: OptionsBase): Promise<Buffer>;
+    /**
+     * Resolves a template and presents the result as a json response
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param templateId Id of the targeted template
+     * @param requestBody CreateFile
+     * @returns Record<string, string>
+     * @throws {LocalizationKeyMissingError}
+     * @throws {TemplateFillingError}
+     * @throws {ResourceUnknownError}
+     */
+    resolveAsJson(templateId: string, requestBody: CreateFile, options?: OptionsBase): Promise<Record<string, string>>;
+    /**
+     * @deprecated
+     * Resolves a template and presents the result as a json response
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param templateId Id of the targeted template
+     * @param localizationCode Specifies the language the template must be resolved in
+     * @param requestBody CreateFile
+     * @returns Record<string, string>
+     * @throws {LocalizationKeyMissingError}
+     * @throws {TemplateFillingError}
+     * @throws {ResourceUnknownError}
+     */
+    resolveAsJsonUsingCode(templateId: string, localizationCode: string, requestBody: CreateFile, options?: OptionsBase): Promise<Record<string, string>>;
+}
+export {};

package/build/services/templatesV2/index.d.ts

@@ -0,0 +1,3 @@
+import { AuthHttpClient } from '../../types';
+import { TemplatesV2Service } from './types';
+export declare const templatesV2Service: (httpWithAuth: AuthHttpClient) => TemplatesV2Service;

package/build/services/templatesV2/templatesV2.d.ts

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

package/build/services/templatesV2/types.d.ts

@@ -0,0 +1,156 @@
+import { ObjectId, LanguageCode, TimeZone, PagedResult, AffectedRecords, OptionsWithRql, OptionsBase } from '../types';
+export interface TemplateV2 extends TemplateV2Creation {
+    id: ObjectId;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}
+export interface TemplateV2Creation {
+    name: string;
+    description?: string;
+    inputs?: Record<string, TemplateV2TypeConfiguration>;
+    outputs: Record<string, string>;
+}
+export interface TemplateV2Update {
+    name?: string;
+    description?: string | null;
+    inputs?: Record<string, TemplateV2TypeConfiguration> | null;
+    outputs?: Record<string, string>;
+}
+export declare type TemplateV2TypeConfiguration = TemplateV2ObjectConfiguration | TemplateV2ArrayConfiguration | TemplateV2StringConfiguration | TemplateV2NumberConfiguration | TemplateV2BooleanConfiguration;
+export interface TemplateV2ObjectConfiguration {
+    type: 'object';
+    properties: Record<string, TemplateV2TypeConfiguration>;
+}
+export interface TemplateV2ArrayConfiguration {
+    type: 'array';
+    items: TemplateV2TypeConfiguration;
+}
+export interface TemplateV2StringConfiguration {
+    type: 'string';
+}
+export interface TemplateV2NumberConfiguration {
+    type: 'number';
+}
+export interface TemplateV2BooleanConfiguration {
+    type: 'boolean';
+}
+export interface TemplateV2ResolveIn<T extends Record<string, any>> {
+    /**
+     * If not present (or empty) we will first check the configured language in the users-service. If that is not present it will default to 'EN'
+     */
+    language?: LanguageCode;
+    /**
+     * If not present (or empty) we will first check the configured time_zone in the users-service. If that is not present it will default to 'UTC'
+     */
+    timeZone?: TimeZone;
+    inputs?: T;
+}
+export interface TemplatesV2ErrorInfo {
+    /**
+     * The template outputs key in the request body that resulted in an error
+     */
+    output: string;
+    /**
+     * Error message describing the syntax error
+     */
+    message: string;
+}
+export interface TemplatesV2Service {
+    /**
+     * Get all templates the service has to offer
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<TemplateV2>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<TemplateV2>>;
+    /**
+     * Request a list of all templates
+     *
+     * Do not pass in a rql with limit operator!
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns TemplateV2[]
+     */
+    findAll(options?: OptionsWithRql): Promise<TemplateV2[]>;
+    /**
+     * Find By Id
+     * @param id the Id to search for
+     * @returns the first element found
+     */
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<TemplateV2 | undefined>;
+    /**
+     * Find By Name
+     * @param name the name to search for
+     * @returns the first element found
+     */
+    findByName(name: string, options?: OptionsWithRql): Promise<TemplateV2 | undefined>;
+    /**
+     * Find First
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<TemplateV2 | undefined>;
+    /**
+     * Create a new template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param requestBody TemplateV2Creation
+     * @returns TemplateV2
+     * @throws {ResourceAlreadyExistsError}
+     * @throws {TemplateSyntaxError}
+     */
+    create(requestBody: TemplateV2Creation, options?: OptionsBase): Promise<TemplateV2>;
+    /**
+     * Update an existing template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param templateIdOrName Id or Name of the targeted template
+     * @param requestBody TemplateV2Update
+     * @returns TemplateV2
+     * @throws {ResourceAlreadyExistsError}
+     * @throws {TemplateSyntaxError}
+     * @throws {ResourceUnknownError}
+     */
+    update(templateIdOrName: string, requestBody: TemplateV2Update, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Delete a template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `DELETE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param templateIdOrName Id or Name of the targeted template
+     * @returns AffectedRecords
+     * @throws {ResourceUnknownError}
+     */
+    remove(templateIdOrName: string, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Resolves a template and presents the result as a json response
+     * Permission is **required** for this endpoint
+     * Permission | Scope | Effect
+     * - | - | -
+     * `RESOLVE_TEMPLATES` | `global` | Resolve any template
+     * `RESOLVE_TEMPLATES:{TEMPLATE_NAME}` | `global` | Resolve the specified template
+     *
+     * @param templateIdOrName Id or Name of the targeted template
+     * @param requestBody CreateFile
+     * @returns TemplateV2ResolveOut
+     * @throws {TemplateResolvingError}
+     * @throws {TemplateFillingError}
+     * @throws {ResourceUnknownError}
+     */
+    resolve<InputData = Record<string, any>, Outputs = Record<string, string>>(templateIdOrName: string, requestBody: TemplateV2ResolveIn<InputData>, options?: OptionsBase): Promise<Outputs>;
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+}

package/build/services/types.d.ts

@@ -0,0 +1,103 @@
+import { RQLString } from '../rql';
+export declare type LanguageCode = string;
+export declare type ObjectId = string;
+export interface Entity {
+    id: ObjectId;
+}
+export interface Timestamps {
+    updateTimestamp: Date;
+    creationTimestamp: Date;
+}
+export interface ErrorResponse {
+    code?: number;
+    name?: string;
+    message?: string;
+}
+export interface PagedResult<T> {
+    page: {
+        total: number;
+        offset: number;
+        limit: number;
+    };
+    data: T[];
+}
+export interface AffectedRecords {
+    affectedRecords: number;
+}
+export interface ResultResponse {
+    status: number;
+}
+export declare enum Results {
+    Success = 200
+}
+/**
+ * IANA time zone identifier (e.g. "Europe/Brussels").
+ * We aim to stay aligned with the official IANA time zone database.
+ * In practice, supported values closely match those returned by Intl.supportedValuesOf('timeZone') in JavaScript.
+ * For an overview of IANA time zones, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+ */
+export declare type TimeZone = string;
+export declare type MailAddress = string;
+export declare type MailAddressList = MailAddress[];
+export interface MailRecipients {
+    to: MailAddressList;
+    cc?: MailAddressList;
+    bcc?: MailAddressList;
+}
+export declare type Headers = Record<string, string>;
+export declare type OptionsBase = {
+    /** Added to all HTTP verbs */
+    headers?: Headers;
+    /** Only passed to the GET requests. Will retry 4 times on 500 errors */
+    shouldRetry?: boolean;
+    /**
+     * @deprecated this property is only meant to be used for backwards compatibility when upgrading to v8.0.0.
+     *
+     * Key names that are not chosen by Extra Horizon where also affected by the data normalization before v8.0.0.
+     * They were converted from camel case to snake case before sending the request and the other way around before
+     * providing the response.
+     *
+     * Also fields ending with the name timestamp not chosen by extra horizon in custom properties where automatically
+     * converted to dates. Even though they could be just booleans, strings or numbers. Dates provided in such fields will
+     * now be converted to strings while all other types will stay as they are.
+     *
+     * To enable this behaviour again, set to true.
+     */
+    normalizeCustomData?: boolean;
+};
+export declare type OptionsWithRql = OptionsBase & {
+    rql?: RQLString;
+};
+export interface FileUploadOptions extends OptionsBase {
+    onUploadProgress?: (progress: {
+        loaded: number;
+        total: number;
+    }) => void;
+    /**
+     * AbortSignal to cancel the file upload.
+     *
+     * Example usage:
+     * ```typescript
+     * const controller = new AbortController();
+     * const signal = controller.signal;
+     *
+     * try {
+     *   await exh.files.create(file, { signal });
+     * } catch (error) {
+     *   if (error instanceof RequestAbortedError) {
+     *     console.log('File upload was cancelled, ignoring error');
+     *     return;
+     *   }
+     *   throw error; // Handle other errors
+     * }
+     *
+     * // To cancel the upload, call:
+     * controller.abort();
+     * ```
+     */
+    signal?: AbortSignal;
+}
+export declare type PagedResultWithPager<T> = PagedResult<T> & {
+    previous: () => Promise<PagedResultWithPager<T>>;
+    next: () => Promise<PagedResultWithPager<T>>;
+};

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

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

package/build/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 | undefined>;
+    /**
+     * 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 | undefined>;
+    /**
+     * 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 | undefined>;
+    /**
+     * 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/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/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 | undefined>;
+    /**
+     * 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 | undefined>;
+    /**
+     * 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 | undefined>;
+    /**
+     * 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/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/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;