// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

/// <reference types="cypress" />

// ***************************************************************
// Each command should be properly documented using JSDoc.
// See https://jsdoc.app/index.html for reference.
// Basic requirements for documentation are the following:
// - Meaningful description
// - Specific link to https://api.mattermost.com
// - Each parameter with `@params`
// - Return value with `@returns`
// - Example usage with `@example`
// Custom command should follow naming convention of having `api` prefix, e.g. `apiLogin`.
// ***************************************************************

declare namespace Cypress {
    interface Chainable {

        /**
         * Create a bot.
         * See https://api.mattermost.com/#tag/bots/paths/~1bots/post
         * @param {string} options.bot - predefined `bot` object instead of random bot
         * @param {string} options.prefix - 'bot' (default) or any prefix to easily identify a bot
         * @returns {Bot} out.bot: `Bot` object
         *
         * @example
         *   cy.apiCreateBot().then(({bot}) => {
         *       // do something with bot
         *   });
         */
        apiCreateBot({bot: BotPatch, prefix: string}?): Chainable<{bot: Bot & {fullDisplayName: string}}>;

        /**
         * Get bots.
         * See https://api.mattermost.com/#tag/bots/paths/~1bots/get
         * @param {number} options.page - The page to select
         * @param {number} options.perPage - The number of users per page. There is a maximum limit of 200 users per page
         * @param {boolean} options.includeDeleted - If deleted bots should be returned
         * @returns {Bot[]} out.bots: `Bot[]` object
         *
         * @example
         *   cy.apiGetBots();
         */
        apiGetBots(page?: number, perPage?: number, includeDeleted?: boolean): Chainable<{bots: Bot[]}>;

        /**
         * Disable bot.
         * See https://api.mattermost.com/#tag/bots/operation/DisableBot
         * @param {string} userId - User ID
         * @returns {Response} response: Cypress-chainable response which should have successful HTTP status of 200 OK to continue or pass.
         *
         * @example
         *   cy.apiDisableBot('user-id);
         */
        apiDisableBot(userId: string): Chainable<Response>;

        /**
         * Deactivate test bots.
         *
         * @example
         *   cy.apiDeactivateTestBots();
         */
        apiDeactivateTestBots(): Chainable<>;
    }
}