@google-cloud/essential-contacts/build/src/v1/essential_contacts_service_client.d.ts

Essential contacts client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Manages contacts for important Google Cloud notifications.
 * @class
 * @memberof v1
 */
export declare class EssentialContactsServiceClient {
    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;
    };
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    essentialContactsServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of EssentialContactsServiceClient.
     *
     * @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 EssentialContactsServiceClient({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;
    /**
     * Adds a new contact for a resource.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The resource to save this contact for.
     *   Format: organizations/{organization_id}, folders/{folder_id} or
     *   projects/{project_id}
     * @param {google.cloud.essentialcontacts.v1.Contact} request.contact
     *   Required. The contact to create. Must specify an email address and language
     *   tag.
     * @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.essentialcontacts.v1.Contact|Contact}.
     *   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/v1/essential_contacts_service.create_contact.js</caption>
     * region_tag:essentialcontacts_v1_generated_EssentialContactsService_CreateContact_async
     */
    createContact(request?: protos.google.cloud.essentialcontacts.v1.ICreateContactRequest, options?: CallOptions): Promise<[
        protos.google.cloud.essentialcontacts.v1.IContact,
        protos.google.cloud.essentialcontacts.v1.ICreateContactRequest | undefined,
        {} | undefined
    ]>;
    createContact(request: protos.google.cloud.essentialcontacts.v1.ICreateContactRequest, options: CallOptions, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.ICreateContactRequest | null | undefined, {} | null | undefined>): void;
    createContact(request: protos.google.cloud.essentialcontacts.v1.ICreateContactRequest, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.ICreateContactRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Updates a contact.
     * Note: A contact's email address cannot be changed.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.essentialcontacts.v1.Contact} request.contact
     *   Required. The contact resource to replace the existing saved contact. Note:
     *   the email address of the contact cannot be modified.
     * @param {google.protobuf.FieldMask} [request.updateMask]
     *   Optional. The update mask applied to the resource. For the `FieldMask`
     *   definition, see
     *   https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
     * @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.essentialcontacts.v1.Contact|Contact}.
     *   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/v1/essential_contacts_service.update_contact.js</caption>
     * region_tag:essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_async
     */
    updateContact(request?: protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest, options?: CallOptions): Promise<[
        protos.google.cloud.essentialcontacts.v1.IContact,
        protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest | undefined,
        {} | undefined
    ]>;
    updateContact(request: protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest, options: CallOptions, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest | null | undefined, {} | null | undefined>): void;
    updateContact(request: protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets a single contact.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the contact to retrieve.
     *   Format: organizations/{organization_id}/contacts/{contact_id},
     *   folders/{folder_id}/contacts/{contact_id} or
     *   projects/{project_id}/contacts/{contact_id}
     * @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.essentialcontacts.v1.Contact|Contact}.
     *   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/v1/essential_contacts_service.get_contact.js</caption>
     * region_tag:essentialcontacts_v1_generated_EssentialContactsService_GetContact_async
     */
    getContact(request?: protos.google.cloud.essentialcontacts.v1.IGetContactRequest, options?: CallOptions): Promise<[
        protos.google.cloud.essentialcontacts.v1.IContact,
        protos.google.cloud.essentialcontacts.v1.IGetContactRequest | undefined,
        {} | undefined
    ]>;
    getContact(request: protos.google.cloud.essentialcontacts.v1.IGetContactRequest, options: CallOptions, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IGetContactRequest | null | undefined, {} | null | undefined>): void;
    getContact(request: protos.google.cloud.essentialcontacts.v1.IGetContactRequest, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IGetContactRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deletes a contact.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the contact to delete.
     *   Format: organizations/{organization_id}/contacts/{contact_id},
     *   folders/{folder_id}/contacts/{contact_id} or
     *   projects/{project_id}/contacts/{contact_id}
     * @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/v1/essential_contacts_service.delete_contact.js</caption>
     * region_tag:essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_async
     */
    deleteContact(request?: protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest | undefined,
        {} | undefined
    ]>;
    deleteContact(request: protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest | null | undefined, {} | null | undefined>): void;
    deleteContact(request: protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Allows a contact admin to send a test message to contact to verify that it
     * has been configured correctly.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string[]} request.contacts
     *   Required. The list of names of the contacts to send a test message to.
     *   Format: organizations/{organization_id}/contacts/{contact_id},
     *   folders/{folder_id}/contacts/{contact_id} or
     *   projects/{project_id}/contacts/{contact_id}
     * @param {string} request.resource
     *   Required. The name of the resource to send the test message for. All
     *   contacts must either be set directly on this resource or inherited from
     *   another resource that is an ancestor of this one. Format:
     *   organizations/{organization_id}, folders/{folder_id} or
     *   projects/{project_id}
     * @param {google.cloud.essentialcontacts.v1.NotificationCategory} request.notificationCategory
     *   Required. The notification category to send the test message for. All
     *   contacts must be subscribed to this category.
     * @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/v1/essential_contacts_service.send_test_message.js</caption>
     * region_tag:essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_async
     */
    sendTestMessage(request?: protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest | undefined,
        {} | undefined
    ]>;
    sendTestMessage(request: protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest | null | undefined, {} | null | undefined>): void;
    sendTestMessage(request: protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest | null | undefined, {} | null | undefined>): void;
    /**
    * Lists the contacts that have been set on a resource.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The parent resource name.
    *   Format: organizations/{organization_id}, folders/{folder_id} or
    *   projects/{project_id}
    * @param {number} [request.pageSize]
    *   Optional. The maximum number of results to return from this request.
    *   Non-positive values are ignored. The presence of `next_page_token` in the
    *   response indicates that more results might be available.
    *   If not specified, the default page_size is 100.
    * @param {string} [request.pageToken]
    *   Optional. If present, retrieves the next batch of results from the
    *   preceding call to this method. `page_token` must be the value of
    *   `next_page_token` from the previous response. The values of other method
    *   parameters should be identical to those in the previous call.
    * @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.essentialcontacts.v1.Contact|Contact}.
    *   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 `listContactsAsync()`
    *   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.
    */
    listContacts(request?: protos.google.cloud.essentialcontacts.v1.IListContactsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.essentialcontacts.v1.IContact[],
        protos.google.cloud.essentialcontacts.v1.IListContactsRequest | null,
        protos.google.cloud.essentialcontacts.v1.IListContactsResponse
    ]>;
    listContacts(request: protos.google.cloud.essentialcontacts.v1.IListContactsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.essentialcontacts.v1.IListContactsRequest, protos.google.cloud.essentialcontacts.v1.IListContactsResponse | null | undefined, protos.google.cloud.essentialcontacts.v1.IContact>): void;
    listContacts(request: protos.google.cloud.essentialcontacts.v1.IListContactsRequest, callback: PaginationCallback<protos.google.cloud.essentialcontacts.v1.IListContactsRequest, protos.google.cloud.essentialcontacts.v1.IListContactsResponse | null | undefined, protos.google.cloud.essentialcontacts.v1.IContact>): void;
    /**
     * Equivalent to `listContacts`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent resource name.
     *   Format: organizations/{organization_id}, folders/{folder_id} or
     *   projects/{project_id}
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of results to return from this request.
     *   Non-positive values are ignored. The presence of `next_page_token` in the
     *   response indicates that more results might be available.
     *   If not specified, the default page_size is 100.
     * @param {string} [request.pageToken]
     *   Optional. If present, retrieves the next batch of results from the
     *   preceding call to this method. `page_token` must be the value of
     *   `next_page_token` from the previous response. The values of other method
     *   parameters should be identical to those in the previous call.
     * @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.essentialcontacts.v1.Contact|Contact} 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 `listContactsAsync()`
     *   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.
     */
    listContactsStream(request?: protos.google.cloud.essentialcontacts.v1.IListContactsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listContacts`, 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 parent resource name.
     *   Format: organizations/{organization_id}, folders/{folder_id} or
     *   projects/{project_id}
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of results to return from this request.
     *   Non-positive values are ignored. The presence of `next_page_token` in the
     *   response indicates that more results might be available.
     *   If not specified, the default page_size is 100.
     * @param {string} [request.pageToken]
     *   Optional. If present, retrieves the next batch of results from the
     *   preceding call to this method. `page_token` must be the value of
     *   `next_page_token` from the previous response. The values of other method
     *   parameters should be identical to those in the previous call.
     * @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.essentialcontacts.v1.Contact|Contact}. 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/v1/essential_contacts_service.list_contacts.js</caption>
     * region_tag:essentialcontacts_v1_generated_EssentialContactsService_ListContacts_async
     */
    listContactsAsync(request?: protos.google.cloud.essentialcontacts.v1.IListContactsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.essentialcontacts.v1.IContact>;
    /**
    * Lists all contacts for the resource that are subscribed to the
    * specified notification categories, including contacts inherited from
    * any parent resources.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The name of the resource to compute contacts for.
    *   Format: organizations/{organization_id},
    *   folders/{folder_id} or projects/{project_id}
    * @param {number[]} request.notificationCategories
    *   The categories of notifications to compute contacts for. If ALL is included
    *   in this list, contacts subscribed to any notification category will be
    *   returned.
    * @param {number} [request.pageSize]
    *   Optional. The maximum number of results to return from this request.
    *   Non-positive values are ignored. The presence of `next_page_token` in the
    *   response indicates that more results might be available.
    *   If not specified, the default page_size is 100.
    * @param {string} [request.pageToken]
    *   Optional. If present, retrieves the next batch of results from the
    *   preceding call to this method. `page_token` must be the value of
    *   `next_page_token` from the previous response. The values of other method
    *   parameters should be identical to those in the previous call.
    * @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.essentialcontacts.v1.Contact|Contact}.
    *   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 `computeContactsAsync()`
    *   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.
    */
    computeContacts(request?: protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.essentialcontacts.v1.IContact[],
        protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest | null,
        protos.google.cloud.essentialcontacts.v1.IComputeContactsResponse
    ]>;
    computeContacts(request: protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, protos.google.cloud.essentialcontacts.v1.IComputeContactsResponse | null | undefined, protos.google.cloud.essentialcontacts.v1.IContact>): void;
    computeContacts(request: protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, callback: PaginationCallback<protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, protos.google.cloud.essentialcontacts.v1.IComputeContactsResponse | null | undefined, protos.google.cloud.essentialcontacts.v1.IContact>): void;
    /**
     * Equivalent to `computeContacts`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The name of the resource to compute contacts for.
     *   Format: organizations/{organization_id},
     *   folders/{folder_id} or projects/{project_id}
     * @param {number[]} request.notificationCategories
     *   The categories of notifications to compute contacts for. If ALL is included
     *   in this list, contacts subscribed to any notification category will be
     *   returned.
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of results to return from this request.
     *   Non-positive values are ignored. The presence of `next_page_token` in the
     *   response indicates that more results might be available.
     *   If not specified, the default page_size is 100.
     * @param {string} [request.pageToken]
     *   Optional. If present, retrieves the next batch of results from the
     *   preceding call to this method. `page_token` must be the value of
     *   `next_page_token` from the previous response. The values of other method
     *   parameters should be identical to those in the previous call.
     * @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.essentialcontacts.v1.Contact|Contact} 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 `computeContactsAsync()`
     *   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.
     */
    computeContactsStream(request?: protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `computeContacts`, 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 name of the resource to compute contacts for.
     *   Format: organizations/{organization_id},
     *   folders/{folder_id} or projects/{project_id}
     * @param {number[]} request.notificationCategories
     *   The categories of notifications to compute contacts for. If ALL is included
     *   in this list, contacts subscribed to any notification category will be
     *   returned.
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of results to return from this request.
     *   Non-positive values are ignored. The presence of `next_page_token` in the
     *   response indicates that more results might be available.
     *   If not specified, the default page_size is 100.
     * @param {string} [request.pageToken]
     *   Optional. If present, retrieves the next batch of results from the
     *   preceding call to this method. `page_token` must be the value of
     *   `next_page_token` from the previous response. The values of other method
     *   parameters should be identical to those in the previous call.
     * @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.essentialcontacts.v1.Contact|Contact}. 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/v1/essential_contacts_service.compute_contacts.js</caption>
     * region_tag:essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_async
     */
    computeContactsAsync(request?: protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.essentialcontacts.v1.IContact>;
    /**
     * Return a fully-qualified folderContact resource name string.
     *
     * @param {string} folder
     * @param {string} contact
     * @returns {string} Resource name string.
     */
    folderContactPath(folder: string, contact: string): string;
    /**
     * Parse the folder from FolderContact resource.
     *
     * @param {string} folderContactName
     *   A fully-qualified path representing folder_contact resource.
     * @returns {string} A string representing the folder.
     */
    matchFolderFromFolderContactName(folderContactName: string): string | number;
    /**
     * Parse the contact from FolderContact resource.
     *
     * @param {string} folderContactName
     *   A fully-qualified path representing folder_contact resource.
     * @returns {string} A string representing the contact.
     */
    matchContactFromFolderContactName(folderContactName: string): string | number;
    /**
     * Return a fully-qualified organizationContact resource name string.
     *
     * @param {string} organization
     * @param {string} contact
     * @returns {string} Resource name string.
     */
    organizationContactPath(organization: string, contact: string): string;
    /**
     * Parse the organization from OrganizationContact resource.
     *
     * @param {string} organizationContactName
     *   A fully-qualified path representing organization_contact resource.
     * @returns {string} A string representing the organization.
     */
    matchOrganizationFromOrganizationContactName(organizationContactName: string): string | number;
    /**
     * Parse the contact from OrganizationContact resource.
     *
     * @param {string} organizationContactName
     *   A fully-qualified path representing organization_contact resource.
     * @returns {string} A string representing the contact.
     */
    matchContactFromOrganizationContactName(organizationContactName: string): string | number;
    /**
     * Return a fully-qualified project resource name string.
     *
     * @param {string} project
     * @returns {string} Resource name string.
     */
    projectPath(project: string): string;
    /**
     * Parse the project from Project resource.
     *
     * @param {string} projectName
     *   A fully-qualified path representing Project resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromProjectName(projectName: string): string | number;
    /**
     * Return a fully-qualified projectContact resource name string.
     *
     * @param {string} project
     * @param {string} contact
     * @returns {string} Resource name string.
     */
    projectContactPath(project: string, contact: string): string;
    /**
     * Parse the project from ProjectContact resource.
     *
     * @param {string} projectContactName
     *   A fully-qualified path representing project_contact resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromProjectContactName(projectContactName: string): string | number;
    /**
     * Parse the contact from ProjectContact resource.
     *
     * @param {string} projectContactName
     *   A fully-qualified path representing project_contact resource.
     * @returns {string} A string representing the contact.
     */
    matchContactFromProjectContactName(projectContactName: string): string | number;
    /**
     * Terminate the gRPC channel and close the client.
     *
     * The client will no longer be usable and all future behavior is undefined.
     * @returns {Promise} A promise that resolves when the client is closed.
     */
    close(): Promise<void>;
}