@8ms/helpers 2.0.0 → 2.0.1

package/aws/s3/payload.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod/v4";
+/**
+ * https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-content-structure.html
+ */
+export declare const payloadSchema: z.ZodObject<{
+    Records: z.ZodArray<z.ZodObject<{
+        eventVersion: z.ZodString;
+        eventSource: z.ZodString;
+        awsRegion: z.ZodString;
+        eventTime: z.ZodString;
+        eventName: z.ZodString;
+        userIdentity: z.ZodObject<{
+            principalId: z.ZodString;
+        }, z.core.$strip>;
+        requestParameters: z.ZodObject<{
+            sourceIPAddress: z.ZodString;
+        }, z.core.$strip>;
+        responseElements: z.ZodObject<{
+            "x-amz-request-id": z.ZodString;
+            "x-amz-id-2": z.ZodString;
+        }, z.core.$strip>;
+        s3: z.ZodObject<{
+            s3SchemaVersion: z.ZodString;
+            configurationId: z.ZodString;
+            bucket: z.ZodObject<{
+                name: z.ZodString;
+                ownerIdentity: z.ZodObject<{
+                    principalId: z.ZodString;
+                }, z.core.$strip>;
+                arn: z.ZodString;
+            }, z.core.$strip>;
+            object: z.ZodObject<{
+                key: z.ZodString;
+                size: z.ZodString;
+                eTag: z.ZodString;
+                versionId: z.ZodOptional<z.ZodString>;
+                sequencer: z.ZodString;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PayloadSchemaType = z.infer<typeof payloadSchema>;

package/aws/s3/payload.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.payloadSchema = void 0;
+const v4_1 = require("zod/v4");
+/**
+ * https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-content-structure.html
+ */
+exports.payloadSchema = v4_1.z.object({
+    Records: v4_1.z.object({
+        eventVersion: v4_1.z.string(),
+        eventSource: v4_1.z.string(),
+        awsRegion: v4_1.z.string(),
+        eventTime: v4_1.z.string(),
+        eventName: v4_1.z.string(),
+        userIdentity: v4_1.z.object({
+            principalId: v4_1.z.string(),
+        }),
+        requestParameters: v4_1.z.object({
+            sourceIPAddress: v4_1.z.string(),
+        }),
+        responseElements: v4_1.z.object({
+            "x-amz-request-id": v4_1.z.string(),
+            "x-amz-id-2": v4_1.z.string(),
+        }),
+        s3: v4_1.z.object({
+            s3SchemaVersion: v4_1.z.string(),
+            configurationId: v4_1.z.string(),
+            bucket: v4_1.z.object({
+                name: v4_1.z.string(),
+                ownerIdentity: v4_1.z.object({
+                    principalId: v4_1.z.string(),
+                }),
+                arn: v4_1.z.string(),
+            }),
+            object: v4_1.z.object({
+                key: v4_1.z.string(),
+                size: v4_1.z.string(),
+                eTag: v4_1.z.string(),
+                versionId: v4_1.z.string()
+                    .optional(),
+                sequencer: v4_1.z.string(),
+            })
+        }),
+    })
+        .array(),
+});

package/aws/ses/AwsSesNamespace.d.ts

@@ -0,0 +1,18 @@
+import { BaseNamespace } from "../../_class";
+import { AwsConfig } from "../index";
+import type { SESClient } from "@aws-sdk/client-ses";
+type SendProps = {
+    bcc?: string[];
+    cc?: string[];
+    from?: string;
+    html?: string;
+    subject?: string;
+    to?: string | string[];
+};
+export declare class AwsSesNamespace extends BaseNamespace {
+    client: SESClient | null;
+    config: AwsConfig;
+    ensureInit: () => Promise<void>;
+    send: (props: SendProps) => Promise<any>;
+}
+export {};

package/aws/ses/AwsSesNamespace.js

@@ -0,0 +1,69 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AwsSesNamespace = void 0;
+const _class_1 = require("../../_class");
+class AwsSesNamespace extends _class_1.BaseNamespace {
+    constructor() {
+        super(...arguments);
+        this.client = null;
+        this.ensureInit = async () => {
+            if (!this.client) {
+                try {
+                    const { SESClient } = await Promise.resolve().then(() => __importStar(require("@aws-sdk/client-ses")));
+                    this.client = new SESClient(this.config);
+                }
+                catch (e) {
+                    throw new Error("AWS SES Client not installed");
+                }
+            }
+        };
+        this.send = async (props) => {
+            await this.ensureInit();
+            const { SendEmailCommand } = await Promise.resolve().then(() => __importStar(require("@aws-sdk/client-ses")));
+            let response;
+            // @ts-ignore
+            const command = new SendEmailCommand(props);
+            try {
+                response = await this.client.send(command);
+            }
+            catch (exception) {
+                response = exception;
+            }
+            return response;
+        };
+    }
+}
+exports.AwsSesNamespace = AwsSesNamespace;

package/aws/ses/SimpleEmail.d.ts

@@ -0,0 +1,56 @@
+import { BaseClass } from "../../_class";
+type ConstructorProps = {
+    bcc?: string[];
+    cc?: string[];
+    from?: string;
+    html?: string;
+    subject?: string;
+    to?: string | string[];
+};
+/**
+ * Class to build and send an AWS SES email.
+ */
+export declare class SimpleEmail extends BaseClass {
+    from?: string;
+    to: string[];
+    cc: string[];
+    bcc: string[];
+    html?: string;
+    subject?: string;
+    constructor({ bcc, cc, from, html, subject, to }: ConstructorProps);
+    setFrom: (from: string) => this;
+    setHtml: (html: string) => this;
+    setSubject: (subject: string) => this;
+    pushBcc: (recipient: string | string[]) => this;
+    pushCc: (recipient: string | string[]) => this;
+    pushTo: (recipient: string | string[]) => this;
+    setBcc: (recipient: string | string[]) => this;
+    setCc: (recipient: string | string[]) => this;
+    setTo: (recipient: string | string[]) => this;
+    getEmailParams: () => {
+        Destination: {
+            BccAddresses: string[];
+            CcAddresses: string[];
+            ToAddresses: string[];
+        };
+        Message: {
+            Body: {
+                Html: {
+                    Charset: string;
+                    Data: string;
+                };
+                Text: {
+                    Charset: string;
+                    Data: string;
+                };
+            };
+            Subject: {
+                Charset: string;
+                Data: string;
+            };
+        };
+        Source: string;
+    };
+    private _filterRecipients;
+}
+export {};

package/aws/ses/SimpleEmail.js

@@ -0,0 +1,106 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleEmail = void 0;
+const uniq_1 = __importDefault(require("lodash/uniq"));
+const _class_1 = require("../../_class");
+/**
+ * Class to build and send an AWS SES email.
+ */
+class SimpleEmail extends _class_1.BaseClass {
+    constructor({ bcc, cc, from, html, subject, to }) {
+        super();
+        this.to = [];
+        this.cc = [];
+        this.bcc = [];
+        this.setFrom = (from) => {
+            return this._setValue("from", from);
+        };
+        this.setHtml = (html) => {
+            return this._setValue("html", html);
+        };
+        this.setSubject = (subject) => {
+            return this._setValue("subject", subject);
+        };
+        this.pushBcc = (recipient) => {
+            return this._push("bcc", recipient);
+        };
+        this.pushCc = (recipient) => {
+            return this._push("cc", recipient);
+        };
+        this.pushTo = (recipient) => {
+            return this._push("to", recipient);
+        };
+        this.setBcc = (recipient) => {
+            return this._setArray("bcc", recipient);
+        };
+        this.setCc = (recipient) => {
+            return this._setArray("cc", recipient);
+        };
+        this.setTo = (recipient) => {
+            return this._setArray("to", recipient);
+        };
+        this.getEmailParams = () => {
+            // https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/ses-examples-sending-email.html
+            const params = {
+                Destination: {
+                    BccAddresses: this._filterRecipients("bcc"),
+                    CcAddresses: this._filterRecipients("cc"),
+                    ToAddresses: this._filterRecipients("to"),
+                },
+                Message: {
+                    Body: {
+                        Html: {
+                            Charset: "UTF-8",
+                            Data: this.html,
+                        },
+                        Text: {
+                            Charset: "UTF-8",
+                            Data: this.html,
+                        },
+                    },
+                    Subject: {
+                        Charset: "UTF-8",
+                        Data: this.subject,
+                    },
+                },
+                Source: this.from,
+            };
+            return params;
+        };
+        this._filterRecipients = (field) => {
+            // Remove all undefined and null values
+            let response = this[field].filter(recipient => recipient && null !== recipient);
+            // Clean all the values
+            response = response.map(recipient => recipient.toLowerCase()
+                .trim());
+            // Remove all empty values
+            response = response.filter(recipient => "" !== recipient);
+            // Return only unique values
+            response = (0, uniq_1.default)(response);
+            return response;
+        };
+        if (bcc) {
+            this.setBcc(bcc);
+        }
+        if (cc) {
+            this.setCc(cc);
+        }
+        if (from) {
+            this.setFrom(from);
+        }
+        if (html) {
+            this.setHtml(html);
+        }
+        if (subject) {
+            this.setSubject(subject);
+        }
+        if (to) {
+            this.setTo(to);
+        }
+        return this;
+    }
+}
+exports.SimpleEmail = SimpleEmail;

package/aws/ses/index.d.ts

@@ -0,0 +1,4 @@
+import { AwsSesNamespace } from "./AwsSesNamespace";
+import { AwsConfig } from "../index";
+export declare const awsSesClient: (key?: string, config?: AwsConfig, vaultId?: string, itemId?: string) => Promise<AwsSesNamespace>;
+export { SimpleEmail } from "./SimpleEmail";

package/aws/ses/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleEmail = exports.awsSesClient = void 0;
+const AwsSesNamespace_1 = require("./AwsSesNamespace");
+const index_1 = require("../index");
+const awsSesNamespaces = new Map();
+const awsSesClient = async (key = "default", config, vaultId, itemId) => {
+    if (awsSesNamespaces.has(key)) {
+        return awsSesNamespaces.get(key);
+    }
+    const instanceConfig = await (0, index_1.getConfig)(key, config, vaultId, itemId);
+    const namespace = new AwsSesNamespace_1.AwsSesNamespace(key, instanceConfig);
+    awsSesNamespaces.set(key, namespace);
+    return namespace;
+};
+exports.awsSesClient = awsSesClient;
+var SimpleEmail_1 = require("./SimpleEmail");
+Object.defineProperty(exports, "SimpleEmail", { enumerable: true, get: function () { return SimpleEmail_1.SimpleEmail; } });

package/aws/sqs/AwsSqsNamespace.d.ts

@@ -0,0 +1,34 @@
+import { BaseNamespace } from "../../_class";
+import { AwsConfig } from "../index";
+import type { SQSClient } from "@aws-sdk/client-sqs";
+type SqsEventRecord = {
+    messageId: string;
+    receiptHandle: string;
+    body: any;
+    attributes: object;
+    messageAttributes: object;
+    md5OfMessageAttributes: string;
+    md5OfBody: string;
+    eventSource: string;
+    eventSourceARN: string;
+    awsRegion: string;
+};
+type SqsEvent = {
+    Records: SqsEventRecord[];
+};
+type AddToQueue = {
+    data: any;
+    dedupeId: string;
+    groupId?: string;
+    queueId?: string;
+    queueUrl: string;
+};
+export declare class AwsSqsNamespace extends BaseNamespace {
+    client: SQSClient | null;
+    config: AwsConfig;
+    ensureInit: () => Promise<void>;
+    addToQueue: (props: AddToQueue) => Promise<import("@aws-sdk/client-sqs").SendMessageCommandOutput>;
+    deleteFromQueue: (queueUrl: string, recipientHandle: string) => Promise<import("@aws-sdk/client-sqs").DeleteMessageCommandOutput>;
+    isEventSqs: (event: SqsEvent) => Promise<boolean>;
+}
+export {};

package/aws/sqs/AwsSqsNamespace.js

@@ -0,0 +1,96 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AwsSqsNamespace = void 0;
+const _class_1 = require("../../_class");
+class AwsSqsNamespace extends _class_1.BaseNamespace {
+    constructor() {
+        super(...arguments);
+        this.client = null;
+        this.ensureInit = async () => {
+            if (!this.client) {
+                try {
+                    const { SQSClient } = await Promise.resolve().then(() => __importStar(require("@aws-sdk/client-sqs")));
+                    this.client = new SQSClient(this.config);
+                }
+                catch (e) {
+                    throw new Error("AWS SQS Client not installed");
+                }
+            }
+        };
+        this.addToQueue = async (props) => {
+            await this.ensureInit();
+            const { SendMessageCommand } = await Promise.resolve().then(() => __importStar(require("@aws-sdk/client-sqs")));
+            let params = {
+                MessageBody: JSON.stringify({
+                    queueId: props.queueId,
+                    data: props.data,
+                }),
+                QueueUrl: props.queueUrl,
+            };
+            // Required for FIFO
+            if (undefined !== props?.dedupeId) {
+                params["MessageDeduplicationId"] = props.dedupeId;
+            }
+            // Required for FIFO
+            if (undefined !== props?.groupId) {
+                params["MessageGroupId"] = props.dedupeId;
+            }
+            const sendData = await this.client.send(new SendMessageCommand(params));
+            return sendData;
+        };
+        this.deleteFromQueue = async (queueUrl, recipientHandle) => {
+            await this.ensureInit();
+            const { DeleteMessageCommand } = await Promise.resolve().then(() => __importStar(require("@aws-sdk/client-sqs")));
+            const params = {
+                QueueUrl: queueUrl,
+                ReceiptHandle: recipientHandle,
+            };
+            const sendData = await this.client.send(new DeleteMessageCommand(params));
+            return sendData;
+        };
+        this.isEventSqs = async (event) => {
+            await this.ensureInit();
+            let response = false;
+            if (undefined !== event["Records"]) {
+                for (let i = 0; i < event['Records'].length; i++) {
+                    // todo: Complete
+                }
+            }
+            return response;
+        };
+    }
+}
+exports.AwsSqsNamespace = AwsSqsNamespace;

package/aws/sqs/index.d.ts

@@ -0,0 +1,3 @@
+import { AwsSqsNamespace } from "./AwsSqsNamespace";
+import { AwsConfig } from "../index";
+export declare const awsSqsClient: (key?: string, config?: AwsConfig, vaultId?: string, itemId?: string) => Promise<AwsSqsNamespace>;

package/aws/sqs/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.awsSqsClient = void 0;
+const AwsSqsNamespace_1 = require("./AwsSqsNamespace");
+const index_1 = require("../index");
+const awsSqsNamespaces = new Map();
+const awsSqsClient = async (key = "default", config, vaultId, itemId) => {
+    if (awsSqsNamespaces.has(key)) {
+        return awsSqsNamespaces.get(key);
+    }
+    const instanceConfig = await (0, index_1.getConfig)(key, config, vaultId, itemId);
+    const namespace = new AwsSqsNamespace_1.AwsSqsNamespace(key, instanceConfig);
+    awsSqsNamespaces.set(key, namespace);
+    return namespace;
+};
+exports.awsSqsClient = awsSqsClient;

package/aws/ssm/AwsSsmNamespace.d.ts

@@ -0,0 +1,11 @@
+import { BaseNamespace } from "../../_class";
+import { AwsConfig } from "../index";
+import type { SSMClient } from "@aws-sdk/client-ssm";
+export declare class AwsSsmNamespace extends BaseNamespace {
+    client: SSMClient | null;
+    config: AwsConfig;
+    parameters: Map<string, any>;
+    constructor(key: string, config: any);
+    ensureInit: () => Promise<void>;
+    getParameter: (name: string, withDecryption?: boolean, isJson?: boolean) => Promise<any>;
+}

package/aws/ssm/AwsSsmNamespace.js

@@ -0,0 +1,89 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AwsSsmNamespace = void 0;
+const _class_1 = require("../../_class");
+class AwsSsmNamespace extends _class_1.BaseNamespace {
+    constructor(key, config) {
+        super(key, config);
+        this.client = null;
+        this.ensureInit = async () => {
+            if (!this.client) {
+                try {
+                    const { SSMClient } = await Promise.resolve().then(() => __importStar(require("@aws-sdk/client-ssm")));
+                    this.client = new SSMClient(this.config);
+                }
+                catch (e) {
+                    throw new Error("AWS SSM Client not installed");
+                }
+            }
+        };
+        this.getParameter = async (name, withDecryption = false, isJson = true) => {
+            await this.ensureInit();
+            if (!this.parameters.has(name)) {
+                const { GetParameterCommand } = await Promise.resolve().then(() => __importStar(require("@aws-sdk/client-ssm")));
+                const apiResponse = await this.client.send(new GetParameterCommand({
+                    Name: name,
+                    WithDecryption: undefined === withDecryption ? true : withDecryption,
+                }));
+                if (apiResponse.Parameter.Value) {
+                    // Value is undefined
+                    if (undefined === apiResponse.Parameter.Value) {
+                        this.parameters.set(name, null);
+                    }
+                    // Value is defined
+                    else {
+                        // isJson is default - decode
+                        if (undefined === isJson || true === isJson) {
+                            this.parameters.set(name, JSON.parse(apiResponse.Parameter.Value) || null);
+                        }
+                        // Not JSON don't decode
+                        else {
+                            this.parameters.set(name, apiResponse.Parameter.Value);
+                        }
+                    }
+                }
+                // Value not found (null so it can be sent from server to front end)
+                else {
+                    this.parameters.set(name, null);
+                }
+            }
+            // Return the loaded result
+            return this.parameters.get(name);
+        };
+        this.parameters = new Map();
+    }
+}
+exports.AwsSsmNamespace = AwsSsmNamespace;

package/aws/ssm/index.d.ts

@@ -0,0 +1,3 @@
+import { AwsSsmNamespace } from "./AwsSsmNamespace";
+import { AwsConfig } from "../index";
+export declare const awsSsmClient: (key?: string, config?: AwsConfig, vaultId?: string, itemId?: string) => Promise<AwsSsmNamespace>;

package/aws/ssm/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.awsSsmClient = void 0;
+const AwsSsmNamespace_1 = require("./AwsSsmNamespace");
+const index_1 = require("../index");
+const awsSsmNamespaces = new Map();
+const awsSsmClient = async (key = "default", config, vaultId, itemId) => {
+    if (awsSsmNamespaces.has(key)) {
+        return awsSsmNamespaces.get(key);
+    }
+    const instanceConfig = await (0, index_1.getConfig)(key, config, vaultId, itemId);
+    const namespace = new AwsSsmNamespace_1.AwsSsmNamespace(key, instanceConfig);
+    awsSsmNamespaces.set(key, namespace);
+    return namespace;
+};
+exports.awsSsmClient = awsSsmClient;

package/axios/deleteRequest.d.ts

@@ -0,0 +1,6 @@
+import { ApiResponseClass } from "../api";
+/**
+ * Make a DELETE request.
+ * Can't use the function name delete as it's reserved
+ */
+export declare const deleteRequest: (url: string, config?: {}) => Promise<ApiResponseClass>;