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

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

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

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

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

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

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

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

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

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

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

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

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