@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/errors/process.d.ts

@@ -1,8 +0,0 @@
-import { InternalServerError } from "./internalServerError";
-import { ILoggerStack } from "./ILoggerStack";
-import { ISuggestedMetaInfo } from "../helper/logger";
-export declare class ProcessError extends InternalServerError {
-    constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
-        [key: string]: any;
-    });
-}

package/build/shared/errors/resourceNotFound.d.ts

@@ -1,43 +0,0 @@
-import { BaseError } from "./baseError";
-import { ILoggerStack } from "./ILoggerStack";
-import { ISuggestedMetaInfo } from "../helper/logger";
-/**
- * @openapi
- * components:
- *   responses:
- *     NotFoundError:
- *       description: The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
- *       content:
- *         application/json:
- *           schema:
- *             type: object
- *             properties:
- *               type:
- *                 type: string
- *                 example: Not Found
- *               title:
- *                 type: string
- *                 example: Not Found Error
- *               status:
- *                 type: number
- *                 example: 404
- *               detail:
- *                 type: string
- *               instance:
- *                 type: string
- *                 example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432
- *               code:
- *                 type: string
- *                 example: 1000
- *               traceId:
- *                 type: string
- *                 example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f
- *               details:
- *                 type: object
- *                 example: {}
- */
-export declare class ResourceNotFoundError extends BaseError {
-    constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
-        [key: string]: any;
-    });
-}

package/build/shared/errors/smtpConnectError.d.ts

@@ -1,8 +0,0 @@
-import { BadGatewayError } from "./BadGatewayError";
-import { ILoggerStack } from "./ILoggerStack";
-import { ISuggestedMetaInfo } from "../helper/logger";
-export declare class SMTPConnectError extends BadGatewayError {
-    constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
-        [key: string]: any;
-    });
-}

package/build/shared/errors/timeoutError.d.ts

@@ -1,8 +0,0 @@
-import { GatewayTimeoutError } from "./GatewayTimeoutError";
-import { ILoggerStack } from "./ILoggerStack";
-import { ISuggestedMetaInfo } from "../helper/logger";
-export declare class TimeoutError extends GatewayTimeoutError {
-    constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
-        [key: string]: any;
-    });
-}

package/build/shared/helper/BaseContext.d.ts

@@ -1,98 +0,0 @@
-import { IContext } from "../interfaces/ai";
-/**
- * Cognigy Base Context Object
- */
-export declare class BaseContext implements IContext {
-    protected context: any;
-    maxTopicAge: number;
-    protected projectId: string;
-    protected organisationId: string;
-    protected traceId: string;
-    /**
-     * Creates a new instance of a Context object.
-     *
-     * @param {boolean} injectSystemDefault - Flag that describes whether the context
-     * should be initialized with a default structure.
-     * @param {string} organisationId - The id of the organisation.
-     * @memberOf Context
-     */
-    constructor(options: {
-        injectSystemDefault?: boolean;
-        organisationId?: string;
-    }, traceId: string);
-    protected createProxy(initial?: any): any;
-    /**
-     * Imports data into the context. Creates a deep copy of the provided data to
-     * get rid of references.
-     *
-     * @param {any} data - The data which should be imported.
-     * @param {boolean} replace - Optional flag that defines whether the whole object should
-     * be overwritten or whether we should copy individual keys from the 'data' object and
-     * merge them into the current context.
-     * @memberOf Context
-     */
-    importContext(data: any, traceId: string, replace?: boolean): void;
-    /**
-     * Retrieves a context variable.
-     *
-     * @param {string} key - The context variable to retrieve
-     * @returns {any} The part of the context you requested using the provided key.
-     * @memberOf Context
-     */
-    getContext(key: string): any;
-    /**
-     * Retrieves the full context object. Does not create a copy so we return the reference
-     * to the internal 'context' object.
-     *
-     * @returns {any} The complete Context object.
-     * @memberOf Context
-     */
-    getFullContext(): any;
-    /**
-     * Adds a new key/value pair into the context. Will overwrite the 'key' if its
-     * already there.
-     *
-     * @param {string} key - The key for your new key/value pair within the context.
-     * @param {any} value - The new value within the context.
-     * @memberOf Context
-     */
-    setContext(key: string, value: any, traceId: string): void;
-    /**
-     * Wrapper around the static function which actually implements
-     * the logic. We use this wrapper to have the correct 'this' context
-     * bound.
-     */
-    findContextPath(splits: string[], createPath: boolean): {};
-    /**
-     * Returns a specific path into the given 'contextObject' and returns the most
-     * inner object/value you have requested.
-     */
-    static findLocationPathStateless(splits: string[], createPath: boolean, locationObject: any): {};
-    /**
-     * Removes a certain 'key' from the context object.
-     *
-     * @param {string} key - The key that should be removed from the context object.
-     * @memberOf Context
-     */
-    delete(key: string): void;
-    /**
-     * Sets last topics in context, identifies correct gender
-     *
-     * @param object
-     * @param age when was object created
-     */
-    setLastTopic(object: {
-        text: string;
-        type?: {
-            gender?: string;
-        };
-    }, age: number): void;
-    /**
-     * Retrieves the last topic from the context, based on gender
-     *
-     * @param type
-     * @param curAge
-     */
-    getLastTopic(type: string, curAge: number): string;
-    setProjectId(projectId: string): void;
-}

package/build/shared/helper/HttpStatusCode.d.ts

@@ -1,319 +0,0 @@
-/**
- * Hypertext Transfer Protocol (HTTP) response status codes.
- * @see {@link https://en.wikipedia.org/wiki/List_of_HTTP_status_codes}
- */
-export declare enum HttpStatusCode {
-    /**
-     * The server has received the request headers and the client should proceed to send the request body
-     * (in the case of a request for which a body needs to be sent; for example, a POST request).
-     * Sending a large request body to a server after a request has been rejected for inappropriate headers would be inefficient.
-     * To have a server check the request's headers, a client must send Expect: 100-continue as a header in its initial request
-     * and receive a 100 Continue status code in response before sending the body. The response 417 Expectation Failed indicates the request should not be continued.
-     */
-    CONTINUE = 100,
-    /**
-     * The requester has asked the server to switch protocols and the server has agreed to do so.
-     */
-    SWITCHING_PROTOCOLS = 101,
-    /**
-     * A WebDAV request may contain many sub-requests involving file operations, requiring a long time to complete the request.
-     * This code indicates that the server has received and is processing the request, but no response is available yet.
-     * This prevents the client from timing out and assuming the request was lost.
-     */
-    PROCESSING = 102,
-    /**
-     * Standard response for successful HTTP requests.
-     * The actual response will depend on the request method used.
-     * In a GET request, the response will contain an entity corresponding to the requested resource.
-     * In a POST request, the response will contain an entity describing or containing the result of the action.
-     */
-    OK = 200,
-    /**
-     * The request has been fulfilled, resulting in the creation of a new resource.
-     */
-    CREATED = 201,
-    /**
-     * The request has been accepted for processing, but the processing has not been completed.
-     * The request might or might not be eventually acted upon, and may be disallowed when processing occurs.
-     */
-    ACCEPTED = 202,
-    /**
-     * SINCE HTTP/1.1
-     * The server is a transforming proxy that received a 200 OK from its origin,
-     * but is returning a modified version of the origin's response.
-     */
-    NON_AUTHORITATIVE_INFORMATION = 203,
-    /**
-     * The server successfully processed the request and is not returning any content.
-     */
-    NO_CONTENT = 204,
-    /**
-     * The server successfully processed the request, but is not returning any content.
-     * Unlike a 204 response, this response requires that the requester reset the document view.
-     */
-    RESET_CONTENT = 205,
-    /**
-     * The server is delivering only part of the resource (byte serving) due to a range header sent by the client.
-     * The range header is used by HTTP clients to enable resuming of interrupted downloads,
-     * or split a download into multiple simultaneous streams.
-     */
-    PARTIAL_CONTENT = 206,
-    /**
-     * The message body that follows is an XML message and can contain a number of separate response codes,
-     * depending on how many sub-requests were made.
-     */
-    MULTI_STATUS = 207,
-    /**
-     * The members of a DAV binding have already been enumerated in a preceding part of the (multistatus) response,
-     * and are not being included again.
-     */
-    ALREADY_REPORTED = 208,
-    /**
-     * The server has fulfilled a request for the resource,
-     * and the response is a representation of the result of one or more instance-manipulations applied to the current instance.
-     */
-    IM_USED = 226,
-    /**
-     * Indicates multiple options for the resource from which the client may choose (via agent-driven content negotiation).
-     * For example, this code could be used to present multiple video format options,
-     * to list files with different filename extensions, or to suggest word-sense disambiguation.
-     */
-    MULTIPLE_CHOICES = 300,
-    /**
-     * This and all future requests should be directed to the given URI.
-     */
-    MOVED_PERMANENTLY = 301,
-    /**
-     * This is an example of industry practice contradicting the standard.
-     * The HTTP/1.0 specification (RFC 1945) required the client to perform a temporary redirect
-     * (the original describing phrase was "Moved Temporarily"), but popular browsers implemented 302
-     * with the functionality of a 303 See Other. Therefore, HTTP/1.1 added status codes 303 and 307
-     * to distinguish between the two behaviours. However, some Web applications and frameworks
-     * use the 302 status code as if it were the 303.
-     */
-    FOUND = 302,
-    /**
-     * SINCE HTTP/1.1
-     * The response to the request can be found under another URI using a GET method.
-     * When received in response to a POST (or PUT/DELETE), the client should presume that
-     * the server has received the data and should issue a redirect with a separate GET message.
-     */
-    SEE_OTHER = 303,
-    /**
-     * Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match.
-     * In such case, there is no need to retransmit the resource since the client still has a previously-downloaded copy.
-     */
-    NOT_MODIFIED = 304,
-    /**
-     * SINCE HTTP/1.1
-     * The requested resource is available only through a proxy, the address for which is provided in the response.
-     * Many HTTP clients (such as Mozilla and Internet Explorer) do not correctly handle responses with this status code, primarily for security reasons.
-     */
-    USE_PROXY = 305,
-    /**
-     * No longer used. Originally meant "Subsequent requests should use the specified proxy."
-     */
-    SWITCH_PROXY = 306,
-    /**
-     * SINCE HTTP/1.1
-     * In this case, the request should be repeated with another URI; however, future requests should still use the original URI.
-     * In contrast to how 302 was historically implemented, the request method is not allowed to be changed when reissuing the original request.
-     * For example, a POST request should be repeated using another POST request.
-     */
-    TEMPORARY_REDIRECT = 307,
-    /**
-     * The request and all future requests should be repeated using another URI.
-     * 307 and 308 parallel the behaviors of 302 and 301, but do not allow the HTTP method to change.
-     * So, for example, submitting a form to a permanently redirected resource may continue smoothly.
-     */
-    PERMANENT_REDIRECT = 308,
-    /**
-     * The server cannot or will not process the request due to an apparent client error
-     * (e.g., malformed request syntax, too large size, invalid request message framing, or deceptive request routing).
-     */
-    BAD_REQUEST = 400,
-    /**
-     * Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet
-     * been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the
-     * requested resource. See Basic access authentication and Digest access authentication. 401 semantically means
-     * "unauthenticated",i.e. the user does not have the necessary credentials.
-     */
-    UNAUTHORIZED = 401,
-    /**
-     * Reserved for future use. The original intention was that this code might be used as part of some form of digital
-     * cash or micro payment scheme, but that has not happened, and this code is not usually used.
-     * Google Developers API uses this status if a particular developer has exceeded the daily limit on requests.
-     */
-    PAYMENT_REQUIRED = 402,
-    /**
-     * The request was valid, but the server is refusing action.
-     * The user might not have the necessary permissions for a resource.
-     */
-    FORBIDDEN = 403,
-    /**
-     * The requested resource could not be found but may be available in the future.
-     * Subsequent requests by the client are permissible.
-     */
-    NOT_FOUND = 404,
-    /**
-     * A request method is not supported for the requested resource;
-     * for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
-     */
-    METHOD_NOT_ALLOWED = 405,
-    /**
-     * The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.
-     */
-    NOT_ACCEPTABLE = 406,
-    /**
-     * The client must first authenticate itself with the proxy.
-     */
-    PROXY_AUTHENTICATION_REQUIRED = 407,
-    /**
-     * The server timed out waiting for the request.
-     * According to HTTP specifications:
-     * "The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time."
-     */
-    REQUEST_TIMEOUT = 408,
-    /**
-     * Indicates that the request could not be processed because of conflict in the request,
-     * such as an edit conflict between multiple simultaneous updates.
-     */
-    CONFLICT = 409,
-    /**
-     * Indicates that the resource requested is no longer available and will not be available again.
-     * This should be used when a resource has been intentionally removed and the resource should be purged.
-     * Upon receiving a 410 status code, the client should not request the resource in the future.
-     * Clients such as search engines should remove the resource from their indices.
-     * Most use cases do not require clients and search engines to purge the resource, and a "404 Not Found" may be used instead.
-     */
-    GONE = 410,
-    /**
-     * The request did not specify the length of its content, which is required by the requested resource.
-     */
-    LENGTH_REQUIRED = 411,
-    /**
-     * The server does not meet one of the preconditions that the requester put on the request.
-     */
-    PRECONDITION_FAILED = 412,
-    /**
-     * The request is larger than the server is willing or able to process. Previously called "Request Entity Too Large".
-     */
-    PAYLOAD_TOO_LARGE = 413,
-    /**
-     * The URI provided was too long for the server to process. Often the result of too much data being encoded as a query-string of a GET request,
-     * in which case it should be converted to a POST request.
-     * Called "Request-URI Too Long" previously.
-     */
-    URI_TOO_LONG = 414,
-    /**
-     * The request entity has a media type which the server or resource does not support.
-     * For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.
-     */
-    UNSUPPORTED_MEDIA_TYPE = 415,
-    /**
-     * The client has asked for a portion of the file (byte serving), but the server cannot supply that portion.
-     * For example, if the client asked for a part of the file that lies beyond the end of the file.
-     * Called "Requested Range Not Satisfiable" previously.
-     */
-    RANGE_NOT_SATISFIABLE = 416,
-    /**
-     * The server cannot meet the requirements of the Expect request-header field.
-     */
-    EXPECTATION_FAILED = 417,
-    /**
-     * This code was defined in 1998 as one of the traditional IETF April Fools' jokes, in RFC 2324, Hyper Text Coffee Pot Control Protocol,
-     * and is not expected to be implemented by actual HTTP servers. The RFC specifies this code should be returned by
-     * teapots requested to brew coffee. This HTTP status is used as an Easter egg in some websites, including Google.com.
-     */
-    I_AM_A_TEAPOT = 418,
-    /**
-     * The request was directed at a server that is not able to produce a response (for example because a connection reuse).
-     */
-    MISDIRECTED_REQUEST = 421,
-    /**
-     * The request was well-formed but was unable to be followed due to semantic errors.
-     */
-    UNPROCESSABLE_ENTITY = 422,
-    /**
-     * The resource that is being accessed is locked.
-     */
-    LOCKED = 423,
-    /**
-     * The request failed due to failure of a previous request (e.g., a PROPPATCH).
-     */
-    FAILED_DEPENDENCY = 424,
-    /**
-     * The client should switch to a different protocol such as TLS/1.0, given in the Upgrade header field.
-     */
-    UPGRADE_REQUIRED = 426,
-    /**
-     * The origin server requires the request to be conditional.
-     * Intended to prevent "the 'lost update' problem, where a client
-     * GETs a resource's state, modifies it, and PUTs it back to the server,
-     * when meanwhile a third party has modified the state on the server, leading to a conflict."
-     */
-    PRECONDITION_REQUIRED = 428,
-    /**
-     * The user has sent too many requests in a given amount of time. Intended for use with rate-limiting schemes.
-     */
-    TOO_MANY_REQUESTS = 429,
-    /**
-     * The server is unwilling to process the request because either an individual header field,
-     * or all the header fields collectively, are too large.
-     */
-    REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
-    /**
-     * A server operator has received a legal demand to deny access to a resource or to a set of resources
-     * that includes the requested resource. The code 451 was chosen as a reference to the novel Fahrenheit 451.
-     */
-    UNAVAILABLE_FOR_LEGAL_REASONS = 451,
-    /**
-     * A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.
-     */
-    INTERNAL_SERVER_ERROR = 500,
-    /**
-     * The server either does not recognize the request method, or it lacks the ability to fulfill the request.
-     * Usually this implies future availability (e.g., a new feature of a web-service API).
-     */
-    NOT_IMPLEMENTED = 501,
-    /**
-     * The server was acting as a gateway or proxy and received an invalid response from the upstream server.
-     */
-    BAD_GATEWAY = 502,
-    /**
-     * The server is currently unavailable (because it is overloaded or down for maintenance).
-     * Generally, this is a temporary state.
-     */
-    SERVICE_UNAVAILABLE = 503,
-    /**
-     * The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
-     */
-    GATEWAY_TIMEOUT = 504,
-    /**
-     * The server does not support the HTTP protocol version used in the request
-     */
-    HTTP_VERSION_NOT_SUPPORTED = 505,
-    /**
-     * Transparent content negotiation for the request results in a circular reference.
-     */
-    VARIANT_ALSO_NEGOTIATES = 506,
-    /**
-     * The server is unable to store the representation needed to complete the request.
-     */
-    INSUFFICIENT_STORAGE = 507,
-    /**
-     * The server detected an infinite loop while processing the request.
-     */
-    LOOP_DETECTED = 508,
-    /**
-     * Further extensions to the request are required for the server to fulfill it.
-     */
-    NOT_EXTENDED = 510,
-    /**
-     * The client needs to authenticate to gain network access.
-     * Intended for use by intercepting proxies used to control access to the network (e.g., "captive portals" used
-     * to require agreement to Terms of Service before granting full Internet access via a Wi-Fi hotspot).
-     */
-    NETWORK_AUTHENTICATION_REQUIRED = 511
-}
-export default HttpStatusCode;

package/build/shared/helper/createQuerySchema.d.ts

@@ -1 +0,0 @@
-export declare const createQuerySchema: Function;

package/build/shared/helper/logger/ILogEntry.d.ts

@@ -1,18 +0,0 @@
-import { IJSONSchema } from "../../json-schema";
-import { TReferenceAndEntityMetaKeys } from "../../interfaces/amqpInterface";
-import { TLogLevel } from "./TLogLevel";
-import { TMongoId } from "../../interfaces/types/TMongoId";
-import { ILoggerStack } from "../../errors/ILoggerStack";
-export interface ILogEntry extends Required<ILoggerStack> {
-    _id?: TMongoId;
-    timestamp: Date;
-    msg: string;
-    type: TLogLevel;
-    meta?: {
-        [key: string]: any;
-    };
-    projectReference: TMongoId;
-    organisationReference: TMongoId;
-}
-export declare const logEntryDataSchema: IJSONSchema<Omit<ILogEntry, TReferenceAndEntityMetaKeys>>;
-export declare const logEntrySchema: IJSONSchema<ILogEntry>;

package/build/shared/helper/logger/ISuggestedMetaInfo.d.ts

@@ -1,12 +0,0 @@
-export interface ISuggestedMetaInfo {
-    organisationId?: string;
-    userId?: string;
-    projectId?: string;
-    flowId?: string;
-    /** Name of the file */
-    module?: string;
-    /** Name of the function */
-    function?: string;
-    /** For other keys */
-    [key: string]: any;
-}

package/build/shared/helper/logger/TLogLevel.d.ts

@@ -1,2 +0,0 @@
-export declare const logLevels: readonly ["fatal", "error", "warn", "info", "debug", "trace"];
-export declare type TLogLevel = typeof logLevels[number];

package/build/shared/helper/logger/index.d.ts

@@ -1,8 +0,0 @@
-export interface ISuggestedMetaInfo {
-}
-declare let logger: Partial<Console>;
-export declare const setLogger: (parmLogger: Console) => void;
-export { ILogEntry } from "./ILogEntry";
-export { TLogLevel, logLevels } from "./TLogLevel";
-export { logger };
-export default logger;

package/build/shared/helper/objectSizeValidator.d.ts

@@ -1,9 +0,0 @@
-/**
- * Calculates the byte size of an object, aborts when the validation limit is hit
- * @param {Object} object
- * @param {number} limit The limit which the object cannot exceed
- */
-export declare const validateObjectSize: (object: any, limit?: number) => {
-    valid: boolean;
-    bytes: number;
-};

package/build/shared/helper/rest/NumberRange.d.ts

@@ -1,15 +0,0 @@
-export declare class NumberRange {
-    private $gte;
-    private $lte;
-    type: string;
-    constructor(data: {
-        $gte?: number;
-        $lte?: number;
-    });
-    toString(): string;
-    toMongoQuery(): {
-        $gte: number;
-        $lte: number;
-    };
-    static isNumberRange(variable: any): boolean;
-}

package/build/shared/helper/rest/boolean.d.ts

@@ -1 +0,0 @@
-export declare const parseBoolean: (value: string) => boolean;

package/build/shared/helper/rest/index.d.ts

@@ -1,7 +0,0 @@
-export { parseSort, stringifySort, } from "./sort";
-export { parseLimit, } from "./limit";
-export { parseSkip, } from "./skip";
-export { parseQuery, stringifyQuery, } from "./query";
-export { validateBatchOperations, } from "./operations";
-export { NumberRange, } from "./NumberRange";
-export { parseBoolean, } from "./boolean";

package/build/shared/helper/rest/limit.d.ts

@@ -1 +0,0 @@
-export declare const parseLimit: (limit: string) => number;

package/build/shared/helper/rest/operations.d.ts

@@ -1,2 +0,0 @@
-import { ILoggerStack } from "../../errors";
-export declare const validateBatchOperations: (operations: any, loggerStack: ILoggerStack, maxAmountOfOperationsPerBatchCall?: number) => void;

package/build/shared/helper/rest/query.d.ts

@@ -1,7 +0,0 @@
-import { IJSONSchema } from "../../json-schema";
-import { IFilterQuery, TNonQueriableKeys } from "../../interfaces/amqpInterface";
-import { IRestFilterQuery } from "../../mongoose/pagination";
-export declare function parseQuery<T, U>(query: IRestFilterQuery<Omit<T, TNonQueriableKeys<T>>>, entitySchema: IJSONSchema<Partial<U>>): IFilterQuery<Omit<T, TNonQueriableKeys<T>>>;
-export declare const stringifyQuery: (args: any, params?: {
-    [key: string]: any;
-}, path?: string[]) => string;

package/build/shared/helper/rest/skip.d.ts

@@ -1 +0,0 @@
-export declare const parseSkip: (skip: string) => number;

package/build/shared/helper/rest/sort.d.ts

@@ -1,4 +0,0 @@
-export declare const stringifySort: (sort: {
-    [field: string]: "asc" | "desc";
-}) => string;
-export declare const parseSort: (sort: string) => any;