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

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

@@ -1,5 +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;
+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/types/services/tasks/api/types.d.ts

@@ -1,146 +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"
-}
+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/types/services/tasks/apiRequests/index.d.ts

@@ -1,5 +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;
+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/types/services/tasks/apiRequests/logs/index.d.ts

@@ -1,5 +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;
+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/types/services/tasks/apiRequests/logs/types.d.ts

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

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

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

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

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

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

@@ -1,27 +1,27 @@
-import { OptionsBase } from '../../types';
-import { Task } from '../types';
-export interface FunctionsService {
-    /**
-     * ## Execute a Function directly
-     *
-     * A Function may be executed directly, the function will be executed synchronously and the response may be awaited by the caller.
-     *
-     * **Default Permissions:**
-     * - Any party may execute Functions with the `public` permission mode
-     * - Any authenticated user may execute Functions with the `allUsers` permission mode
-     *
-     * **Global Permissions:**
-     * - `EXECUTE_TASK_FUNCTION` - A user may execute all Functions
-     * - `EXECUTE_TASK_FUNCTION:{FUNCTION_NAME}` - A user may execute the Function specified by the FUNCTION_NAME
-     *
-     * @param functionName {@link string} - The functionName property serves as the unique identifier amongst all Functions
-     * @param data {@link U} - The data to be sent to the Function, the type may be specified by the user
-     * @param options {@link OptionsBase} - Additional options for the request
-     * @returns {@link DirectExecutionResponse} - The response returned from the Function, the response data and results may be user defined
-     */
-    execute<T = any, U = any>(functionName: string, data?: U, options?: OptionsBase): Promise<DirectExecutionResponse<T, U>>;
-}
-export interface DirectExecutionResponse<T, U> extends Task<U> {
-    /** The result of the Function execution, this may be user defined */
-    result: T;
-}
+import { OptionsBase } from '../../types';
+import { Task } from '../types';
+export interface FunctionsService {
+    /**
+     * ## Execute a Function directly
+     *
+     * A Function may be executed directly, the function will be executed synchronously and the response may be awaited by the caller.
+     *
+     * **Default Permissions:**
+     * - Any party may execute Functions with the `public` permission mode
+     * - Any authenticated user may execute Functions with the `allUsers` permission mode
+     *
+     * **Global Permissions:**
+     * - `EXECUTE_TASK_FUNCTION` - A user may execute all Functions
+     * - `EXECUTE_TASK_FUNCTION:{FUNCTION_NAME}` - A user may execute the Function specified by the FUNCTION_NAME
+     *
+     * @param functionName {@link string} - The functionName property serves as the unique identifier amongst all Functions
+     * @param data {@link U} - The data to be sent to the Function, the type may be specified by the user
+     * @param options {@link OptionsBase} - Additional options for the request
+     * @returns {@link DirectExecutionResponse} - The response returned from the Function, the response data and results may be user defined
+     */
+    execute<T = any, U = any>(functionName: string, data?: U, options?: OptionsBase): Promise<DirectExecutionResponse<T, U>>;
+}
+export interface DirectExecutionResponse<T, U> extends Task<U> {
+    /** The result of the Function execution, this may be user defined */
+    result: T;
+}