@egodigital/egoose/lib/services/feedback.d.ts

Helper classes and functions for Node.js 10 or later.

/**
 * This file is part of the @egodigital/egoose distribution.
 * Copyright (c) e.GO Digital GmbH, Aachen, Germany (https://www.e-go-digital.com/)
 *
 * @egodigital/egoose is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * @egodigital/egoose is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
import { HttpResponse } from '../http';
/**
 * Options for 'sendAppFeedback()' function.
 */
export interface SendAppFeedbackOptions {
    /**
     * The name / ID of the app.
     */
    app: string;
    /**
     * The content type of message.
     */
    contentType?: string;
    /**
     * The email address of the underlying user.
     */
    email?: string;
    /**
     * The message (text).
     */
    message: string;
    /**
     * The custom email address of the recipient of feedback mails.
     */
    recipientMail?: string;
    /**
     * The name of the user.
     */
    username?: string;
    /**
     * User Slack or not.
     */
    useSlack?: boolean;
}
/**
 * Sends an app feedback to a service.
 *
 * @param {SendAppFeedbackOptions} opts The options for sending the feedback.
 *
 * @return {Promise<HttpResponse>} The promise with the HTTP response.
 */
export declare function sendAppFeedback(opts: SendAppFeedbackOptions): Promise<HttpResponse>;