/// <reference path="../../packages.ts" />

/**
* @module UI
* @submodule UI VirtualAgent
* @namespace ui.virtualAgent
*/
namespace internal.ui.virtualAgent {
    /**
     * An object resolved by the render() method to interact with the virtual agent component
     * @class SDK
     */
    export interface SDK extends ComponentSDK {
        /**
         * Insert a message in the user's chat with virtual agent
         * @method sendMessage
         * @param {String} message A message to send to virtual agent
         * @return {Promise}
         * @example
         *
         *     ui.virtualAgent.render(config).then(
         *         function(sdk) {
         *             // Send a message to virtual agent
         *             sdk.sendMessage("Test message");
         *         },
         *         function() {
         *             console.log("Unable to render virtual agent");
         *         });
         *
         */
        sendMessage(message: any): JQueryPromise<any>;

        /**
         * Resets Virtual Agent
         * @method startOver
         * @example
         *
         *     ui.virtualAgent.render(config).then(
         *         function(sdk) {
         *             // Reset virtual agent and start over
         *             sdk.startOver();
         *         },
         *         function() {
         *             console.log("Unable to render virtual agent");
         *         });
         *
         */
        startOver(): void;

        /**
         * Ends Chat with live agent in Virtual Agent
         * @method endChat
         * @example
         *
         *     ui.virtualAgent.render(config).then(
         *         function(sdk) {
         *             // End the chat
         *             sdk.endChat();
         *         },
         *         function() {
         *             console.log("Unable to render virtual agent");
         *         });
         *
         */
        endChat(): void;

        /**
         * shows feedback in Virtual Agent
         * @method showFeedback
         * @example
         *
         *     ui.virtualAgent.render(config).then(
         *         function(sdk) {
         *             // show virtual agent feedback
         *             sdk.showFeedback();
         *         },
         *         function() {
         *             console.log("Unable to render virtual agent");
         *         });
         *
         */
        showFeedback(): void;
    }
}