botium-actions-on-google-testing/dist/actions-on-google-ava.d.ts

This is an end-to-end testing library for developers building actions

/**
 * Copyright 2018 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 *
 */
import { ExecutionContext } from 'ava';
import { ActionsOnGoogle, AssistResponse } from './actions-on-google';
/**
 * A class that uses Actions on Google as an Ava test wrapper.
 */
export declare class ActionsOnGoogleAva extends ActionsOnGoogle {
    /** @hidden */
    _t: ExecutionContext<any>;
    /**
     * Initializes a new test
     *
     * @param testName The display name for the test
     * @param callback The logic for the test
     *
     * @example
     * ```javascript
     * // Pass in optional user credentials or default to environment variables
     * const action = new ActionsOnGoogleAva(CREDENTIALS);
     * action.startTest('test correct answer', action => {
     *   action.startWith('number genie', 'about 50') // "talk to number genie about 50"
     *     .then(res => {
     *       expect(res.textToSpeech[0]).to.be.equal('I am thinking of a number')
     *     })
     * })
     * ```
     *
     * @public
     */
    startTest(testName: string, callback: (t: ActionsOnGoogleAva) => Promise<any>): void;
    /**
     * Sends a text query to the Action
     *
     * @param input The user-provided query as text
     * @return A Promise with the response from the Action
     *
     * @example
     * ```javascript
     * // Pass in optional user credentials or default to environment variables
     * const action = new ActionsOnGoogleAva(CREDENTIALS);
     * action.startWith('number genie', 'about 50') // "talk to number genie about 50"
     *   .then(res => {
     *     return action.send('what about 49?')
     *   }).then(res => {
     *     expect(res.textToSpeech[0]).to.be.equal('You are very close')
     *   })
     * ```
     *
     * @public
     */
    send(input: string): Promise<AssistResponse>;
}