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

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

@@ -1,15 +1,15 @@
-import { ApiRequestService } from '../../types';
-import type { ApiService, FunctionsService, HttpInstance, LogsService, SchedulesService } from '../../types';
-import api from './api';
-import apiRequests from './apiRequests';
-import functions from './functions';
-import logs from './logs';
-import schedules from './schedules';
-import { TasksService } from './types';
-export declare const tasksService: (httpWithAuth: HttpInstance) => TasksService & {
-    schedules: SchedulesService;
-    functions: FunctionsService;
-    api: ApiService;
-    logs: LogsService;
-    apiRequests: ApiRequestService;
-};
+import { ApiRequestService } from '../../types';
+import type { ApiService, FunctionsService, HttpInstance, LogsService, SchedulesService } from '../../types';
+import api from './api';
+import apiRequests from './apiRequests';
+import functions from './functions';
+import logs from './logs';
+import schedules from './schedules';
+import { TasksService } from './types';
+export declare const tasksService: (httpWithAuth: HttpInstance) => TasksService & {
+    schedules: SchedulesService;
+    functions: FunctionsService;
+    api: ApiService;
+    logs: LogsService;
+    apiRequests: ApiRequestService;
+};

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

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

package/build/types/services/tasks/logs/types.d.ts

@@ -1,28 +1,28 @@
-import { ObjectId, OptionsWithRql } from '../../types';
-export interface LogsService {
-    /**
-     * ## Retrieve a list of logs for a task
-     *
-     * **Global Permissions:**
-     * - `VIEW_TASK_LOGS` - **Required** for this endpoint
-     *
-     * @param taskId {@link string} The id of the targeted task
-     * @param options {@link OptionsWithRql} - Additional options for the request
-     * @returns An array of task logs {@link LogLine LineLog[]}
-     */
-    find(taskId: ObjectId, options?: OptionsWithRql): Promise<LogLine[]>;
-    /**
-     * ## Retrieve the first queried task log
-     *
-     * **Global Permissions:**
-     * - `VIEW_TASK_LOGS` - **Required** for this endpoint
-     *
-     * @param taskId {@link string} The id of the targeted task
-     * @param options {@link OptionsWithRql} - Additional options for the request
-     * @returns The first element of the queried task logs {@link LogLine}     */
-    findFirst(taskId: ObjectId, options?: OptionsWithRql): Promise<LogLine>;
-}
-export interface LogLine {
-    message: string;
-    timestamp: Date;
-}
+import { ObjectId, OptionsWithRql } from '../../types';
+export interface LogsService {
+    /**
+     * ## Retrieve a list of logs for a task
+     *
+     * **Global Permissions:**
+     * - `VIEW_TASK_LOGS` - **Required** for this endpoint
+     *
+     * @param taskId {@link string} The id of the targeted task
+     * @param options {@link OptionsWithRql} - Additional options for the request
+     * @returns An array of task logs {@link LogLine LineLog[]}
+     */
+    find(taskId: ObjectId, options?: OptionsWithRql): Promise<LogLine[]>;
+    /**
+     * ## Retrieve the first queried task log
+     *
+     * **Global Permissions:**
+     * - `VIEW_TASK_LOGS` - **Required** for this endpoint
+     *
+     * @param taskId {@link string} The id of the targeted task
+     * @param options {@link OptionsWithRql} - Additional options for the request
+     * @returns The first element of the queried task logs {@link LogLine}     */
+    findFirst(taskId: ObjectId, options?: OptionsWithRql): Promise<LogLine>;
+}
+export interface LogLine {
+    message: string;
+    timestamp: Date;
+}

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

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

package/build/types/services/tasks/schedules/types.d.ts

@@ -1,88 +1,88 @@
-import { FindAllIterator } from '../../helpers';
-import { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResultWithPager } from '../../types';
-export interface SchedulesService {
-    /**
-     * ## Create a new Schedule
-     *
-     * **Global Permissions:**
-     * - `CREATE_TASK_SCHEDULE` - Allows a user to create schedules
-     *
-     * @param schedule - The data used to create the schedule
-     * @param options - Additional options for the request
-     */
-    create<T>(schedule: ScheduleCreation<T>, options?: OptionsBase): Promise<Schedule<T>>;
-    /**
-     * ## Delete a Schedule
-     *
-     * **Global Permissions:**
-     * - `DELETE_TASK_SCHEDULE` - Allows a user to delete schedules
-     *
-     * @param scheduleId - The id of the schedule to delete
-     * @param options - Additional options for the request
-     */
-    delete(scheduleId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
-    /**
-     * ## Retrieve a paged list of schedules
-     *
-     * **Global Permissions:**
-     * - `VIEW_TASK_SCHEDULES` - Allows a user to view schedules
-     *
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns A paged list of schedules {@link PagedResultWithPager PagedResultWithPager<Schedule>}
-     */
-    find<T>(options?: OptionsWithRql): Promise<PagedResultWithPager<Schedule<T>>>;
-    /**
-     * ## Retrieve a list of all Schedules
-     *
-     * **Global Permissions:**
-     * - `VIEW_TASK_SCHEDULES` - Allows a user to view schedules
-     *
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns An array of Schedules {@link Schedule Schedule[]}
-     * @throws {@link Error} Do not pass in limit operator with findAll
-     */
-    findAll<T>(options?: OptionsWithRql): Promise<Schedule<T>[]>;
-    /**
-     * ## Retrieve a paged list of Schedules
-     *
-     * **Global Permissions:**
-     * - `VIEW_TASK_SCHEDULES` - Allows a user to view Schedules
-     *
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns An iterator for the queried schedules {@link FindAllIterator FindAllIterator<Schedule>}
-     */
-    findAllIterator<T>(options?: OptionsWithRql): FindAllIterator<Schedule<T>>;
-    /**
-     * ## Retrieve the first queried Schedule
-     *
-     * **Global Permissions:**
-     * - `VIEW_TASK_SCHEDULES` - Allows a user to view Schedules
-     *
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns The first element of the queried Schedules {@link Schedule}
-     */
-    findFirst<T>(options?: OptionsWithRql): Promise<Schedule<T>>;
-}
-export interface ScheduleCreation<T = Record<string, any>> {
-    /** The period in seconds, for which the function defined will execute recurrently */
-    interval: number;
-    /** The functionName property serves as the unique identifier amongst all Functions */
-    functionName: string;
-    /** The data to be provided to the Function, the type may be user defined */
-    data?: T;
-    /** The priority of the schedule (Higher priorities shall execute first) */
-    priority?: number;
-    /** The timestamp at which the schedule will start executing */
-    startTimestamp?: Date;
-}
-export interface Schedule<T = Record<string, any>> extends ScheduleCreation<T> {
-    id: ObjectId;
-    /** The timestamp at which the schedule will start executing */
-    startTimestamp: Date;
-    /** The timestamp at which the schedule was last updated */
-    updateTimestamp: Date;
-    /** The timestamp at which the schedule was created */
-    creationTimestamp: Date;
-    /** The timestamp at which the schedule will next execute */
-    nextTimestamp: Date;
-}
+import { FindAllIterator } from '../../helpers';
+import { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResultWithPager } from '../../types';
+export interface SchedulesService {
+    /**
+     * ## Create a new Schedule
+     *
+     * **Global Permissions:**
+     * - `CREATE_TASK_SCHEDULE` - Allows a user to create schedules
+     *
+     * @param schedule - The data used to create the schedule
+     * @param options - Additional options for the request
+     */
+    create<T>(schedule: ScheduleCreation<T>, options?: OptionsBase): Promise<Schedule<T>>;
+    /**
+     * ## Delete a Schedule
+     *
+     * **Global Permissions:**
+     * - `DELETE_TASK_SCHEDULE` - Allows a user to delete schedules
+     *
+     * @param scheduleId - The id of the schedule to delete
+     * @param options - Additional options for the request
+     */
+    delete(scheduleId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * ## Retrieve a paged list of schedules
+     *
+     * **Global Permissions:**
+     * - `VIEW_TASK_SCHEDULES` - Allows a user to view schedules
+     *
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns A paged list of schedules {@link PagedResultWithPager PagedResultWithPager<Schedule>}
+     */
+    find<T>(options?: OptionsWithRql): Promise<PagedResultWithPager<Schedule<T>>>;
+    /**
+     * ## Retrieve a list of all Schedules
+     *
+     * **Global Permissions:**
+     * - `VIEW_TASK_SCHEDULES` - Allows a user to view schedules
+     *
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An array of Schedules {@link Schedule Schedule[]}
+     * @throws {@link Error} Do not pass in limit operator with findAll
+     */
+    findAll<T>(options?: OptionsWithRql): Promise<Schedule<T>[]>;
+    /**
+     * ## Retrieve a paged list of Schedules
+     *
+     * **Global Permissions:**
+     * - `VIEW_TASK_SCHEDULES` - Allows a user to view Schedules
+     *
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An iterator for the queried schedules {@link FindAllIterator FindAllIterator<Schedule>}
+     */
+    findAllIterator<T>(options?: OptionsWithRql): FindAllIterator<Schedule<T>>;
+    /**
+     * ## Retrieve the first queried Schedule
+     *
+     * **Global Permissions:**
+     * - `VIEW_TASK_SCHEDULES` - Allows a user to view Schedules
+     *
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns The first element of the queried Schedules {@link Schedule}
+     */
+    findFirst<T>(options?: OptionsWithRql): Promise<Schedule<T>>;
+}
+export interface ScheduleCreation<T = Record<string, any>> {
+    /** The period in seconds, for which the function defined will execute recurrently */
+    interval: number;
+    /** The functionName property serves as the unique identifier amongst all Functions */
+    functionName: string;
+    /** The data to be provided to the Function, the type may be user defined */
+    data?: T;
+    /** The priority of the schedule (Higher priorities shall execute first) */
+    priority?: number;
+    /** The timestamp at which the schedule will start executing */
+    startTimestamp?: Date;
+}
+export interface Schedule<T = Record<string, any>> extends ScheduleCreation<T> {
+    id: ObjectId;
+    /** The timestamp at which the schedule will start executing */
+    startTimestamp: Date;
+    /** The timestamp at which the schedule was last updated */
+    updateTimestamp: Date;
+    /** The timestamp at which the schedule was created */
+    creationTimestamp: Date;
+    /** The timestamp at which the schedule will next execute */
+    nextTimestamp: Date;
+}

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

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

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

@@ -1,107 +1,107 @@
-import { FindAllIterator } from '../../services/helpers';
-import type { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResult } from '../types';
-export * from './api/types';
-export * from './apiRequests/types';
-export * from './functions/types';
-export * from './logs/types';
-export * from './schedules/types';
-export declare enum TaskStatus {
-    NEW = "new",
-    IN_PROGRESS = "inProgress",
-    COMPLETE = "complete",
-    FAILED = "failed",
-    CANCELED = "canceled"
-}
-export interface Task<DataType = any> {
-    id?: ObjectId;
-    status?: TaskStatus;
-    statusChangedTimestamp?: Date;
-    /**
-     * AWS Lambda function name
-     */
-    functionName: string;
-    /**
-     * Data send to the function
-     */
-    data?: DataType;
-    startTimestamp?: Date;
-    tags?: Array<string>;
-    priority?: number;
-    creationTimestamp?: Date;
-    updateTimestamp?: Date;
-    /** The Extra Horizon document id for the application used to make the request */
-    createdByApplicationId?: ObjectId;
-    /** The Extra Horizon document id for the user who made the request */
-    createdByUserId?: ObjectId;
-}
-export declare type TaskInput = Pick<Task, 'functionName' | 'data' | 'startTimestamp' | 'priority' | 'tags'>;
-export interface TasksService {
-    /**
-     * View a list of tasks
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `VIEW_TASKS` | `gobal` | **Required** for this endpoint
-     * @returns PagedResult<Task>
-     */
-    find(options?: OptionsWithRql): Promise<PagedResult<Task>>;
-    /**
-     * 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<Task>;
-    /**
-     * Request a list of all tasks
-     *
-     * Do not pass in an rql with limit operator!
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `VIEW_TASKS` | `gobal` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns Task[]
-     */
-    findAll(options?: OptionsWithRql): Promise<Task[]>;
-    /**
-     * Request a list of all tasks
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `VIEW_TASKS` | `gobal` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns Task[]
-     */
-    findAllIterator(options?: OptionsWithRql): FindAllIterator<Task>;
-    /**
-     * Find First
-     * @param rql an optional rql string
-     * @returns the first element found
-     */
-    findFirst(options?: OptionsWithRql): Promise<Task>;
-    /**
-     * Create a task
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `CREATE_TASKS` | `gobal` | **Required** for this endpoint
-     * @param requestBody
-     * @returns Task Success
-     */
-    create(requestBody: TaskInput, options?: OptionsBase): Promise<Task>;
-    /**
-     * Cancel a task
-     *
-     * The targeted task **MUST** be in the `new` status.
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `CANCEL_TASKS` | `gobal` | **Required** for this endpoint
-     * @param taskId The id of the targeted task
-     * @returns AffectedRecords
-     * @throws {IllegalStateException}
-     * @throws {ResourceUnknownException}
-     */
-    cancel(taskId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
-}
+import { FindAllIterator } from '../../services/helpers';
+import type { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResult } from '../types';
+export * from './api/types';
+export * from './apiRequests/types';
+export * from './functions/types';
+export * from './logs/types';
+export * from './schedules/types';
+export declare enum TaskStatus {
+    NEW = "new",
+    IN_PROGRESS = "inProgress",
+    COMPLETE = "complete",
+    FAILED = "failed",
+    CANCELED = "canceled"
+}
+export interface Task<DataType = any> {
+    id?: ObjectId;
+    status?: TaskStatus;
+    statusChangedTimestamp?: Date;
+    /**
+     * AWS Lambda function name
+     */
+    functionName: string;
+    /**
+     * Data send to the function
+     */
+    data?: DataType;
+    startTimestamp?: Date;
+    tags?: Array<string>;
+    priority?: number;
+    creationTimestamp?: Date;
+    updateTimestamp?: Date;
+    /** The Extra Horizon document id for the application used to make the request */
+    createdByApplicationId?: ObjectId;
+    /** The Extra Horizon document id for the user who made the request */
+    createdByUserId?: ObjectId;
+}
+export declare type TaskInput = Pick<Task, 'functionName' | 'data' | 'startTimestamp' | 'priority' | 'tags'>;
+export interface TasksService {
+    /**
+     * View a list of tasks
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TASKS` | `gobal` | **Required** for this endpoint
+     * @returns PagedResult<Task>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<Task>>;
+    /**
+     * 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<Task>;
+    /**
+     * Request a list of all tasks
+     *
+     * Do not pass in an rql with limit operator!
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TASKS` | `gobal` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns Task[]
+     */
+    findAll(options?: OptionsWithRql): Promise<Task[]>;
+    /**
+     * Request a list of all tasks
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TASKS` | `gobal` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns Task[]
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<Task>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<Task>;
+    /**
+     * Create a task
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_TASKS` | `gobal` | **Required** for this endpoint
+     * @param requestBody
+     * @returns Task Success
+     */
+    create(requestBody: TaskInput, options?: OptionsBase): Promise<Task>;
+    /**
+     * Cancel a task
+     *
+     * The targeted task **MUST** be in the `new` status.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CANCEL_TASKS` | `gobal` | **Required** for this endpoint
+     * @param taskId The id of the targeted task
+     * @returns AffectedRecords
+     * @throws {IllegalStateException}
+     * @throws {ResourceUnknownException}
+     */
+    cancel(taskId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
+}

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

@@ -1,3 +1,3 @@
-import type { HttpInstance } from '../../types';
-import { TemplatesService } from './types';
-export declare const templatesService: (httpWithAuth: HttpInstance) => TemplatesService;
+import type { HttpInstance } from '../../types';
+import { TemplatesService } from './types';
+export declare const templatesService: (httpWithAuth: HttpInstance) => TemplatesService;

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

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