@credoxa/events-sdk 1.0.0

package/dist/esm/runtime.js

@@ -0,0 +1,352 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Credoxa Events API
+ * Enterprise multi-tenant event infrastructure for Credoxa Cloud.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export const BASE_PATH = "".replace(/\/+$/, "");
+export class Configuration {
+    constructor(configuration = {}) {
+        this.configuration = configuration;
+    }
+    set config(configuration) {
+        this.configuration = configuration;
+    }
+    get basePath() {
+        return this.configuration.basePath != null ? this.configuration.basePath : BASE_PATH;
+    }
+    get fetchApi() {
+        return this.configuration.fetchApi;
+    }
+    get middleware() {
+        return this.configuration.middleware || [];
+    }
+    get queryParamsStringify() {
+        return this.configuration.queryParamsStringify || querystring;
+    }
+    get username() {
+        return this.configuration.username;
+    }
+    get password() {
+        return this.configuration.password;
+    }
+    get apiKey() {
+        const apiKey = this.configuration.apiKey;
+        if (apiKey) {
+            return typeof apiKey === 'function' ? apiKey : () => apiKey;
+        }
+        return undefined;
+    }
+    get accessToken() {
+        const accessToken = this.configuration.accessToken;
+        if (accessToken) {
+            return typeof accessToken === 'function' ? accessToken : () => __awaiter(this, void 0, void 0, function* () { return accessToken; });
+        }
+        return undefined;
+    }
+    get headers() {
+        return this.configuration.headers;
+    }
+    get credentials() {
+        return this.configuration.credentials;
+    }
+}
+export const DefaultConfig = new Configuration();
+/**
+ * This is the base class for all generated API classes.
+ */
+export class BaseAPI {
+    constructor(configuration = DefaultConfig) {
+        this.configuration = configuration;
+        this.fetchApi = (url, init) => __awaiter(this, void 0, void 0, function* () {
+            let fetchParams = { url, init };
+            for (const middleware of this.middleware) {
+                if (middleware.pre) {
+                    fetchParams = (yield middleware.pre(Object.assign({ fetch: this.fetchApi }, fetchParams))) || fetchParams;
+                }
+            }
+            let response = undefined;
+            try {
+                response = yield (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+            }
+            catch (e) {
+                for (const middleware of this.middleware) {
+                    if (middleware.onError) {
+                        response = (yield middleware.onError({
+                            fetch: this.fetchApi,
+                            url: fetchParams.url,
+                            init: fetchParams.init,
+                            error: e,
+                            response: response ? response.clone() : undefined,
+                        })) || response;
+                    }
+                }
+                if (response === undefined) {
+                    if (e instanceof Error) {
+                        throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
+                    }
+                    else {
+                        throw e;
+                    }
+                }
+            }
+            for (const middleware of this.middleware) {
+                if (middleware.post) {
+                    response = (yield middleware.post({
+                        fetch: this.fetchApi,
+                        url: fetchParams.url,
+                        init: fetchParams.init,
+                        response: response.clone(),
+                    })) || response;
+                }
+            }
+            return response;
+        });
+        this.middleware = configuration.middleware;
+    }
+    withMiddleware(...middlewares) {
+        const next = this.clone();
+        next.middleware = next.middleware.concat(...middlewares);
+        return next;
+    }
+    withPreMiddleware(...preMiddlewares) {
+        const middlewares = preMiddlewares.map((pre) => ({ pre }));
+        return this.withMiddleware(...middlewares);
+    }
+    withPostMiddleware(...postMiddlewares) {
+        const middlewares = postMiddlewares.map((post) => ({ post }));
+        return this.withMiddleware(...middlewares);
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        if (!mime) {
+            return false;
+        }
+        return BaseAPI.jsonRegex.test(mime);
+    }
+    request(context, initOverrides, errorDecoders) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { url, init } = yield this.createFetchParams(context, initOverrides);
+            const response = yield this.fetchApi(url, init);
+            if (response && (response.status >= 200 && response.status < 300)) {
+                return response;
+            }
+            const errorDecoder = response
+                ? errorDecoders === null || errorDecoders === void 0 ? void 0 : errorDecoders[response.status]
+                : undefined;
+            if (response && errorDecoder) {
+                try {
+                    const jsonValue = yield response.clone().json();
+                    const data = errorDecoder(jsonValue);
+                    throw new ResponseError(response, 'Response returned an error code', data);
+                }
+                catch (decodeError) {
+                    if (decodeError instanceof ResponseError) {
+                        throw decodeError;
+                    }
+                    throw new ResponseError(response, 'Response returned an error code', undefined, decodeError);
+                }
+            }
+            throw new ResponseError(response, 'Response returned an error code');
+        });
+    }
+    createFetchParams(context, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = this.configuration.basePath + context.path;
+            if (context.query !== undefined && Object.keys(context.query).length !== 0) {
+                // only add the querystring to the URL if there are query parameters.
+                // this is done to avoid urls ending with a "?" character which buggy webservers
+                // do not handle correctly sometimes.
+                url += '?' + this.configuration.queryParamsStringify(context.query);
+            }
+            const headers = Object.assign({}, this.configuration.headers, context.headers);
+            Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
+            const initOverrideFn = typeof initOverrides === "function"
+                ? initOverrides
+                : () => __awaiter(this, void 0, void 0, function* () { return initOverrides; });
+            const initParams = {
+                method: context.method,
+                headers,
+                body: context.body,
+                credentials: this.configuration.credentials,
+            };
+            const overriddenInit = Object.assign(Object.assign({}, initParams), (yield initOverrideFn({
+                init: initParams,
+                context,
+            })));
+            let body;
+            if (isFormData(overriddenInit.body)
+                || (overriddenInit.body instanceof URLSearchParams)
+                || isBlob(overriddenInit.body)) {
+                body = overriddenInit.body;
+            }
+            else if (this.isJsonMime(headers['Content-Type'])) {
+                body = JSON.stringify(overriddenInit.body);
+            }
+            else {
+                body = overriddenInit.body;
+            }
+            const init = Object.assign(Object.assign({}, overriddenInit), { body });
+            return { url, init };
+        });
+    }
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    clone() {
+        const constructor = this.constructor;
+        const next = new constructor(this.configuration);
+        next.middleware = this.middleware.slice();
+        return next;
+    }
+}
+BaseAPI.jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
+;
+function isBlob(value) {
+    return typeof Blob !== 'undefined' && value instanceof Blob;
+}
+function isFormData(value) {
+    return typeof FormData !== "undefined" && value instanceof FormData;
+}
+export class ResponseError extends Error {
+    constructor(response, msg, data, decodeError) {
+        super(msg);
+        this.response = response;
+        this.data = data;
+        this.decodeError = decodeError;
+        this.name = "ResponseError";
+    }
+}
+export class FetchError extends Error {
+    constructor(cause, msg) {
+        super(msg);
+        this.cause = cause;
+        this.name = "FetchError";
+    }
+}
+export class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = "RequiredError";
+    }
+}
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+export function querystring(params, prefix = '') {
+    return Object.keys(params)
+        .map(key => querystringSingleKey(key, params[key], prefix))
+        .filter(part => part.length > 0)
+        .join('&');
+}
+function querystringSingleKey(key, value, keyPrefix = '') {
+    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+    if (value instanceof Array) {
+        const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
+            .join(`&${encodeURIComponent(fullKey)}=`);
+        return `${encodeURIComponent(fullKey)}=${multiValue}`;
+    }
+    if (value instanceof Set) {
+        const valueAsArray = Array.from(value);
+        return querystringSingleKey(key, valueAsArray, keyPrefix);
+    }
+    if (value instanceof Date) {
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+    }
+    if (value instanceof Object) {
+        return querystring(value, fullKey);
+    }
+    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+export function exists(json, key) {
+    const value = json[key];
+    return value !== null && value !== undefined;
+}
+export function mapValues(data, fn) {
+    const result = {};
+    for (const key of Object.keys(data)) {
+        result[key] = fn(data[key]);
+    }
+    return result;
+}
+export function canConsumeForm(consumes) {
+    for (const consume of consumes) {
+        if ('multipart/form-data' === consume.contentType) {
+            return true;
+        }
+    }
+    return false;
+}
+export class JSONApiResponse {
+    constructor(raw, transformer = (jsonValue) => jsonValue) {
+        this.raw = raw;
+        this.transformer = transformer;
+    }
+    value() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.transformer(yield this.raw.json());
+        });
+    }
+}
+export class VoidApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    value() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return undefined;
+        });
+    }
+}
+export class BlobApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    value() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.raw.blob();
+        });
+    }
+    ;
+}
+export class TextApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    value() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.raw.text();
+        });
+    }
+    ;
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './runtime.js';
+export * from './apis/index.js';
+export * from './models/index.js';

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./runtime.js"), exports);
+__exportStar(require("./apis/index.js"), exports);
+__exportStar(require("./models/index.js"), exports);

package/dist/models/AlertTypeEnum.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Credoxa Events API
+ * Enterprise multi-tenant event infrastructure for Credoxa Cloud.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * * `compliance` - Compliance
+ * * `slo_breach` - SLO breach
+ * * `dead_letter` - Dead letter
+ * * `legal_hold` - Legal hold
+ * * `archive_backlog` - Archive backlog
+ * * `purge_backlog` - Purge backlog
+ * * `evidence_gap` - Evidence gap
+ * @export
+ */
+export declare const AlertTypeEnum: {
+    readonly Compliance: "compliance";
+    readonly SloBreach: "slo_breach";
+    readonly DeadLetter: "dead_letter";
+    readonly LegalHold: "legal_hold";
+    readonly ArchiveBacklog: "archive_backlog";
+    readonly PurgeBacklog: "purge_backlog";
+    readonly EvidenceGap: "evidence_gap";
+};
+export type AlertTypeEnum = typeof AlertTypeEnum[keyof typeof AlertTypeEnum];
+export declare function instanceOfAlertTypeEnum(value: any): boolean;
+export declare function AlertTypeEnumFromJSON(json: any): AlertTypeEnum;
+export declare function AlertTypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): AlertTypeEnum;
+export declare function AlertTypeEnumToJSON(value?: AlertTypeEnum | null): any;
+export declare function AlertTypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): AlertTypeEnum;

package/dist/models/AlertTypeEnum.js

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Credoxa Events API
+ * Enterprise multi-tenant event infrastructure for Credoxa Cloud.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlertTypeEnum = void 0;
+exports.instanceOfAlertTypeEnum = instanceOfAlertTypeEnum;
+exports.AlertTypeEnumFromJSON = AlertTypeEnumFromJSON;
+exports.AlertTypeEnumFromJSONTyped = AlertTypeEnumFromJSONTyped;
+exports.AlertTypeEnumToJSON = AlertTypeEnumToJSON;
+exports.AlertTypeEnumToJSONTyped = AlertTypeEnumToJSONTyped;
+/**
+ * * `compliance` - Compliance
+ * * `slo_breach` - SLO breach
+ * * `dead_letter` - Dead letter
+ * * `legal_hold` - Legal hold
+ * * `archive_backlog` - Archive backlog
+ * * `purge_backlog` - Purge backlog
+ * * `evidence_gap` - Evidence gap
+ * @export
+ */
+exports.AlertTypeEnum = {
+    Compliance: 'compliance',
+    SloBreach: 'slo_breach',
+    DeadLetter: 'dead_letter',
+    LegalHold: 'legal_hold',
+    ArchiveBacklog: 'archive_backlog',
+    PurgeBacklog: 'purge_backlog',
+    EvidenceGap: 'evidence_gap'
+};
+function instanceOfAlertTypeEnum(value) {
+    for (const key in exports.AlertTypeEnum) {
+        if (Object.prototype.hasOwnProperty.call(exports.AlertTypeEnum, key)) {
+            if (exports.AlertTypeEnum[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function AlertTypeEnumFromJSON(json) {
+    return AlertTypeEnumFromJSONTyped(json, false);
+}
+function AlertTypeEnumFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function AlertTypeEnumToJSON(value) {
+    return value;
+}
+function AlertTypeEnumToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/AnalyticsCheckpointListData.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Credoxa Events API
+ * Enterprise multi-tenant event infrastructure for Credoxa Cloud.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { AnalyticsCheckpointListRecord } from './AnalyticsCheckpointListRecord.js';
+/**
+ *
+ * @export
+ * @interface AnalyticsCheckpointListData
+ */
+export interface AnalyticsCheckpointListData {
+    /**
+     *
+     * @type {Array<AnalyticsCheckpointListRecord>}
+     * @memberof AnalyticsCheckpointListData
+     */
+    results: Array<AnalyticsCheckpointListRecord>;
+    /**
+     *
+     * @type {number}
+     * @memberof AnalyticsCheckpointListData
+     */
+    count: number;
+}
+/**
+ * Check if a given object implements the AnalyticsCheckpointListData interface.
+ */
+export declare function instanceOfAnalyticsCheckpointListData(value: object): value is AnalyticsCheckpointListData;
+export declare function AnalyticsCheckpointListDataFromJSON(json: any): AnalyticsCheckpointListData;
+export declare function AnalyticsCheckpointListDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnalyticsCheckpointListData;
+export declare function AnalyticsCheckpointListDataToJSON(json: any): AnalyticsCheckpointListData;
+export declare function AnalyticsCheckpointListDataToJSONTyped(value?: AnalyticsCheckpointListData | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AnalyticsCheckpointListData.js

@@ -0,0 +1,55 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Credoxa Events API
+ * Enterprise multi-tenant event infrastructure for Credoxa Cloud.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfAnalyticsCheckpointListData = instanceOfAnalyticsCheckpointListData;
+exports.AnalyticsCheckpointListDataFromJSON = AnalyticsCheckpointListDataFromJSON;
+exports.AnalyticsCheckpointListDataFromJSONTyped = AnalyticsCheckpointListDataFromJSONTyped;
+exports.AnalyticsCheckpointListDataToJSON = AnalyticsCheckpointListDataToJSON;
+exports.AnalyticsCheckpointListDataToJSONTyped = AnalyticsCheckpointListDataToJSONTyped;
+const AnalyticsCheckpointListRecord_js_1 = require("./AnalyticsCheckpointListRecord.js");
+/**
+ * Check if a given object implements the AnalyticsCheckpointListData interface.
+ */
+function instanceOfAnalyticsCheckpointListData(value) {
+    if (!('results' in value) || value['results'] === undefined)
+        return false;
+    if (!('count' in value) || value['count'] === undefined)
+        return false;
+    return true;
+}
+function AnalyticsCheckpointListDataFromJSON(json) {
+    return AnalyticsCheckpointListDataFromJSONTyped(json, false);
+}
+function AnalyticsCheckpointListDataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'results': (json['results'].map(AnalyticsCheckpointListRecord_js_1.AnalyticsCheckpointListRecordFromJSON)),
+        'count': json['count'],
+    };
+}
+function AnalyticsCheckpointListDataToJSON(json) {
+    return AnalyticsCheckpointListDataToJSONTyped(json, false);
+}
+function AnalyticsCheckpointListDataToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'results': (value['results'].map(AnalyticsCheckpointListRecord_js_1.AnalyticsCheckpointListRecordToJSON)),
+        'count': value['count'],
+    };
+}

package/dist/models/AnalyticsCheckpointListRecord.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Credoxa Events API
+ * Enterprise multi-tenant event infrastructure for Credoxa Cloud.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface AnalyticsCheckpointListRecord
+ */
+export interface AnalyticsCheckpointListRecord {
+    /**
+     *
+     * @type {string}
+     * @memberof AnalyticsCheckpointListRecord
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AnalyticsCheckpointListRecord
+     */
+    organizationId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AnalyticsCheckpointListRecord
+     */
+    projectionId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof AnalyticsCheckpointListRecord
+     */
+    cursorOccurredAt: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AnalyticsCheckpointListRecord
+     */
+    cursorEventId: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AnalyticsCheckpointListRecord
+     */
+    fencingGeneration: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AnalyticsCheckpointListRecord
+     */
+    revision: number;
+    /**
+     *
+     * @type {string}
+     * @memberof AnalyticsCheckpointListRecord
+     */
+    drift: string;
+}
+/**
+ * Check if a given object implements the AnalyticsCheckpointListRecord interface.
+ */
+export declare function instanceOfAnalyticsCheckpointListRecord(value: object): value is AnalyticsCheckpointListRecord;
+export declare function AnalyticsCheckpointListRecordFromJSON(json: any): AnalyticsCheckpointListRecord;
+export declare function AnalyticsCheckpointListRecordFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnalyticsCheckpointListRecord;
+export declare function AnalyticsCheckpointListRecordToJSON(json: any): AnalyticsCheckpointListRecord;
+export declare function AnalyticsCheckpointListRecordToJSONTyped(value?: AnalyticsCheckpointListRecord | null, ignoreDiscriminator?: boolean): any;