/*! Copyright (c) 2019, XAPPmedia */
import { SurfaceRequirements } from "./SurfaceRequirements";
/**
 * The set of metadata for the Agent. The contents of this message are used in multiple contexts:
 *
 * - Actions on Google directory listing page
 * - Unique identification of an Agent for explicit invocation (displayName)
 * - Content for other parts of an ActionPackage (shortDescription is used for display in AccountLinking, displayName is used in Actions to show the Agent name to users).
 *
 * This message is read-only. You specify the fields in this message via the Actions console and not directly in the action package.
 *
 * @see https://developers.google.com/actions/reference/rest/Shared.Types/ActionPackage#Manifest
 *
 * @export
 * @interface Manifest
 */
export interface Manifest {
    /**
     * The default display name for this Agent (if there is not a translation available), e.g. "Starbucks". This is also used as a method for users to invoke this Agent (in addition to invocationName).
     * The display name must be unique and phonetically very similar to invocationName.
     *
     * @type {string}
     * @memberof Manifest
     */
    displayName?: string;
    /**
     * This is the unique name for this Agent to directly invoke it within a voice (spoken) context.
     * Policies require that the invocation name is phonetically very similar to the displayName field.
     *
     * @type {string}
     * @memberof Manifest
     */
    invocationName?: string;
    /**
     * The default short description for the Agent (if there is not a translation available).
     * This is limited to 80 characters (consistent with Play store).
     *
     * @type {string}
     * @memberof Manifest
     */
    shortDescription?: string;
    /**
     * The default long description for the Agent (if there is not a translation available).
     * This is limited to 4000 characters (consistent with Play store).
     *
     * @type {string}
     * @memberof Manifest
     */
    longDescription?: string;
    /**
     * The category for the Agent. The value must be one of the allowed categories for Agents.
     * See the Actions on Google console for the list of allowed categories.
     *
     * @type {string}
     * @memberof Manifest
     */
    category?: string;
    /**
     * Small square image. The dimensions must be 192px by 192px.
     *
     * @type {string}
     * @memberof Manifest
     */
    smallSquareLogoUrl?: string;
    /**
     * Large landscape image. The dimensions must be 2208px by 1242px.
     *
     * @type {string}
     * @memberof Manifest
     */
    largeLandscapeLogoUrl?: string;
    /**
     * The name of the company that the Agent is associated with.
     *
     * @type {string}
     * @memberof Manifest
     */
    companyName?: string;
    /**
     * The contact email address to allow users to reach out regarding the Agent.
     *
     * @type {string}
     * @memberof Manifest
     */
    contactEmail?: string;
    /**
     * The URL to the ToS (Terms of Service) for the Agent.
     *
     * @type {string}
     * @memberof Manifest
     */
    termsOfServiceUrl?: string;
    /**
     * The URL for the Agent's privacy policy.
     *
     * @type {string}
     * @memberof Manifest
     */
    privacyUrl?: string;
    /**
     * Sample invocation phrase displayed as part of Agent description in the directory of all Agents. Only 5 values can be given.
     *
     * @type {string[]}
     * @memberof Manifest
     */
    sampleInvocation?: string[];
    /**
     * Summary of what an Agent can do. Used for Agent introduction to the users. This should be a verb phrase that completes a sentence like "You can use this Agent to..."
     *
     * @type {string}
     * @memberof Manifest
     */
    introduction?: string;
    /**
     * Free-form testing instructions for the Agent reviewer.
     *
     * @type {string}
     * @memberof Manifest
     */
    testingInstructions?: string;
    /**
     * The voice name to be used. Example values supported: - male_1 - male_2 - female_1 - female_2
     *
     * @type {string}
     * @memberof Manifest
     */
    voiceName?: string;
    /**
     * A set of requirements for the Google Assistant client surface that must be met for the Agent to be triggered.
     *
     * @type {SurfaceCapability}
     * @memberof Manifest
     */
    surfaceRequirements?: SurfaceRequirements;
}