@extrahorizon/javascript-sdk 8.2.0-test

package/build/types/services/dispatchers/actions/index.d.ts

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

package/build/types/services/dispatchers/actions/types.d.ts

@@ -0,0 +1,78 @@
+import { AffectedRecords, MailRecipients, ObjectId, OptionsBase } from '../../types';
+export interface ActionsService {
+    /**
+     * ## Create an Action for a Dispatcher
+     *
+     * **Global Permissions:**
+     * - `UPDATE_DISPATCHERS` - Allows a user to update Dispatchers
+     *
+     * @param dispatcherId {@link ObjectId} The id of the Dispatcher to be updated
+     * @param requestBody The data used to create the Action {@link ActionCreation}
+     * @param options - Additional options for the request
+     * @returns The created Action {@link Action}
+     */
+    create(dispatcherId: ObjectId, requestBody: ActionCreation, options?: OptionsBase): Promise<Action>;
+    /**
+     * ## Update an Action of a Dispatcher
+     *
+     * **Global Permissions:**
+     * - `UPDATE_DISPATCHERS` - Allows a user to update Dispatchers
+     *
+     * @param dispatcherId {@link ObjectId} The id of the Dispatcher to be updated
+     * @param actionId {@link ObjectId} The id of the Action to be updated
+     * @param requestBody The data used to update the Action {@link ActionUpdate}
+     * @param options - Additional options for the request
+     * @returns An affected records response {@link AffectedRecords}
+     */
+    update(dispatcherId: ObjectId, actionId: ObjectId, requestBody: ActionUpdate, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * ## Remove an Action from a Dispatcher
+     *
+     * **Global Permissions:**
+     * - `UPDATE_DISPATCHERS` - Allows a user to update Dispatchers
+     *
+     * @param dispatcherId {@link ObjectId} The id of the Dispatcher to remove an Action from
+     * @param actionId {@link ObjectId} The id of the Action to be removed
+     * @param options - Additional options for the request
+     * @returns An affected records response {@link AffectedRecords}
+     */
+    remove(dispatcherId: ObjectId, actionId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
+}
+export declare enum ActionType {
+    MAIL = "mail",
+    TASK = "task"
+}
+export interface ActionBase {
+    id: ObjectId;
+    /** The unique name of the dispatcher */
+    name?: string;
+    /** A description of the dispatcher */
+    description?: string;
+}
+export interface MailAction extends ActionBase {
+    /** The type of Action the Dispatcher will execute */
+    type?: ActionType.MAIL;
+    /** The recipients list of the mail, including to, cc and bcc  */
+    recipients?: MailRecipients;
+    /** The id of the mail template to be consumed */
+    templateId?: ObjectId;
+}
+export interface TaskAction extends ActionBase {
+    /** The type of Action the Dispatcher will execute */
+    type?: ActionType.TASK;
+    /** The name of the Function to be executed as a task */
+    functionName?: string;
+    /** The data to be sent to the Function, the type may be specified by the user */
+    data?: Record<string, string>;
+    /** A list of string identifiers that can be attached to a task */
+    tags?: Array<string>;
+    /** The start timestamp of the task */
+    startTimestamp?: Date;
+}
+export declare type Action = MailAction | TaskAction;
+export declare type MailActionCreation = Omit<MailAction, 'id'>;
+export declare type TaskActionCreation = Omit<TaskAction, 'id'>;
+export declare type ActionCreation = MailActionCreation | TaskActionCreation;
+export declare type MailActionUpdate = Partial<Omit<MailAction, 'id' | 'type'>>;
+export declare type TaskActionUpdate = Partial<Omit<TaskAction, 'id' | 'type'>>;
+export declare type ActionUpdate = MailActionUpdate | TaskActionUpdate;

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

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

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

@@ -0,0 +1,111 @@
+import { FindAllIterator } from '../../helpers';
+import { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResult } from '../../types';
+import { Action, ActionCreation } from '../actions/types';
+export interface DispatchersService {
+    /**
+     * ## Retrieve a paged list of Dispatchers
+     *
+     * **Global Permissions:**
+     * - `VIEW_DISPATCHERS` - Allows a user to view Dispatchers
+     *
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns A paged list of Dispatchers {@link PagedResultWithPager PagedResultWithPager<Dispatcher>}
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<Dispatcher>>;
+    /**
+     * ## Retrieve a list of all Dispatchers
+     *
+     * **Global Permissions:**
+     * - `VIEW_DISPATCHERS` - Allows a user to view Dispatchers
+     *
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An array of Dispatchers {@link Dispatcher Dispatcher[]}
+     */
+    findAll(options?: OptionsWithRql): Promise<Dispatcher[]>;
+    /**
+     * ## Retrieve a paged list of Dispatchers
+     *
+     * **Global Permissions:**
+     * - `VIEW_DISPATCHERS` - Allows a user to view Dispatchers
+     *
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An iterator for the queried Dispatchers {@link FindAllIterator FindAllIterator<Dispatcher>}
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<Dispatcher>;
+    /**
+     * ## Retrieve a Dispatcher by id
+     *
+     * **Global Permissions:**
+     * - `VIEW_DISPATCHERS` - Allows a user to view Dispatchers
+     *
+     * @param id {@link ObjectId} - The id of the targeted Dispatcher
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns The first element of the queried Dispatchers {@link Dispatcher}
+     */
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Dispatcher>;
+    /**
+     * ## Retrieve the first queried Dispatcher
+     *
+     * **Global Permissions:**
+     * - `VIEW_DISPATCHERS` - Allows a user to view Dispatchers
+     *
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns The first element of the queried Dispatchers {@link Dispatcher}
+     */
+    findFirst(options?: OptionsWithRql): Promise<Dispatcher>;
+    /**
+     * ## Create a Dispatcher
+     *
+     * **Global Permissions:**
+     * - `CREATE_DISPATCHERS` - Allows a user to create Dispatchers
+     *
+     * @param requestBody {@link DispatcherCreation} - The data used to create the Dispatcher
+     * @param options {@link OptionsBase} - Additional options for the request
+     * @returns The created Dispatcher {@link Dispatcher}
+     */
+    create(requestBody: DispatcherCreation, options?: OptionsBase): Promise<Dispatcher>;
+    /**
+     * ## Update a Dispatcher
+     *
+     * **Global Permissions:**
+     * - `UPDATE_DISPATCHERS` - Allows a user to update Dispatchers
+     *
+     * @param dispatcherId {@link ObjectId} - The id of the Dispatcher to be updated
+     * @param requestBody {@link DispatcherUpdate} - The data used to update the Dispatcher
+     * @param options {@link OptionsBase} - Additional options for the request
+     * @returns An affected records response {@link AffectedRecords}
+     */
+    update(dispatcherId: ObjectId, requestBody: DispatcherUpdate, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * ## Delete a Dispatcher
+     *
+     * **Global Permissions:**
+     * - `DELETE_DISPATCHERS` - Allows a user to delete Dispatchers
+     *
+     * @param dispatcherId {@link ObjectId} - The id of the Dispatcher to be deleted
+     * @param options {@link OptionsBase} - Additional options for the request
+     * @returns An affected records response {@link AffectedRecords}
+     */
+    remove(dispatcherId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
+}
+export interface Dispatcher {
+    id: ObjectId;
+    /** The unique name of the dispatcher */
+    name?: string;
+    /** A description of the dispatcher */
+    description?: string;
+    /** The type of event the Dispatcher will respond to e.g 'user_deleted' */
+    eventType: string;
+    /** The actions the Dispatcher shall execute */
+    actions: Array<Action>;
+    /** A list of string identifiers that can be attached to a Dispatcher */
+    tags?: Array<string>;
+    /** The creation timestamp of the Dispatcher */
+    creationTimestamp: Date;
+    /** The update timestamp of the Dispatcher */
+    updateTimestamp: Date;
+}
+export declare type DispatcherCreation = Omit<Dispatcher, 'id' | 'creationTimestamp' | 'updateTimestamp' | 'actions'> & {
+    actions: ActionCreation[];
+};
+export declare type DispatcherUpdate = Partial<Omit<Dispatcher, 'id' | 'actions' | 'creationTimestamp' | 'updateTimestamp'>>;

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

@@ -0,0 +1,7 @@
+import type { HttpInstance } from '../../types';
+import actions from './actions';
+import { ActionsService } from './actions/types';
+import { DispatchersService } from './dispatchers/types';
+export declare const dispatchersService: (httpWithAuth: HttpInstance) => DispatchersService & {
+    actions: ActionsService;
+};

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

@@ -0,0 +1,2 @@
+export * from './actions/types';
+export * from './dispatchers/types';

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

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

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

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

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

@@ -0,0 +1,6 @@
+import type { EventsService, HttpInstance, SubscriptionsService } from '../../types';
+import health from './health';
+import subscriptions from './subscriptions';
+export declare const eventsService: (httpWithAuth: HttpInstance) => ReturnType<typeof health> & EventsService & {
+    subscriptions: SubscriptionsService;
+};

package/build/types/services/events/subscriptions.d.ts

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

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

@@ -0,0 +1,90 @@
+import { Entity, ObjectId, OptionsBase, OptionsWithRql, PagedResult, Timestamps } from '../types';
+export interface CreateEvent {
+    type: string;
+    content?: Record<string, any>;
+}
+export declare type Event = CreateEvent & Entity & Timestamps;
+export interface CreateSubscription {
+    service: Service;
+    eventTypes: Array<string>;
+}
+export declare type Subscription = CreateSubscription & Entity & Timestamps;
+export interface Service {
+    name: string;
+    version: Version;
+}
+export interface Version {
+    major: number;
+    minor: number;
+    patch: number;
+}
+export interface EventsService {
+    /**
+     * Returns a list of events
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_EVENTS` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<Event>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<Event>>;
+    /**
+     * Find By Id
+     * @param id the Id to search for
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Event>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<Event>;
+    /**
+     * Creates an event
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_EVENTS` | `global` | **Required** for this endpoint
+     * @param requestBody
+     * @returns Event
+     */
+    create(requestBody: CreateEvent, options?: OptionsBase): Promise<Event>;
+}
+export interface SubscriptionsService {
+    /**
+     * Returns a list of event subscriptions
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_SUBSCRIPTIONS` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<Subscription>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<Subscription>>;
+    /**
+     * Find By Id
+     * @param id the Id to search for
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Subscription>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<Subscription>;
+    /**
+     * Creates an event subscription
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_SUBSCRIPTIONS` | `global` | **Required** for this endpoint
+     * @param requestBody
+     * @returns Subscription
+     */
+    create(requestBody: CreateSubscription, options?: OptionsBase): Promise<Subscription>;
+}

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

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

package/build/types/services/files/formHelpers.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+export declare function createCustomFormData(value: string, boundary: string): Buffer;
+export declare function generateBoundary(): string;

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

@@ -0,0 +1,6 @@
+import type { FileSettingsService, FilesService, HttpInstance } from '../../types';
+import settings from './settings';
+import { FileTokensService } from './types';
+export declare const filesService: (httpWithAuth: HttpInstance) => FilesService & FileTokensService & {
+    settings: FileSettingsService;
+};

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

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

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

@@ -0,0 +1,38 @@
+import { AffectedRecords, OptionsBase } from '../../types';
+export interface FileSettingsService {
+    /**
+     * ## Retrieve the File Service settings
+     *
+     *  ** Global Permissions: **
+     *  - `VIEW_FILE_SERVICE_SETTINGS` - **Required** for this endpoint
+     *
+     * @param options {@link OptionsBase} - Additional options for the request
+     * @returns {@link FileServiceSettings} - The File Service settings
+     */
+    get(options?: OptionsBase): Promise<FileServiceSettings>;
+    /**
+     * ## Update the File Service settings
+     *
+     *  ** Global Permissions: **
+     *  - `UPDATE_FILE_SERVICE_SETTINGS` - **Required** for this endpoint
+     *
+     * @param data {@link FileServiceSettingsUpdate} - The File Service settings to be updated
+     * @param options {@link OptionsBase} - Additional options for the request
+     * @returns {@link AffectedRecords } - A response detailing the number of records affected by the request
+     */
+    update(data: Partial<FileServiceSettingsUpdate>, options?: OptionsBase): Promise<AffectedRecords>;
+}
+export interface FileServiceSettingsUpdate {
+    disableForceDownloadForMimeTypes: string[];
+}
+export interface FileServiceSettings {
+    /**
+     * All files will have a Content-Disposition header with the Attachment value when fetched, unless their MIME type matches a type in this array exactly.
+     *
+     * The Attachment value ensures files are downloaded rather than displayed directly in the browser, enhancing protection against potential XSS vulnerabilities.
+     *
+     * The value *\/\* can be used to allow any file to be displayed by browsers, use at your own discretion.
+     */
+    disableForceDownloadForMimeTypes: string[];
+    updateTimestamp: Date;
+}

package/build/types/services/files/tokens.d.ts

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

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

@@ -0,0 +1,185 @@
+/// <reference types="node" />
+import { ReadStream } from 'fs';
+import type { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResult } from '../types';
+import { FileUploadOptions } from '../types';
+export * from './settings/types';
+/**
+ * The combination of a uuid and id that is used to retrieve the file and decide an access level for the request
+ */
+export declare type Token = string;
+export declare enum TokenPermission {
+    FULL = "full",
+    READ = "read"
+}
+export interface TokenObject {
+    token: Token;
+    accessLevel: TokenPermission;
+}
+export interface FileDetails {
+    tokens: Array<TokenObject>;
+    creatorId: ObjectId;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+    name: string;
+    mimetype: string;
+    size: number;
+    tags?: Array<string>;
+}
+export interface CreateTokenRequest {
+    accessLevel?: TokenPermission;
+}
+/**
+ * As defined by React Native:
+ * https://github.com/facebook/react-native/blob/v0.72.4/packages/react-native/Libraries/Network/FormData.js#L13
+ */
+export declare type ReactNativeFile = {
+    uri: string;
+    name?: string;
+    type?: string;
+};
+export declare type FileDataTypes = Blob | string | Buffer | ReadStream | ReactNativeFile;
+export interface FilesService {
+    /**
+     * List all files
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_FILES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<FileDetails>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<FileDetails>>;
+    /**
+     * Find By Name
+     * @param name the name to search for
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findByName(name: string, options?: OptionsWithRql): Promise<FileDetails>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<FileDetails>;
+    /**
+     * ## Add a new file from a plain text source
+     *
+     * **Default Permissions:**
+     * Everyone can use this endpoint
+     * @param text {@link string} - The text to upload as a file
+     * @param options {@link FileUploadOptions} - Additional options for the request
+     * @returns {@link FileDetails} - The persisted metadata after file creation {@link FileDetails}
+     * @throws {FileTooLargeError} - An error if the uploaded file exceeds the maximum file size
+     */
+    createFromText(text: string, options?: FileUploadOptions): Promise<FileDetails>;
+    /**
+     * ## Add a new file
+     *
+     * Based on the platform `fileData` accepts different types:
+     * - Web browsers: `Blob` or `File`
+     * - Node.js: `string`, `Buffer` or `ReadStream`
+     * - React Native: `{ uri: string, name?: string, type?: string }`
+     *
+     * **Default Permissions:**
+     * Everyone can use this endpoint
+     * @param fileName {@link string} - The name of the file to upload
+     * @param fileData {@link FileDataTypes}  - The data used for file creation
+     * @param options {@link FileUploadOptions} - Additional options for the request
+     * @throws {FileTooLargeError} - An error if the uploaded file exceeds the maximum file size
+     * @returns {@link FileDetails} - The persisted metadata after file creation
+     */
+    create(fileName: string, fileData: FileDataTypes, options?: FileUploadOptions & {
+        tags?: string[];
+    }): Promise<FileDetails>;
+    /**
+     * Delete a file
+     *
+     * AccessLevel | Effect
+     * - | -
+     * `full` | **Required** to be able to delete the file
+     * @param token
+     * @returns AffectedRecords
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     */
+    remove(token: Token, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Retrieve a file from the object store
+     *
+     * Returns an `ArrayBuffer` in web browsers and React Native, a `Buffer` in Node.js
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param token
+     * @returns Buffer
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     */
+    retrieve(token: Token, options?: OptionsBase): Promise<Buffer>;
+    /**
+     * Retrieve a file stream from the object store
+     *
+     * Currently only supported in Node.js
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param token
+     * @returns data as ReadStream
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     */
+    retrieveStream(token: Token, options?: OptionsBase): Promise<{
+        data: ReadStream;
+    }>;
+    /**
+     * Get file details
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     *
+     * AccessLevel | Effect
+     * - | -
+     * `full` | **Required** to return file metadata with all tokens.
+     * `read` | **Required** to return name, size, mimetype.
+     * @param token
+     * @returns FileDetails
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     */
+    getDetails(token: Token, options?: OptionsBase): Promise<FileDetails>;
+}
+export interface FileTokensService {
+    /**
+     * Delete a token
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none |  | Everyone can use this endpoint
+     *
+     * @param token
+     * @param tokenToAccess The token that should be deleted
+     * @returns void
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     * @throws {TokenNotDeleteableError}
+     */
+    deleteToken(token: Token, tokenToAccess: Token, options?: OptionsBase): Promise<void>;
+    /**
+     * Generate a token for a file
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     *
+     * @param token
+     * @param requestBody
+     * @returns TokenObject Success
+     * @throws {InvalidTokenError}
+     * @throws {UnauthorizedTokenError}
+     */
+    generateToken(token: Token, requestBody: CreateTokenRequest, options?: OptionsBase): Promise<TokenObject>;
+}

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

@@ -0,0 +1,7 @@
+import { HttpInstance, HttpRequestConfig } from '../http/types';
+import { OptionsWithRql, PagedResult, PagedResultWithPager } from './types';
+export declare type FindAllIterator<T> = AsyncGenerator<PagedResult<T>, Record<string, never>, void>;
+export declare function findAllIterator<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql): FindAllIterator<T>;
+export declare function findAllGeneric<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql, level?: number): Promise<T[]>;
+export declare function addPagersFn<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql, pagedResult: PagedResult<T>): PagedResultWithPager<T>;
+export declare function setCustomKeysConfigurationInRequestConfig(httpInstance: HttpInstance, requestOptions?: HttpRequestConfig): HttpRequestConfig;

package/build/types/services/http-client.d.ts

@@ -0,0 +1,22 @@
+import { HttpInstance, HttpRequestConfig } from '../http/types';
+interface HttpClientOptions {
+    basePath: string;
+    transformRequestData?(args: Record<string, unknown>, options?: HttpRequestConfig): Record<string, unknown>;
+}
+interface Options {
+    gzip?: boolean;
+}
+interface GetOptions {
+    shouldRetry?: boolean;
+}
+declare const httpClient: ({ basePath, transformRequestData, }: HttpClientOptions) => {
+    get: (axios: HttpInstance, url: string, { shouldRetry, ...config }?: HttpRequestConfig & GetOptions) => Promise<import("axios").AxiosResponse<any, any>>;
+    put: (axios: HttpInstance, url: string, data: any, config?: HttpRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    post: (axios: HttpInstance, url: string, data: any, config?: HttpRequestConfig, options?: Options) => Promise<import("axios").AxiosResponse<any, any>>;
+    delete: (axios: HttpInstance, url: string, config?: HttpRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    patch: (axios: HttpInstance, url: string, data: any, config?: HttpRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    options: (axios: HttpInstance, url: string) => Promise<import("axios").AxiosResponse<any, any>>;
+    head: (axios: HttpInstance, url: string) => Promise<import("axios").AxiosResponse<any, any>>;
+};
+export default httpClient;
+export declare type HttpClient = ReturnType<typeof httpClient>;

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

@@ -0,0 +1,15 @@
+export * from './auth';
+export * from './data';
+export * from './files';
+export * from './tasks';
+export * from './users';
+export * from './configurations';
+export * from './templates';
+export * from './mails';
+export * from './dispatchers';
+export * from './payments';
+export * from './localizations';
+export * from './profiles';
+export * from './notifications';
+export * from './events';
+export * from './logs';

package/build/types/services/localizations/countries.d.ts

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

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

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