@google-cloud/dialogflow-cx/build/src/v3/flows_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.Flow|Flows}.
 * @class
 * @memberof v3
 */
export declare class FlowsClient {
    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;
    flowsStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of FlowsClient.
     *
     * @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 FlowsClient({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 flow in the specified agent.
     *
     * Note: You should always train a flow prior to sending it queries. See the
     * [training
     * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The agent to create a flow for.
     *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {google.cloud.dialogflow.cx.v3.Flow} request.flow
     *   Required. The flow to create.
     * @param {string} request.languageCode
     *   The language of the following fields in `flow`:
     *
     *   *  `Flow.event_handlers.trigger_fulfillment.messages`
     *   *  `Flow.event_handlers.trigger_fulfillment.conditional_cases`
     *   *  `Flow.transition_routes.trigger_fulfillment.messages`
     *   *  `Flow.transition_routes.trigger_fulfillment.conditional_cases`
     *
     *   If not specified, the agent's default language is used.
     *   [Many
     *   languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
     *   are supported.
     *   Note: languages must be enabled in the agent before they can be used.
     * @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.Flow|Flow}.
     *   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/flows.create_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_CreateFlow_async
     */
    createFlow(request?: protos.google.cloud.dialogflow.cx.v3.ICreateFlowRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IFlow,
        protos.google.cloud.dialogflow.cx.v3.ICreateFlowRequest | undefined,
        {} | undefined
    ]>;
    createFlow(request: protos.google.cloud.dialogflow.cx.v3.ICreateFlowRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFlow, protos.google.cloud.dialogflow.cx.v3.ICreateFlowRequest | null | undefined, {} | null | undefined>): void;
    createFlow(request: protos.google.cloud.dialogflow.cx.v3.ICreateFlowRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFlow, protos.google.cloud.dialogflow.cx.v3.ICreateFlowRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deletes a specified flow.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the flow to delete.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
     * @param {boolean} request.force
     *   This field has no effect for flows with no incoming transitions.
     *   For flows with incoming transitions:
     *
     *   *  If `force` is set to false, an error will be returned with message
     *      indicating the incoming transitions.
     *   *  If `force` is set to true, Dialogflow will remove the flow, as well as
     *      any transitions to the flow (i.e. [Target
     *      flow][EventHandler.target_flow] in event handlers or [Target
     *      flow][TransitionRoute.target_flow] in transition routes that point to
     *      this flow will be cleared).
     * @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/flows.delete_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_DeleteFlow_async
     */
    deleteFlow(request?: protos.google.cloud.dialogflow.cx.v3.IDeleteFlowRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.dialogflow.cx.v3.IDeleteFlowRequest | undefined,
        {} | undefined
    ]>;
    deleteFlow(request: protos.google.cloud.dialogflow.cx.v3.IDeleteFlowRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteFlowRequest | null | undefined, {} | null | undefined>): void;
    deleteFlow(request: protos.google.cloud.dialogflow.cx.v3.IDeleteFlowRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteFlowRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Retrieves the specified flow.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the flow to get.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
     * @param {string} request.languageCode
     *   The language to retrieve the flow for. The following fields are language
     *   dependent:
     *
     *   *  `Flow.event_handlers.trigger_fulfillment.messages`
     *   *  `Flow.event_handlers.trigger_fulfillment.conditional_cases`
     *   *  `Flow.transition_routes.trigger_fulfillment.messages`
     *   *  `Flow.transition_routes.trigger_fulfillment.conditional_cases`
     *
     *   If not specified, the agent's default language is used.
     *   [Many
     *   languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
     *   are supported.
     *   Note: languages must be enabled in the agent before they can be used.
     * @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.Flow|Flow}.
     *   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/flows.get_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_GetFlow_async
     */
    getFlow(request?: protos.google.cloud.dialogflow.cx.v3.IGetFlowRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IFlow,
        protos.google.cloud.dialogflow.cx.v3.IGetFlowRequest | undefined,
        {} | undefined
    ]>;
    getFlow(request: protos.google.cloud.dialogflow.cx.v3.IGetFlowRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFlow, protos.google.cloud.dialogflow.cx.v3.IGetFlowRequest | null | undefined, {} | null | undefined>): void;
    getFlow(request: protos.google.cloud.dialogflow.cx.v3.IGetFlowRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFlow, protos.google.cloud.dialogflow.cx.v3.IGetFlowRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Updates the specified flow.
     *
     * Note: You should always train a flow prior to sending it queries. See the
     * [training
     * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.dialogflow.cx.v3.Flow} request.flow
     *   Required. The flow 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 {string} request.languageCode
     *   The language of the following fields in `flow`:
     *
     *   *  `Flow.event_handlers.trigger_fulfillment.messages`
     *   *  `Flow.event_handlers.trigger_fulfillment.conditional_cases`
     *   *  `Flow.transition_routes.trigger_fulfillment.messages`
     *   *  `Flow.transition_routes.trigger_fulfillment.conditional_cases`
     *
     *   If not specified, the agent's default language is used.
     *   [Many
     *   languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
     *   are supported.
     *   Note: languages must be enabled in the agent before they can be used.
     * @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.Flow|Flow}.
     *   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/flows.update_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_UpdateFlow_async
     */
    updateFlow(request?: protos.google.cloud.dialogflow.cx.v3.IUpdateFlowRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IFlow,
        protos.google.cloud.dialogflow.cx.v3.IUpdateFlowRequest | undefined,
        {} | undefined
    ]>;
    updateFlow(request: protos.google.cloud.dialogflow.cx.v3.IUpdateFlowRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFlow, protos.google.cloud.dialogflow.cx.v3.IUpdateFlowRequest | null | undefined, {} | null | undefined>): void;
    updateFlow(request: protos.google.cloud.dialogflow.cx.v3.IUpdateFlowRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFlow, protos.google.cloud.dialogflow.cx.v3.IUpdateFlowRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Validates the specified flow and creates or updates validation results.
     * Please call this API after the training is completed to get the complete
     * validation results.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The flow to validate.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
     * @param {string} request.languageCode
     *   If not specified, the agent's default language is used.
     * @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.FlowValidationResult|FlowValidationResult}.
     *   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/flows.validate_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_ValidateFlow_async
     */
    validateFlow(request?: protos.google.cloud.dialogflow.cx.v3.IValidateFlowRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult,
        protos.google.cloud.dialogflow.cx.v3.IValidateFlowRequest | undefined,
        {} | undefined
    ]>;
    validateFlow(request: protos.google.cloud.dialogflow.cx.v3.IValidateFlowRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult, protos.google.cloud.dialogflow.cx.v3.IValidateFlowRequest | null | undefined, {} | null | undefined>): void;
    validateFlow(request: protos.google.cloud.dialogflow.cx.v3.IValidateFlowRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult, protos.google.cloud.dialogflow.cx.v3.IValidateFlowRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets the latest flow validation result. Flow validation is performed
     * when ValidateFlow is called.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The flow name.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/validationResult`.
     * @param {string} request.languageCode
     *   If not specified, the agent's default language is used.
     * @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.FlowValidationResult|FlowValidationResult}.
     *   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/flows.get_flow_validation_result.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_GetFlowValidationResult_async
     */
    getFlowValidationResult(request?: protos.google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult,
        protos.google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest | undefined,
        {} | undefined
    ]>;
    getFlowValidationResult(request: protos.google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult, protos.google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest | null | undefined, {} | null | undefined>): void;
    getFlowValidationResult(request: protos.google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult, protos.google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Trains the specified flow. Note that only the flow in 'draft' environment
     * is trained.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`: An empty [Struct
     *   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
     * - `response`: An [Empty
     *   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
     *
     * Note: You should always train a flow prior to sending it queries. See the
     * [training
     * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The flow to train.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
     * @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/flows.train_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_TrainFlow_async
     */
    trainFlow(request?: protos.google.cloud.dialogflow.cx.v3.ITrainFlowRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    trainFlow(request: protos.google.cloud.dialogflow.cx.v3.ITrainFlowRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    trainFlow(request: protos.google.cloud.dialogflow.cx.v3.ITrainFlowRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `trainFlow()`.
     * @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/flows.train_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_TrainFlow_async
     */
    checkTrainFlowProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>;
    /**
     * Imports the specified flow to the specified agent from a binary file.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`: An empty [Struct
     *   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
     * - `response`:
     * {@link protos.google.cloud.dialogflow.cx.v3.ImportFlowResponse|ImportFlowResponse}
     *
     * Note: You should always train a flow prior to sending it queries. See the
     * [training
     * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The agent to import the flow into.
     *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {string} request.flowUri
     *   The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
     *   to import flow from. The format of this URI must be
     *   `gs://<bucket-name>/<object-name>`.
     *
     *   Dialogflow performs a read operation for the Cloud Storage object
     *   on the caller's behalf, so your request authentication must
     *   have read permissions for the object. For more information, see
     *   [Dialogflow access
     *   control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
     * @param {Buffer} request.flowContent
     *   Uncompressed raw byte content for flow.
     * @param {google.cloud.dialogflow.cx.v3.ImportFlowRequest.ImportOption} request.importOption
     *   Flow import mode. If not specified, `KEEP` is assumed.
     * @param {google.cloud.dialogflow.cx.v3.FlowImportStrategy} [request.flowImportStrategy]
     *   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/flows.import_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_ImportFlow_async
     */
    importFlow(request?: protos.google.cloud.dialogflow.cx.v3.IImportFlowRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IImportFlowResponse, protos.google.protobuf.IStruct>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    importFlow(request: protos.google.cloud.dialogflow.cx.v3.IImportFlowRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IImportFlowResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    importFlow(request: protos.google.cloud.dialogflow.cx.v3.IImportFlowRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IImportFlowResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `importFlow()`.
     * @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/flows.import_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_ImportFlow_async
     */
    checkImportFlowProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.ImportFlowResponse, protos.google.protobuf.Struct>>;
    /**
     * Exports the specified flow to a binary file.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`: An empty [Struct
     *   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
     * - `response`:
     * {@link protos.google.cloud.dialogflow.cx.v3.ExportFlowResponse|ExportFlowResponse}
     *
     * Note that resources (e.g. intents, entities, webhooks) that the flow
     * references will also be exported.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the flow to export.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
     * @param {string} [request.flowUri]
     *   Optional. The [Google Cloud
     *   Storage](https://cloud.google.com/storage/docs/) URI to export the flow to.
     *   The format of this URI must be `gs://<bucket-name>/<object-name>`. If left
     *   unspecified, the serialized flow 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 {boolean} [request.includeReferencedFlows]
     *   Optional. Whether to export flows referenced by the specified flow.
     * @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/flows.export_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_ExportFlow_async
     */
    exportFlow(request?: protos.google.cloud.dialogflow.cx.v3.IExportFlowRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IExportFlowResponse, protos.google.protobuf.IStruct>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    exportFlow(request: protos.google.cloud.dialogflow.cx.v3.IExportFlowRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IExportFlowResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    exportFlow(request: protos.google.cloud.dialogflow.cx.v3.IExportFlowRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IExportFlowResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `exportFlow()`.
     * @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/flows.export_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_ExportFlow_async
     */
    checkExportFlowProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.ExportFlowResponse, protos.google.protobuf.Struct>>;
    /**
    * Returns the list of all flows in the specified agent.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The agent containing the flows.
    *   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 {string} request.languageCode
    *   The language to list flows for. The following fields are language
    *   dependent:
    *
    *   *  `Flow.event_handlers.trigger_fulfillment.messages`
    *   *  `Flow.event_handlers.trigger_fulfillment.conditional_cases`
    *   *  `Flow.transition_routes.trigger_fulfillment.messages`
    *   *  `Flow.transition_routes.trigger_fulfillment.conditional_cases`
    *
    *   If not specified, the agent's default language is used.
    *   [Many
    *   languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
    *   are supported.
    *   Note: languages must be enabled in the agent before they can be used.
    * @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.Flow|Flow}.
    *   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 `listFlowsAsync()`
    *   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.
    */
    listFlows(request?: protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IFlow[],
        protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListFlowsResponse
    ]>;
    listFlows(request: protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest, protos.google.cloud.dialogflow.cx.v3.IListFlowsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IFlow>): void;
    listFlows(request: protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest, protos.google.cloud.dialogflow.cx.v3.IListFlowsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IFlow>): void;
    /**
     * Equivalent to `listFlows`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The agent containing the flows.
     *   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 {string} request.languageCode
     *   The language to list flows for. The following fields are language
     *   dependent:
     *
     *   *  `Flow.event_handlers.trigger_fulfillment.messages`
     *   *  `Flow.event_handlers.trigger_fulfillment.conditional_cases`
     *   *  `Flow.transition_routes.trigger_fulfillment.messages`
     *   *  `Flow.transition_routes.trigger_fulfillment.conditional_cases`
     *
     *   If not specified, the agent's default language is used.
     *   [Many
     *   languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
     *   are supported.
     *   Note: languages must be enabled in the agent before they can be used.
     * @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.Flow|Flow} 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 `listFlowsAsync()`
     *   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.
     */
    listFlowsStream(request?: protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listFlows`, 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 containing the flows.
     *   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 {string} request.languageCode
     *   The language to list flows for. The following fields are language
     *   dependent:
     *
     *   *  `Flow.event_handlers.trigger_fulfillment.messages`
     *   *  `Flow.event_handlers.trigger_fulfillment.conditional_cases`
     *   *  `Flow.transition_routes.trigger_fulfillment.messages`
     *   *  `Flow.transition_routes.trigger_fulfillment.conditional_cases`
     *
     *   If not specified, the agent's default language is used.
     *   [Many
     *   languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
     *   are supported.
     *   Note: languages must be enabled in the agent before they can be used.
     * @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.Flow|Flow}. 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/flows.list_flows.js</caption>
     * region_tag:dialogflow_v3_generated_Flows_ListFlows_async
     */
    listFlowsAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.IFlow>;
    /**
       * 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 operation result. It does not cancel the
     * operation. If the server doesn't support this method, it returns
     * `google.rpc.Code.UNIMPLEMENTED`.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation resource to be deleted.
     * @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