@extrahorizon/javascript-sdk 8.2.0 → 8.2.1-dev-49-61b4511

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

@@ -1,90 +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>;
-}
+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

@@ -1,5 +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;
+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

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

@@ -1,6 +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;
-};
+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

@@ -1,5 +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;
+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

@@ -1,38 +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;
-}
+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

@@ -1,5 +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;
+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;