@google-cloud/dialogflow-cx/build/src/v3/playbooks_client.d.ts

Cx client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Service for managing {@link protos.google.cloud.dialogflow.cx.v3.Playbook|Playbooks}.
 * @class
 * @memberof v3
 */
export declare class PlaybooksClient {
    private _terminated;
    private _opts;
    private _providedCustomServicePath;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    private _universeDomain;
    private _servicePath;
    private _log;
    auth: gax.GoogleAuth;
    descriptors: Descriptors;
    warn: (code: string, message: string, warnType?: string) => void;
    innerApiCalls: {
        [name: string]: Function;
    };
    locationsClient: LocationsClient;
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    operationsClient: gax.OperationsClient;
    playbooksStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of PlaybooksClient.
     *
     * @param {object} [options] - The configuration object.
     * The options accepted by the constructor are described in detail
     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
     * The common options are:
     * @param {object} [options.credentials] - Credentials object.
     * @param {string} [options.credentials.client_email]
     * @param {string} [options.credentials.private_key]
     * @param {string} [options.email] - Account email address. Required when
     *     using a .pem or .p12 keyFilename.
     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
     *     .p12 key downloaded from the Google Developers Console. If you provide
     *     a path to a JSON file, the projectId option below is not necessary.
     *     NOTE: .pem and .p12 require you to specify options.email as well.
     * @param {number} [options.port] - The port on which to connect to
     *     the remote host.
     * @param {string} [options.projectId] - The project ID from the Google
     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
     *     the environment variable GCLOUD_PROJECT for your project ID. If your
     *     app is running in an environment which supports
     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
     *     your project ID will be detected automatically.
     * @param {string} [options.apiEndpoint] - The domain name of the
     *     API remote host.
     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
     *     Follows the structure of {@link gapicConfig}.
     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
     *     For more information, please check the
     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
     *     need to avoid loading the default gRPC version and want to use the fallback
     *     HTTP implementation. Load only fallback version and pass it to the constructor:
     *     ```
     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
     *     const client = new PlaybooksClient({fallback: true}, gax);
     *     ```
     */
    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
    /**
     * Initialize the client.
     * Performs asynchronous operations (such as authentication) and prepares the client.
     * This function will be called automatically when any class method is called for the
     * first time, but if you need to initialize it before calling an actual method,
     * feel free to call initialize() directly.
     *
     * You can await on this method if you want to make sure the client is initialized.
     *
     * @returns {Promise} A promise that resolves to an authenticated service stub.
     */
    initialize(): Promise<{
        [name: string]: Function;
    }>;
    /**
     * The DNS address for this API service.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get servicePath(): string;
    /**
     * The DNS address for this API service - same as servicePath.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get apiEndpoint(): string;
    /**
     * The DNS address for this API service.
     * @returns {string} The DNS address for this service.
     */
    get apiEndpoint(): string;
    get universeDomain(): string;
    /**
     * The port for this API service.
     * @returns {number} The default port for this service.
     */
    static get port(): number;
    /**
     * The scopes needed to make gRPC calls for every method defined
     * in this service.
     * @returns {string[]} List of default scopes.
     */
    static get scopes(): string[];
    getProjectId(): Promise<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    /**
     * Creates a playbook in a specified agent.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The agent to create a playbook for.
     *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {google.cloud.dialogflow.cx.v3.Playbook} request.playbook
     *   Required. The playbook to create.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.dialogflow.cx.v3.Playbook|Playbook}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.create_playbook.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_CreatePlaybook_async
     */
    createPlaybook(request?: protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IPlaybook,
        protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookRequest | undefined,
        {} | undefined
    ]>;
    createPlaybook(request: protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IPlaybook, protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookRequest | null | undefined, {} | null | undefined>): void;
    createPlaybook(request: protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IPlaybook, protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deletes a specified playbook.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the playbook to delete.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.delete_playbook.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_DeletePlaybook_async
     */
    deletePlaybook(request?: protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookRequest | undefined,
        {} | undefined
    ]>;
    deletePlaybook(request: protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookRequest | null | undefined, {} | null | undefined>): void;
    deletePlaybook(request: protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Retrieves the specified Playbook.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the playbook.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.dialogflow.cx.v3.Playbook|Playbook}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.get_playbook.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_GetPlaybook_async
     */
    getPlaybook(request?: protos.google.cloud.dialogflow.cx.v3.IGetPlaybookRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IPlaybook,
        protos.google.cloud.dialogflow.cx.v3.IGetPlaybookRequest | undefined,
        {} | undefined
    ]>;
    getPlaybook(request: protos.google.cloud.dialogflow.cx.v3.IGetPlaybookRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IPlaybook, protos.google.cloud.dialogflow.cx.v3.IGetPlaybookRequest | null | undefined, {} | null | undefined>): void;
    getPlaybook(request: protos.google.cloud.dialogflow.cx.v3.IGetPlaybookRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IPlaybook, protos.google.cloud.dialogflow.cx.v3.IGetPlaybookRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Updates the specified Playbook.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.dialogflow.cx.v3.Playbook} request.playbook
     *   Required. The playbook to update.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   The mask to control which fields get updated. If the mask is not present,
     *   all fields will be updated.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.dialogflow.cx.v3.Playbook|Playbook}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.update_playbook.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_UpdatePlaybook_async
     */
    updatePlaybook(request?: protos.google.cloud.dialogflow.cx.v3.IUpdatePlaybookRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IPlaybook,
        protos.google.cloud.dialogflow.cx.v3.IUpdatePlaybookRequest | undefined,
        {} | undefined
    ]>;
    updatePlaybook(request: protos.google.cloud.dialogflow.cx.v3.IUpdatePlaybookRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IPlaybook, protos.google.cloud.dialogflow.cx.v3.IUpdatePlaybookRequest | null | undefined, {} | null | undefined>): void;
    updatePlaybook(request: protos.google.cloud.dialogflow.cx.v3.IUpdatePlaybookRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IPlaybook, protos.google.cloud.dialogflow.cx.v3.IUpdatePlaybookRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates a version for the specified Playbook.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The playbook to create a version for.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
     * @param {google.cloud.dialogflow.cx.v3.PlaybookVersion} request.playbookVersion
     *   Required. The playbook version to create.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.dialogflow.cx.v3.PlaybookVersion|PlaybookVersion}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.create_playbook_version.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_CreatePlaybookVersion_async
     */
    createPlaybookVersion(request?: protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IPlaybookVersion,
        protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookVersionRequest | undefined,
        {} | undefined
    ]>;
    createPlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IPlaybookVersion, protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    createPlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookVersionRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IPlaybookVersion, protos.google.cloud.dialogflow.cx.v3.ICreatePlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Retrieves the specified version of the Playbook.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the playbook version.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.dialogflow.cx.v3.PlaybookVersion|PlaybookVersion}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.get_playbook_version.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_GetPlaybookVersion_async
     */
    getPlaybookVersion(request?: protos.google.cloud.dialogflow.cx.v3.IGetPlaybookVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IPlaybookVersion,
        protos.google.cloud.dialogflow.cx.v3.IGetPlaybookVersionRequest | undefined,
        {} | undefined
    ]>;
    getPlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3.IGetPlaybookVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IPlaybookVersion, protos.google.cloud.dialogflow.cx.v3.IGetPlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    getPlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3.IGetPlaybookVersionRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IPlaybookVersion, protos.google.cloud.dialogflow.cx.v3.IGetPlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Retrieves the specified version of the Playbook and stores it as the
     * current playbook draft, returning the playbook with resources updated.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the playbook version.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.dialogflow.cx.v3.RestorePlaybookVersionResponse|RestorePlaybookVersionResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.restore_playbook_version.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_RestorePlaybookVersion_async
     */
    restorePlaybookVersion(request?: protos.google.cloud.dialogflow.cx.v3.IRestorePlaybookVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IRestorePlaybookVersionResponse,
        protos.google.cloud.dialogflow.cx.v3.IRestorePlaybookVersionRequest | undefined,
        {} | undefined
    ]>;
    restorePlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3.IRestorePlaybookVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IRestorePlaybookVersionResponse, protos.google.cloud.dialogflow.cx.v3.IRestorePlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    restorePlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3.IRestorePlaybookVersionRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IRestorePlaybookVersionResponse, protos.google.cloud.dialogflow.cx.v3.IRestorePlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deletes the specified version of the Playbook.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the playbook version to delete.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.delete_playbook_version.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_DeletePlaybookVersion_async
     */
    deletePlaybookVersion(request?: protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookVersionRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookVersionRequest | undefined,
        {} | undefined
    ]>;
    deletePlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookVersionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    deletePlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookVersionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeletePlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Exports the specified playbook to a binary file.
     *
     * Note that resources (e.g. examples, tools) that the playbook
     * references will also be exported.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the playbook to export.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
     * @param {string} [request.playbookUri]
     *   Optional. The [Google Cloud
     *   Storage](https://cloud.google.com/storage/docs/) URI to export the playbook
     *   to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If
     *   left unspecified, the serialized playbook is returned inline.
     *
     *   Dialogflow performs a write operation for the Cloud Storage object
     *   on the caller's behalf, so your request authentication must
     *   have write permissions for the object. For more information, see
     *   [Dialogflow access
     *   control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
     * @param {google.cloud.dialogflow.cx.v3.ExportPlaybookRequest.DataFormat} [request.dataFormat]
     *   Optional. The data format of the exported agent. If not specified, `BLOB`
     *   is assumed.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.export_playbook.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_ExportPlaybook_async
     */
    exportPlaybook(request?: protos.google.cloud.dialogflow.cx.v3.IExportPlaybookRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IExportPlaybookResponse, protos.google.protobuf.IStruct>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    exportPlaybook(request: protos.google.cloud.dialogflow.cx.v3.IExportPlaybookRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IExportPlaybookResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    exportPlaybook(request: protos.google.cloud.dialogflow.cx.v3.IExportPlaybookRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IExportPlaybookResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `exportPlaybook()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.export_playbook.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_ExportPlaybook_async
     */
    checkExportPlaybookProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.ExportPlaybookResponse, protos.google.protobuf.Struct>>;
    /**
     * Imports the specified playbook to the specified agent from a binary file.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The agent to import the playbook into.
     *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {string} request.playbookUri
     *   [Dialogflow access
     *   control]
     *   (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
     * @param {Buffer} request.playbookContent
     *   Uncompressed raw byte content for playbook.
     * @param {google.cloud.dialogflow.cx.v3.PlaybookImportStrategy} [request.importStrategy]
     *   Optional. Specifies the import strategy used when resolving resource
     *   conflicts.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.import_playbook.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_ImportPlaybook_async
     */
    importPlaybook(request?: protos.google.cloud.dialogflow.cx.v3.IImportPlaybookRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IImportPlaybookResponse, protos.google.protobuf.IStruct>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    importPlaybook(request: protos.google.cloud.dialogflow.cx.v3.IImportPlaybookRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IImportPlaybookResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    importPlaybook(request: protos.google.cloud.dialogflow.cx.v3.IImportPlaybookRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IImportPlaybookResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `importPlaybook()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.import_playbook.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_ImportPlaybook_async
     */
    checkImportPlaybookProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.ImportPlaybookResponse, protos.google.protobuf.Struct>>;
    /**
    * Returns a list of playbooks in the specified agent.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The agent to list playbooks from.
    *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
    * @param {number} request.pageSize
    *   The maximum number of items to return in a single page. By default 100 and
    *   at most 1000.
    * @param {string} request.pageToken
    *   The next_page_token value returned from a previous list request.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
    *   The first element of the array is Array of {@link protos.google.cloud.dialogflow.cx.v3.Playbook|Playbook}.
    *   The client library will perform auto-pagination by default: it will call the API as many
    *   times as needed and will merge results from all the pages into this array.
    *   Note that it can affect your quota.
    *   We recommend using `listPlaybooksAsync()`
    *   method described below for async iteration which you can stop as needed.
    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
    *   for more details and examples.
    */
    listPlaybooks(request?: protos.google.cloud.dialogflow.cx.v3.IListPlaybooksRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IPlaybook[],
        protos.google.cloud.dialogflow.cx.v3.IListPlaybooksRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListPlaybooksResponse
    ]>;
    listPlaybooks(request: protos.google.cloud.dialogflow.cx.v3.IListPlaybooksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListPlaybooksRequest, protos.google.cloud.dialogflow.cx.v3.IListPlaybooksResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IPlaybook>): void;
    listPlaybooks(request: protos.google.cloud.dialogflow.cx.v3.IListPlaybooksRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListPlaybooksRequest, protos.google.cloud.dialogflow.cx.v3.IListPlaybooksResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IPlaybook>): void;
    /**
     * Equivalent to `listPlaybooks`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The agent to list playbooks from.
     *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {number} request.pageSize
     *   The maximum number of items to return in a single page. By default 100 and
     *   at most 1000.
     * @param {string} request.pageToken
     *   The next_page_token value returned from a previous list request.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Stream}
     *   An object stream which emits an object representing {@link protos.google.cloud.dialogflow.cx.v3.Playbook|Playbook} on 'data' event.
     *   The client library will perform auto-pagination by default: it will call the API as many
     *   times as needed. Note that it can affect your quota.
     *   We recommend using `listPlaybooksAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     */
    listPlaybooksStream(request?: protos.google.cloud.dialogflow.cx.v3.IListPlaybooksRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listPlaybooks`, but returns an iterable object.
     *
     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The agent to list playbooks from.
     *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {number} request.pageSize
     *   The maximum number of items to return in a single page. By default 100 and
     *   at most 1000.
     * @param {string} request.pageToken
     *   The next_page_token value returned from a previous list request.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Object}
     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
     *   When you iterate the returned iterable, each element will be an object representing
     *   {@link protos.google.cloud.dialogflow.cx.v3.Playbook|Playbook}. The API will be called under the hood as needed, once per the page,
     *   so you can stop the iteration when you don't need more results.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.list_playbooks.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_ListPlaybooks_async
     */
    listPlaybooksAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListPlaybooksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.IPlaybook>;
    /**
    * Lists versions for the specified Playbook.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The playbook to list versions for.
    *   Format:
    *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
    * @param {number} [request.pageSize]
    *   Optional. The maximum number of items to return in a single page. By
    *   default 100 and at most 1000.
    * @param {string} [request.pageToken]
    *   Optional. The next_page_token value returned from a previous list request.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
    *   The first element of the array is Array of {@link protos.google.cloud.dialogflow.cx.v3.PlaybookVersion|PlaybookVersion}.
    *   The client library will perform auto-pagination by default: it will call the API as many
    *   times as needed and will merge results from all the pages into this array.
    *   Note that it can affect your quota.
    *   We recommend using `listPlaybookVersionsAsync()`
    *   method described below for async iteration which you can stop as needed.
    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
    *   for more details and examples.
    */
    listPlaybookVersions(request?: protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IPlaybookVersion[],
        protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsResponse
    ]>;
    listPlaybookVersions(request: protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsRequest, protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IPlaybookVersion>): void;
    listPlaybookVersions(request: protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsRequest, protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IPlaybookVersion>): void;
    /**
     * Equivalent to `listPlaybookVersions`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The playbook to list versions for.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of items to return in a single page. By
     *   default 100 and at most 1000.
     * @param {string} [request.pageToken]
     *   Optional. The next_page_token value returned from a previous list request.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Stream}
     *   An object stream which emits an object representing {@link protos.google.cloud.dialogflow.cx.v3.PlaybookVersion|PlaybookVersion} on 'data' event.
     *   The client library will perform auto-pagination by default: it will call the API as many
     *   times as needed. Note that it can affect your quota.
     *   We recommend using `listPlaybookVersionsAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     */
    listPlaybookVersionsStream(request?: protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listPlaybookVersions`, but returns an iterable object.
     *
     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The playbook to list versions for.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of items to return in a single page. By
     *   default 100 and at most 1000.
     * @param {string} [request.pageToken]
     *   Optional. The next_page_token value returned from a previous list request.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Object}
     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
     *   When you iterate the returned iterable, each element will be an object representing
     *   {@link protos.google.cloud.dialogflow.cx.v3.PlaybookVersion|PlaybookVersion}. The API will be called under the hood as needed, once per the page,
     *   so you can stop the iteration when you don't need more results.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/playbooks.list_playbook_versions.js</caption>
     * region_tag:dialogflow_v3_generated_Playbooks_ListPlaybookVersions_async
     */
    listPlaybookVersionsAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListPlaybookVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.IPlaybookVersion>;
    /**
       * Gets information about a location.
       *
       * @param {Object} request
       *   The request object that will be sent.
       * @param {string} request.name
       *   Resource name for the location.
       * @param {object} [options]
       *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
       * @returns {Promise} - The promise which resolves to an array.
       *   The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
       *   for more details and examples.
       * @example
       * ```
       * const [response] = await client.getLocation(request);
       * ```
       */
    getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
    /**
       * Lists information about the supported locations for this service. Returns an iterable object.
       *
       * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
       * @param {Object} request
       *   The request object that will be sent.
       * @param {string} request.name
       *   The resource that owns the locations collection, if applicable.
       * @param {string} request.filter
       *   The standard list filter.
       * @param {number} request.pageSize
       *   The standard list page size.
       * @param {string} request.pageToken
       *   The standard list page token.
       * @param {object} [options]
       *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
       * @returns {Object}
       *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
       *   When you iterate the returned iterable, each element will be an object representing
       *   {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
       *   so you can stop the iteration when you don't need more results.
       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
       *   for more details and examples.
       * @example
       * ```
       * const iterable = client.listLocationsAsync(request);
       * for await (const response of iterable) {
       *   // process response
       * }
       * ```
       */
    listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
    /**
       * Gets the latest state of a long-running operation.  Clients can use this
       * method to poll the operation result at intervals as recommended by the API
       * service.
       *
       * @param {Object} request - The request object that will be sent.
       * @param {string} request.name - The name of the operation resource.
       * @param {Object=} options
       *   Optional parameters. You can override the default settings for this call,
       *   e.g, timeout, retries, paginations, etc. See {@link
       *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
       *   for the details.
       * @param {function(?Error, ?Object)=} callback
       *   The function which will be called with the result of the API call.
       *
       *   The second parameter to the callback is an object representing
       *   {@link google.longrunning.Operation | google.longrunning.Operation}.
       * @return {Promise} - The promise which resolves to an array.
       *   The first element of the array is an object representing
       * {@link google.longrunning.Operation | google.longrunning.Operation}.
       * The promise has a method named "cancel" which cancels the ongoing API call.
       *
       * @example
       * ```
       * const client = longrunning.operationsClient();
       * const name = '';
       * const [response] = await client.getOperation({name});
       * // doThingsWith(response)
       * ```
       */
    getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
    /**
     * Lists operations that match the specified filter in the request. If the
     * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
     *
     * For-await-of syntax is used with the iterable to recursively get response element on-demand.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation collection.
     * @param {string} request.filter - The standard list filter.
     * @param {number=} request.pageSize -
     *   The maximum number of resources contained in the underlying API
     *   response. If page streaming is performed per-resource, this
     *   parameter does not affect the return value. If page streaming is
     *   performed per-page, this determines the maximum number of
     *   resources in a page.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     *   e.g, timeout, retries, paginations, etc. See {@link
     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
     *   details.
     * @returns {Object}
     *   An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * for await (const response of client.listOperationsAsync(request));
     * // doThingsWith(response)
     * ```
     */
    listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
    /**
     * Starts asynchronous cancellation on a long-running operation.  The server
     * makes a best effort to cancel the operation, but success is not
     * guaranteed.  If the server doesn't support this method, it returns
     * `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
     * {@link Operations.GetOperation} or
     * other methods to check whether the cancellation succeeded or whether the
     * operation completed despite cancellation. On successful cancellation,
     * the operation is not deleted; instead, it becomes an operation with
     * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
     * 1, corresponding to `Code.CANCELLED`.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation resource to be cancelled.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     * e.g, timeout, retries, paginations, etc. See {@link
     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
     * details.
     * @param {function(?Error)=} callback
     *   The function which will be called with the result of the API call.
     * @return {Promise} - The promise which resolves when API call finishes.
     *   The promise has a method named "cancel" which cancels the ongoing API
     * call.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * await client.cancelOperation({name: ''});
     * ```
     */
    cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
    /**
     * Deletes a long-running operation. This method indicates that the client is
     * no longer interested in the ope