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

package/build/services/profiles/groups.d.ts

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

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

@@ -0,0 +1,8 @@
+import type { HttpInstance } from '../../types';
+import groups from './groups';
+import logs from './logs';
+import { ProfilesGroupsService, ProfilesLogsService, ProfilesService } from './types';
+export declare const profilesService: (httpWithAuth: HttpInstance) => ProfilesService & {
+    groups: ProfilesGroupsService;
+    logs: ProfilesLogsService;
+};

package/build/services/profiles/logs.d.ts

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

package/build/services/profiles/profiles.d.ts

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

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

@@ -0,0 +1,375 @@
+import { RQLString } from '../../rql';
+import { FindAllIterator } from '../../services/helpers';
+import { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResult } from '../types';
+export interface Profile {
+    id: ObjectId;
+    addressLine1?: string;
+    addressLine2?: string;
+    country: string;
+    region?: string;
+    city?: string;
+    postalCode?: string;
+    birthday: string;
+    /**
+     * See ISO 5218
+     */
+    gender: number;
+    length?: number;
+    weight?: number;
+    afHistory?: boolean;
+    comorbidities?: Array<Comorbidities>;
+    physician?: string;
+    smoker?: boolean;
+    activity?: ProfileActivity;
+    impediments?: Array<Impediments>;
+    medication?: Array<Medication>;
+    groups?: Array<Group>;
+    customFields?: Record<string, string>;
+    fibricheckInfo?: {
+        app?: {
+            version?: string;
+            build?: string;
+            branch?: string;
+        };
+        device?: {
+            os?: string;
+            model?: string;
+            type?: 'android' | 'ios';
+            manufacturer?: string;
+        };
+    };
+    creationTimestamp?: Date;
+    updateTimestamp?: Date;
+}
+export declare type ProfileCreation = Pick<Profile, 'id' | 'country' | 'region' | 'birthday' | 'gender'>;
+export declare type ProfileUpdate = Partial<Omit<Profile, 'id' | 'groups' | 'medication' | 'creationTimestamp' | 'updateTimestamp'>>;
+export declare enum ProfileActivity {
+    NOT_ACTIVE = "NOT_ACTIVE",
+    SLIGHTLY_ACTIVE = "SLIGHTLY_ACTIVE",
+    MODERATELY_ACTIVE = "MODERATELY_ACTIVE",
+    ACTIVE = "ACTIVE",
+    VERY_ACTIVE = "VERY_ACTIVE"
+}
+export declare enum Comorbidities {
+    HEART_FAILURE = "HEART_FAILURE",
+    DIABETES = "DIABETES",
+    COPD = "COPD",
+    HYPERTENSION = "HYPERTENSION",
+    VASCULAR_DISEASE = "VASCULAR_DISEASE",
+    HISTORY_OF_TIA_STROKE = "HISTORY_OF_TIA_STROKE"
+}
+export declare enum Impediments {
+    TREMOR = "TREMOR",
+    PERNIOSIS = "PERNIOSIS",
+    CALLUS = "CALLUS"
+}
+export interface Medication {
+    name: string;
+    dosis: {
+        number?: number;
+        unit?: MedicationUnit;
+    };
+    medicationFrequency?: MedicationFrequency;
+    count: number;
+}
+export declare enum MedicationUnit {
+    MG = "mg",
+    ML = "ml",
+    PILL = "pill"
+}
+export declare enum MedicationFrequency {
+    AS_NEEDED = "AS_NEEDED",
+    EVERY_DAY = "EVERY_DAY",
+    EVERY_WEEK = "EVERY_WEEK",
+    EVERY_MONTH = "EVERY_MONTH",
+    BIRTH_CONTROL = "BIRTH_CONTROL"
+}
+export interface Group {
+    groupId: ObjectId;
+    reason?: string;
+    /**
+     * This serves as a field to link a patient to the medical record of a hospital/physician. This field therefor accepts any string, not just an ObjectId.
+     *
+     */
+    patientId?: string;
+    customFields?: Record<string, string>;
+}
+export declare type GroupCreation = Group;
+export interface LogEntry {
+    id?: ObjectId;
+    profileId?: ObjectId;
+    groupId?: ObjectId;
+    userId?: ObjectId;
+    text?: string;
+    creationTimestamp?: Date;
+    updateTimestamp?: Date;
+}
+export interface ProfileComment {
+    text: string;
+}
+export interface ProfilesGroupsService {
+    /**
+     * Add a group enlistment to a profile
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Add a group enlistment for your profile only
+     * `ADD_PATIENT` | `staff enlistment` | Add a group enlistment for any profile of this group
+     * `ADD_PATIENT` & `ACTIVATE_PRESCRIPTIONS` | `global` | Add a group enlistment for any profile for any group
+     * @param profileId Id of the targeted profile
+     * @param requestBody Group data
+     * @returns Group
+     * @throws {ResourceAlreadyExistsError}
+     * @throws {ResourceUnknownError}
+     */
+    create(profileId: ObjectId, requestBody: GroupCreation, options?: OptionsBase): Promise<Group>;
+    /**
+     * Update a group enlistment on a profile
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_PROFILES` | `staff enlistment` | Update a group enlistment for any profile for this group
+     * `UPDATE_PROFILES` | `global` | Update a group enlistment for any profile for any group
+     * @param profileId Id of the targeted profile
+     * @param groupId Id of the targeted group
+     * @param requestBody Group data to update
+     * @returns Group
+     * @throws {ResourceUnknownError}
+     */
+    update(profileId: ObjectId, groupId: ObjectId, requestBody: Omit<Group, 'groupId'>, options?: OptionsBase): Promise<Group>;
+    /**
+     * Delete a group from a profile
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Delete a group from your profile only
+     * `UPDATE_PROFILES` | `staff enlistment` | Delete a group from any profile in this group
+     * `UPDATE_PROFILES` | `global` | Delete a group from any profile in any group
+     * @param profileId Id of the targeted profile
+     * @param groupId Id of the targeted group
+     * @returns AffectedRecords
+     * @throws {ResourceUnknownError}
+     */
+    remove(profileId: ObjectId, groupId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Remove a field on a group enlistment object in a profile
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_PROFILES` | `staff enlistment` | Remove a field for this group
+     * `UPDATE_PROFILES` | `global` | Remove a field for any group
+     * @param profileId Id of the targeted profile
+     * @param groupId Id of the targeted group
+     * @param requestBody list of fields to remove
+     * @returns Group
+     * @throws {ResourceUnknownError}
+     */
+    removeFields(profileId: ObjectId, groupId: ObjectId, requestBody: {
+        fields: Array<string>;
+    }, options?: OptionsBase): Promise<Group>;
+}
+export interface ProfilesLogsService {
+    /**
+     * Create a profile log entry
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_PROFILE_LOG_ENTRIES` | `staff enlistment` | Create a log entry for any profile of this group
+     * `CREATE_PROFILE_LOG_ENTRIES` | `global` | Create a log entry for any profile of any group
+     * @param profileId Id of the targeted profile
+     * @param groupId Id of the targeted group
+     * @param requestBody ProfileComment
+     * @returns LogEntry
+     * @throws {ResourceUnknownError}
+     */
+    create(profileId: ObjectId, groupId: ObjectId, requestBody: ProfileComment, options?: OptionsBase): Promise<LogEntry>;
+    /**
+     * Retrieve all profile log entries
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_PROFILE_LOG_ENTRIES` | `staff enlistment` | Retrieve a list of log entries for any profile of this group
+     * `VIEW_PROFILE_LOG_ENTRIES` | `global` | Retrieve a list of log entries for any profile of any group
+     * @param profileId Id of the targeted profile
+     * @param groupId Id of the targeted group
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<LogEntry>
+     * @throws {ResourceUnknownError}
+     */
+    find(profileId: ObjectId, groupId: ObjectId, options?: OptionsWithRql): Promise<PagedResult<LogEntry>>;
+    /**
+     * Request a list of all profile log entries
+     *
+     * Do not pass in an rql with limit operator!
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_PROFILE_LOG_ENTRIES` | `staff enlistment` | Retrieve a list of log entries for any profile of this group
+     * `VIEW_PROFILE_LOG_ENTRIES` | `global` | Retrieve a list of log entries for any profile of any group
+     * @param profileId Id of the targeted profile
+     * @param groupId Id of the targeted group
+     * @param rql Add filters to the requested list.
+     * @returns LogEntry[]
+     */
+    findAll(profileId: ObjectId, groupId: ObjectId, options?: OptionsWithRql): Promise<LogEntry[]>;
+    /**
+     * Request a list of all profile log entries
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_PROFILE_LOG_ENTRIES` | `staff enlistment` | Retrieve a list of log entries for any profile of this group
+     * `VIEW_PROFILE_LOG_ENTRIES` | `global` | Retrieve a list of log entries for any profile of any group
+     * @param profileId Id of the targeted profile
+     * @param groupId Id of the targeted group
+     * @param rql Add filters to the requested list.
+     * @returns LogEntry[]
+     */
+    findAllIterator(profileId: ObjectId, groupId: ObjectId, options?: OptionsWithRql): FindAllIterator<LogEntry>;
+    /**
+     * Update a profile log entry
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_PROFILE_LOG_ENTRIES` | `staff enlistment` | Update a log entry, created by the current user, for any profile of this group
+     * `CREATE_PROFILE_LOG_ENTRIES` | `global` | Update a log entry, created by the current user, for any profile of any group
+     * @param profileId Id of the targeted profile
+     * @param groupId Id of the targeted group
+     * @param entryId Id of the targeted log entry
+     * @param requestBody ProfileComment
+     * @returns LogEntry
+     * @throws {ResourceUnknownError}
+     */
+    update(profileId: ObjectId, groupId: ObjectId, entryId: ObjectId, requestBody: ProfileComment, options?: OptionsBase): Promise<LogEntry>;
+    /**
+     * Delete a profile log entry
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_PROFILE_LOG_ENTRIES` | `staff enlistment` | Delete a log entry, created by the current user, for any profile of this group
+     * `CREATE_PROFILE_LOG_ENTRIES` | `global` | Delete a log entry, created by the current user, for any profile of any group
+     * @param profileId Id of the targeted profile
+     * @param groupId Id of the targeted group
+     * @param entryId Id of the targeted log entry
+     * @returns AffectedRecords
+     * @throws {ResourceUnknownError}
+     */
+    remove(profileId: ObjectId, groupId: ObjectId, entryId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
+}
+export interface ProfilesService {
+    /**
+     * Get a list of profiles
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | View your profile
+     * none | `staff enlistment` | View all the profiles of the group
+     * `VIEW_PATIENTS` | `global` | View all profiles
+     * @param rql an optional rql string
+     * @returns PagedResult<Profile>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<Profile>>;
+    /**
+     * Request a list of all profiles
+     *
+     * Do not pass in an rql with limit operator!
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | View your profile
+     * none | `staff enlistment` | View all the profiles of the group
+     * `VIEW_PATIENTS` | `global` | View all profiles
+     * @param rql Add filters to the requested list.
+     * @returns Profile[]
+     */
+    findAll(options?: OptionsWithRql): Promise<Profile[]>;
+    /**
+     * Request a list of all profiles
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | View your profile
+     * none | `staff enlistment` | View all the profiles of the group
+     * `VIEW_PATIENTS` | `global` | View all profiles
+     * @param rql Add filters to the requested list.
+     * @returns Profile[]
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<Profile>;
+    /**
+     * 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<Profile | undefined>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<Profile | undefined>;
+    /**
+     * Create a new profile
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Create a profile for the current user
+     * `CREATE_PROFILES` | `global` | Create a profile for any user
+     * @param requestBody ProfileCreation
+     * @returns Profile
+     * @throws {ProfileAlreadyExistsError}
+     */
+    create(requestBody: ProfileCreation, options?: OptionsBase): Promise<Profile>;
+    /**
+     * Update an existing profile
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Update your profile
+     * `UPDATE_PROFILES` | `staff enlistment` | Update the profile of any group member
+     * `UPDATE_PROFILES` | `global` | Update any profile
+     * @param rql Add filters to the requested list, **required**.
+     * @param requestBody The Profile data to update
+     * @returns AffectedRecords
+     */
+    update(rql: RQLString, requestBody: ProfileUpdate, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Remove a given field from all profile records
+     *
+     * To make a selection of profiles, use RQL.
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Remove a given field from your profile
+     * `UPDATE_PROFILES` | `staff enlistment` | Remove a given field from any group member
+     * `UPDATE_PROFILES` | `global` | Remove a given field from any profile
+     * @param rql Add filters to the requested list, **required**.
+     * @param requestBody the list of fields to remove
+     * @returns AffectedRecords
+     * @throws {RemoveFieldError}
+     */
+    removeFields(rql: RQLString, requestBody: {
+        fields: Array<string>;
+    }, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Retrieve a list of all the defined comorbidities
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @returns PagedResult<Comorbidities>
+     */
+    getComorbidities(options?: OptionsBase): Promise<PagedResult<Comorbidities>>;
+    /**
+     * Retrieve a list of all the defined impediments
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @returns PagedResult<Impediments>
+     */
+    getImpediments(options?: OptionsBase): Promise<PagedResult<Impediments>>;
+    /**
+     * Perform a health check for profiles service
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+}

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

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

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

@@ -0,0 +1,146 @@
+import { OptionsBase } from '../../types';
+export interface ApiService {
+    /**
+     * ## Execute a GET request towards an API function
+     *
+     * **Default Permissions:**
+     * - Any party may execute API functions with the `public` permission mode
+     * - Any authenticated user may execute API functions with the `allUsers` permission mode
+     *
+     * **Global Permissions:**
+     * - `EXECUTE_API_FUNCTION` - A user may execute all API functions
+     * - `EXECUTE_API_FUNCTION:{FUNCTION_NAME}` - A user may execute the API function specified by the FUNCTION_NAME
+     *
+     *  @template T
+     *  @param functionName {@link string} - The functionName property serves as the unique identifier amongst all Functions
+     *  @param path {@link string} - The targeted route within the Function
+     *  @param options {@link OptionsBase} - Additional options for the request.
+     *  @returns {T} - A user defined type defining the response from the API function
+     */
+    get<T>(functionName: string, path: string, options: OptionsBase): Promise<T>;
+    /**
+     * ## Execute a POST request towards an API function
+     *
+     * **Default Permissions:**
+     * - Any party may execute API functions with the `public` permission mode
+     * - Any authenticated user may execute API functions with the `allUsers` permission mode
+     *
+     * **Global Permissions:**
+     * - `EXECUTE_API_FUNCTION` - A user may execute all API functions
+     * - `EXECUTE_API_FUNCTION:{FUNCTION_NAME}` - A user may execute the API function specified by the FUNCTION_NAME
+     *
+     *  @param functionName {@link string} - The functionName property serves as the unique identifier amongst all Functions
+     *  @param path {@link string} - The targeted route within the Function
+     *  @param data {@link U} - The data to be sent to the Function, the type may be user defined
+     *  @param options {@link OptionsBase} - Additional options for the request
+     *  @returns {@link T} - The response return from the Function, the type may be user defined
+     */
+    post<T, U>(functionName: string, path: string, data: U, options: OptionsBase): Promise<T>;
+    /**
+     * ## Execute a PUT request towards an API function
+     *
+     * **Default Permissions:**
+     * - Any party may execute API functions with the `public` permission mode
+     * - Any authenticated user may execute API functions with the `allUsers` permission mode
+     *
+     * **Global Permissions:**
+     * - `EXECUTE_API_FUNCTION` - A user may execute all API functions
+     * - `EXECUTE_API_FUNCTION:{FUNCTION_NAME}` - A user may execute the API function specified by the FUNCTION_NAME
+     *
+     *  @param functionName {@link string} - The functionName property serves as the unique identifier amongst all Functions
+     *  @param path {@link string} - The targeted route within the Function
+     *  @param data {@link U} - The data to be sent to the Function, the type may be user defined
+     *  @param options {@link OptionsBase} - Additional options for the request
+     *  @returns {@link T} - The response return from the Function, the type may be user defined
+     */
+    put<T, U>(functionName: string, path: string, data: U, options: OptionsBase): Promise<T>;
+    /**
+     * ## Execute a DELETE request towards an API function
+     *
+     * **Default Permissions:**
+     * - Any party may execute API functions with the `public` permission mode
+     * - Any authenticated user may execute API functions with the `allUsers` permission mode
+     *
+     * **Global Permissions:**
+     * - `EXECUTE_API_FUNCTION` - A user may execute all API functions
+     * - `EXECUTE_API_FUNCTION:{FUNCTION_NAME}` - A user may execute the API function specified by the FUNCTION_NAME
+     *
+     *  @param functionName {@link string} - The functionName property serves as the unique identifier amongst all Functions
+     *  @param path {@link string} - The targeted route within the Function
+     *  @param options {@link OptionsBase} - Additional options for the request
+     *  @returns {@link T} - The response return from the Function, the type may be user defined
+     */
+    delete<T>(functionName: string, path: string, options: OptionsBase): Promise<T>;
+    /**
+     * ## Execute a PATCH request towards an API function
+     *
+     * **Default Permissions:**
+     * - Any party may execute API functions with the `public` permission mode
+     * - Any authenticated user may execute API functions with the `allUsers` permission mode
+     *
+     * **Global Permissions:**
+     * - `EXECUTE_API_FUNCTION` - A user may execute all API functions
+     * - `EXECUTE_API_FUNCTION:{FUNCTION_NAME}` - A user may execute the API function specified by the FUNCTION_NAME
+     *
+     *  @param functionName {@link string} - The functionName property serves as the unique identifier amongst all Functions
+     *  @param path {@link string} - The targeted route within the Function
+     *  @param data {@link U} - The data to be sent to the Function, the type may be user defined
+     *  @param options {@link OptionsBase} - Additional options for the request
+     *  @returns {@link T} - The response return from the Function, the type may be user defined
+     */
+    patch<T, U>(functionName: string, path: string, data: U, options: OptionsBase): Promise<T>;
+}
+export interface ApiFunctionRequestObject {
+    /** The payload formation version of the AWS API Gateway. */
+    version: '2.0';
+    /** The path portion of the URL that comes after the Function name. */
+    rawPath: string;
+    /** The unprocessed query string of the incoming HTTP request including the starting question mark. */
+    rawQueryString: string;
+    /**
+     * The headers of the incoming HTTP request.
+     * It is structured as an object, where each key-value pair corresponds to a header name and its value.
+     * */
+    headers: Record<string, string>;
+    requestContext: {
+        http: {
+            /**  The HTTP method used to target the API function. */
+            method: ApiFunctionRequestMethod;
+        };
+    };
+    /** The body of the incoming HTTP request as string. It can be Base64-encoded based on the isBase64Encoded property. */
+    body: string;
+    /** The isBase64Encoded property indicates if the body property of the request object has been Base64-encoded. */
+    isBase64Encoded: boolean;
+}
+export interface ApiFunctionResponseObject {
+    /**
+     * The statusCode field resolves to the status code in the HTTP response.
+     * The value can be in the 200 - 499 range.
+     * */
+    statusCode: number;
+    /**
+     * The headers field resolves to the headers in the HTTP response.
+     * It is structured as an object, where each key-value pair corresponds to a header name and its value.
+     * */
+    headers?: Record<string, string>;
+    /**
+     * The body field resolves to the body in the HTTP response.
+     * In order to include binary data within a body, such as images or audio files, it is necessary to convert it into a Base64 string and assign it to the body field of the response object. Additionally, the isBase64Encoded field must be set to true.
+     * If the response body does not contain binary data, you can directly include the data in its original format.
+     */
+    body?: any;
+    /**
+     * The isBase64Encoded field must be set to true if the body field of the response object is a Base64 encoded string representing the raw response body.
+     * */
+    isBase64Encoded?: boolean;
+}
+export declare enum ApiFunctionRequestMethod {
+    'GET' = "GET",
+    'POST' = "POST",
+    'PUT' = "PUT",
+    'DELETE' = "DELETE",
+    'PATCH' = "PATCH",
+    'OPTIONS' = "OPTIONS",
+    'HEAD' = "HEAD"
+}

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

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

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

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

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

@@ -0,0 +1,25 @@
+import { ObjectId, OptionsWithRql } from '../../../types';
+import { LogLine } from '../../logs/types';
+export interface ApiRequestLogsService {
+    /**
+     * ## Retrieve a list of logs for an API Request
+     *
+     * **Global Permissions:**
+     * - `VIEW_API_FUNCTION_REQUEST_LOGS` - **Required** for this endpoint
+     *
+     * @param apiRequestId {@link string} The id of the targeted API Request
+     * @param options {@link OptionsWithRql} - Additional options for the request
+     * @returns An array of API Request logs {@link LogLine LineLog[]}
+     */
+    find(apiRequestId: ObjectId, options?: OptionsWithRql): Promise<LogLine[]>;
+    /**
+     * ## Retrieve the first queried API Request log
+     *
+     * **Global Permissions:**
+     * - `VIEW_API_FUNCTION_REQUEST_LOGS` - **Required** for this endpoint
+     *
+     * @param apiRequestId {@link string} The id of the targeted API Request
+     * @param options {@link OptionsWithRql} - Additional options for the request
+     * @returns The first element of the queried API Request logs {@link LogLine}     */
+    findFirst(apiRequestId: ObjectId, options?: OptionsWithRql): Promise<LogLine | undefined>;
+}

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

@@ -0,0 +1,83 @@
+import { FindAllIterator } from '../../helpers';
+import { ObjectId, OptionsWithRql, PagedResultWithPager } from '../../types';
+import { ApiFunctionRequestMethod } from '../api/types';
+import { ApiRequestLogsService } from './logs/types';
+export interface ApiRequestService {
+    /**
+     * ## Retrieve a paged list of API Requests
+     *
+     * **Global Permissions:**
+     * - `VIEW_API_FUNCTION_REQUESTS` - Allows a user to view API Requests
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns A paged list of API Requests {@link PagedResultWithPager PagedResultWithPager<ApiRequest>}
+     */
+    find(options?: OptionsWithRql): Promise<PagedResultWithPager<ApiRequest>>;
+    /**
+     * ## Retrieve a list of all API Requests
+     *
+     * **Global Permissions:**
+     * - `VIEW_API_FUNCTION_REQUESTS` - Allows a user to view API Requests
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An array of API Requests {@link ApiRequest ApiRequest[]}
+     * @throws {@link Error} Do not pass in limit operator with findAll
+     */
+    findAll(options?: OptionsWithRql): Promise<ApiRequest[]>;
+    /**
+     * ## Retrieve a paged list of API Requests
+     *
+     * **Global Permissions:**
+     * - `VIEW_API_FUNCTION_REQUESTS` - Allows a user to view API Requests
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An iterator for the queried API Requests {@link FindAllIterator FindAllIterator<ApiRequest>}
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<ApiRequest>;
+    /**
+     * ## Retrieve the first queried API Request
+     *
+     * **Global Permissions:**
+     * - `VIEW_API_FUNCTION_REQUESTS` - Allows a user to view API Requests
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns The first element of the queried API Requests {@link ApiRequest}
+     */
+    findFirst(options?: OptionsWithRql): Promise<ApiRequest | undefined>;
+    logs: ApiRequestLogsService;
+}
+export interface ApiRequest {
+    /** The Extra Horizon document id */
+    id: ObjectId;
+    /** The unique identifier amongst all Functions */
+    functionName: string;
+    /**  The HTTP method used to target the API function. */
+    method: ApiFunctionRequestMethod;
+    /** The path portion of the URL that comes after the Function name. */
+    path: string;
+    /** The id of the user making the request */
+    userId?: ObjectId;
+    /** The application id of the oAuth application */
+    applicationId?: ObjectId;
+    /** The status code of the API Function's response or of a thrown error during its lifecycle */
+    statusCode: number;
+    /** The time the API Function was executed */
+    timestamp: Date;
+    /** The duration of the API Function execution in seconds */
+    duration: number;
+    /** An error thrown during the lifecycle of the API Function's execution  */
+    error?: ApiRequestError;
+}
+export interface ApiRequestError {
+    /** The name of the caught error */
+    name: string;
+    /** The message of the caught error */
+    message: string;
+    /** The error type defines where the error occurred during the API Function lifecycle and can have one of the following values:
+     * - `invocation` - errors that occur before invocation of the API Function
+     * - `runtime` - errors that occur during the execution of the API Function
+     * - `response` - errors that occur during the response validation after the API Function has been executed
+     */
+    type: ApiRequestErrorType;
+}
+export declare enum ApiRequestErrorType {
+    INVOCATION = "invocation",
+    RUNTIME = "runtime",
+    RESPONSE = "response"
+}