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

Cx client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, 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.v3beta1.Playbook|Playbooks}.
 * @class
 * @memberof v3beta1
 */
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;
    };
    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.v3beta1.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.v3beta1.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/v3beta1/playbooks.create_playbook.js</caption>
     * region_tag:dialogflow_v3beta1_generated_Playbooks_CreatePlaybook_async
     */
    createPlaybook(request?: protos.google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook,
        protos.google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookRequest | undefined,
        {} | undefined
    ]>;
    createPlaybook(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook, protos.google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookRequest | null | undefined, {} | null | undefined>): void;
    createPlaybook(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook, protos.google.cloud.dialogflow.cx.v3beta1.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/v3beta1/playbooks.delete_playbook.js</caption>
     * region_tag:dialogflow_v3beta1_generated_Playbooks_DeletePlaybook_async
     */
    deletePlaybook(request?: protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookRequest | undefined,
        {} | undefined
    ]>;
    deletePlaybook(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookRequest | null | undefined, {} | null | undefined>): void;
    deletePlaybook(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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/v3beta1/playbooks.get_playbook.js</caption>
     * region_tag:dialogflow_v3beta1_generated_Playbooks_GetPlaybook_async
     */
    getPlaybook(request?: protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook,
        protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookRequest | undefined,
        {} | undefined
    ]>;
    getPlaybook(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook, protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookRequest | null | undefined, {} | null | undefined>): void;
    getPlaybook(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook, protos.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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.v3beta1.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/v3beta1/playbooks.update_playbook.js</caption>
     * region_tag:dialogflow_v3beta1_generated_Playbooks_UpdatePlaybook_async
     */
    updatePlaybook(request?: protos.google.cloud.dialogflow.cx.v3beta1.IUpdatePlaybookRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook,
        protos.google.cloud.dialogflow.cx.v3beta1.IUpdatePlaybookRequest | undefined,
        {} | undefined
    ]>;
    updatePlaybook(request: protos.google.cloud.dialogflow.cx.v3beta1.IUpdatePlaybookRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook, protos.google.cloud.dialogflow.cx.v3beta1.IUpdatePlaybookRequest | null | undefined, {} | null | undefined>): void;
    updatePlaybook(request: protos.google.cloud.dialogflow.cx.v3beta1.IUpdatePlaybookRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook, protos.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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.v3beta1.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/v3beta1/playbooks.create_playbook_version.js</caption>
     * region_tag:dialogflow_v3beta1_generated_Playbooks_CreatePlaybookVersion_async
     */
    createPlaybookVersion(request?: protos.google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IPlaybookVersion,
        protos.google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookVersionRequest | undefined,
        {} | undefined
    ]>;
    createPlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IPlaybookVersion, protos.google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    createPlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreatePlaybookVersionRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IPlaybookVersion, protos.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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/v3beta1/playbooks.get_playbook_version.js</caption>
     * region_tag:dialogflow_v3beta1_generated_Playbooks_GetPlaybookVersion_async
     */
    getPlaybookVersion(request?: protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IPlaybookVersion,
        protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookVersionRequest | undefined,
        {} | undefined
    ]>;
    getPlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IPlaybookVersion, protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    getPlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookVersionRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IPlaybookVersion, protos.google.cloud.dialogflow.cx.v3beta1.IGetPlaybookVersionRequest | 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/v3beta1/playbooks.delete_playbook_version.js</caption>
     * region_tag:dialogflow_v3beta1_generated_Playbooks_DeletePlaybookVersion_async
     */
    deletePlaybookVersion(request?: protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookVersionRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookVersionRequest | undefined,
        {} | undefined
    ]>;
    deletePlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookVersionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    deletePlaybookVersion(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookVersionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeletePlaybookVersionRequest | null | undefined, {} | null | undefined>): void;
    /**
    * 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.v3beta1.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.v3beta1.IListPlaybooksRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook[],
        protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybooksRequest | null,
        protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybooksResponse
    ]>;
    listPlaybooks(request: protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybooksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybooksRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybooksResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IPlaybook>): void;
    listPlaybooks(request: protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybooksRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybooksRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybooksResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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/v3beta1/playbooks.list_playbooks.js</caption>
     * region_tag:dialogflow_v3beta1_generated_Playbooks_ListPlaybooks_async
     */
    listPlaybooksAsync(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybooksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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.v3beta1.IListPlaybookVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IPlaybookVersion[],
        protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsRequest | null,
        protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsResponse
    ]>;
    listPlaybookVersions(request: protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IPlaybookVersion>): void;
    listPlaybookVersions(request: protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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/v3beta1/playbooks.list_playbook_versions.js</caption>
     * region_tag:dialogflow_v3beta1_generated_Playbooks_ListPlaybookVersions_async
     */
    listPlaybookVersionsAsync(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListPlaybookVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.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>;
    /**
     * Return a fully-qualified agent resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @returns {string} Resource name string.
     */
    agentPath(project: string, location: string, agent: string): string;
    /**
     * Parse the project from Agent resource.
     *
     * @param {string} agentName
     *   A fully-qualified path representing Agent resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromAgentName(agentName: string): string | number;
    /**
     * Parse the location from Agent resource.
     *
     * @param {string} agentName
     *   A fully-qualified path representing Agent resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromAgentName(agentName: string): string | number;
    /**
     * Parse the agent from Agent resource.
     *
     * @param {string} agentName
     *   A fully-qualified path representing Agent resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromAgentName(agentName: string): string | number;
    /**
     * Return a fully-qualified agentGenerativeSettings resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @returns {string} Resource name string.
     */
    agentGenerativeSettingsPath(project: string, location: string, agent: string): string;
    /**
     * Parse the project from AgentGenerativeSettings resource.
     *
     * @param {string} agentGenerativeSettingsName
     *   A fully-qualified path representing AgentGenerativeSettings resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
    /**
     * Parse the location from AgentGenerativeSettings resource.
     *
     * @param {string} agentGenerativeSettingsName
     *   A fully-qualified path representing AgentGenerativeSettings resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
    /**
     * Parse the agent from AgentGenerativeSettings resource.
     *
     * @param {string} agentGenerativeSettingsName
     *   A fully-qualified path representing AgentGenerativeSettings resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
    /**
     * Return a fully-qualified agentValidationResult resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @returns {string} Resource name string.
     */
    agentValidationResultPath(project: string, location: string, agent: string): string;
    /**
     * Parse the project from AgentValidationResult resource.
     *
     * @param {string} agentValidationResultName
     *   A fully-qualified path representing AgentValidationResult resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromAgentValidationResultName(agentValidationResultName: string): string | number;
    /**
     * Parse the location from AgentValidationResult resource.
     *
     * @param {string} agentValidationResultName
     *   A fully-qualified path representing AgentValidationResult resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromAgentValidationResultName(agentValidationResultName: string): string | number;
    /**
     * Parse the agent from AgentValidationResult resource.
     *
     * @param {string} agentValidationResultName
     *   A fully-qualified path representing AgentValidationResult resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromAgentValidationResultName(agentValidationResultName: string): string | number;
    /**
     * Return a fully-qualified changelog resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @param {string} changelog
     * @returns {string} Resource name string.
     */
    changelogPath(project: string, location: string, agent: string, changelog: string): string;
    /**
     * Parse the project from Changelog resource.
     *
     * @param {string} changelogName
     *   A fully-qualified path representing Changelog resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromChangelogName(changelogName: string): string | number;
    /**
     * Parse the location from Changelog resource.
     *
     * @param {string} changelogName
     *   A fully-qualified path representing Changelog resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromChangelogName(changelogName: string): string | number;
    /**
     * Parse the agent from Changelog resource.
     *
     * @param {string} changelogName
     *   A fully-qualified path representing Changelog resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromChangelogName(changelogName: string): string | number;
    /**
     * Parse the changelog from Changelog resource.
     *
     * @param {string} changelogName
     *   A fully-qualified path representing Changelog resource.
     * @returns {string} A string representing the changelog.
     */
    matchChangelogFromChangelogName(changelogName: string): string | number;
    /**
     * Return a fully-qualified continuousTestResult resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @param {string} environment
     * @param {string} continuous_test_result
     * @returns {string} Resource name string.
     */
    continuousTestResultPath(project: string, location: string, agent: string, environment: string, continuousTestResult: string): string;
    /**
     * Parse the project from ContinuousTestResult resource.
     *
     * @param {string} continuousTestResultName
     *   A fully-qualified path representing ContinuousTestResult resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromContinuousTestResultName(continuousTestResultName: string): string | number;
    /**
     * Parse the location from ContinuousTestResult resource.
     *
     * @param {string} continuousTestResultName
     *   A fully-qualified path representing ContinuousTestResult resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromContinuousTestResultName(continuousTestResultName: string): string | number;
    /**
     * Parse the agent from ContinuousTestResult resource.
     *
     * @param {string} continuousTestResultName
     *   A fully-qualified path representing ContinuousTestResult resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromContinuousTestResultName(continuousTestResultName: string): string | number;
    /**
     * Parse the environment from ContinuousTestResult resource.
     *
     * @param {string} continuousTestResultName
     *   A fully-qualified path representing ContinuousTestResult resource.
     * @returns {string} A string representing the environment.
     */
    matchEnvironmentFromContinuousTestResultName(continuousTestResultName: string): string | number;
    /**
     * Parse the continuous_test_result from ContinuousTestResult resource.
     *
     * @param {string} continuousTestResultName
     *   A fully-qualified path representing ContinuousTestResult resource.
     * @returns {string} A string representing the continuous_test_result.
     */
    matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName: string): string | number;
    /**
     * Return a fully-qualified conversation resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @param {string} conversation
     * @returns {string} Resource name string.
     */
    conversationPath(project: string, location: string, agent: string, conversation: string): string;
    /**
     * Parse the project from Conversation resource.
     *
     * @param {string} conversationName
     *   A fully-qualified path representing Conversation resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromConversationName(conversationName: string): string | number;
    /**
     * Parse the location from Conversation resource.
     *
     * @param {string} conversationName
     *   A fully-qualified path representing Conversation resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromConversationName(conversationName: string): string | number;
    /**
     * Parse the agent from Conversation resource.
     *
     * @param {string} conversationName
     *   A fully-qualified path representing Conversation resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromConversationName(conversationName: string): string | number;
    /**
     * Parse the conversation from Conversation resource.
     *
     * @param {string} conversationName
     *   A fully-qualified path representing Conversation resource.
     * @returns {string} A string representing the conversation.
     */
    matchConversationFromConversationName(conversationName: string): string | number;
    /**
     * Return a fully-qualified deployment resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @param {string} environment
     * @param {string} deployment
     * @returns {string} Resource name string.
     */
    deploymentPath(project: string, location: string, agent: string, environment: string, deployment: string): string;
    /**
     * Parse the project from Deployment resource.
     *
     * @param {string} deploymentName
     *   A fully-qualified path representing Deployment resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromDeploymentName(deploymentName: string): string | number;
    /**
     * Parse the location from Deployment resource.
     *
     * @param {string} deploymentName
     *   A fully-qualified path representing Deployment resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromDeploymentName(deploymentName: string): string | number;
    /**
     * Parse the agent from Deployment resource.
     *
     * @param {string} deploymentName
     *   A fully-qualified path representing Deployment resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromDeploymentName(deploymentName: string): string | number;
    /**
     * Parse the environment from Deployment resource.
     *
     * @param {string} deploymentName
     *   A fully-qualified path representing Deployment resource.
     * @returns {string} A string representing the environment.
     */
    matchEnvironmentFromDeploymentName(deploymentName: string): string | number;
    /**
     * Parse the deployment from Deployment resource.
     *
     * @param {string} deploymentName
     *   A fully-qualified path representing Deployment resource.
     * @returns {string} A string representing the deployment.
     */
    matchDeploymentFromDeploymentName(deploymentName: string): string | number;
    /**
     * Return a fully-qualified entityType resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @param {string} entity_type
     * @returns {string} Resource name string.
     */
    entityTypePath(project: string, location: string, agent: string, entityType: string): string;
    /**
     * Parse the project from EntityType resource.
     *
     * @param {string} entityTypeName
     *   A fully-qualified path representing EntityType resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromEntityTypeName(entityTypeName: string): string | number;
    /**
     * Parse the location from EntityType resource.
     *
     * @param {string} entityTypeName
     *   A fully-qualified path representing EntityType resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromEntityTypeName(entityTypeName: string): string | number;
    /**
     * Parse the agent from EntityType resource.
     *
     * @param {string} entityTypeName
     *   A fully-qualified path representing EntityType resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromEntityTypeName(entityTypeName: string): string | number;
    /**
     * Parse the entity_type from EntityType resource.
     *
     * @param {string} entityTypeName
     *   A fully-qualified path representing EntityType resource.
     * @returns {string} A string representing the entity_type.
     */
    matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;
    /**
     * Return a fully-qualified environment resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @param {string} environment
     * @returns {string} Resource name string.
     */
    environmentPath(project: string, location: string, agent: string, environment: string): string;
    /**
     * Parse the project from Environment resource.
     *
     * @param {string} environmentName
     *   A fully-qualified path representing Environment resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromEnvironmentName(environmentName: string): string | number;
    /**
     * Parse the location from Environment resource.
     *
     * @param {string} environmentName
     *   A fully-qualified path representing Environment resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromEnvironmentName(environmentName: string): string | number;
    /**
     * Parse the agent from Environment resource.
     *
     * @param {string} environmentName
     *   A fully-qualified path representing Environment resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromEnvironmentName(environmentName: string): string | number;
    /**
     * Parse the environment from Environment resource.
     *
     * @param {string} environmentName
     *   A fully