@enfonica/voice/build/src/v1beta1/recordings_client.d.ts

Enfonica Numbering SDK for Node.js

/// <reference types="node" />
import * as gax from 'google-gax';
import { Callback, Descriptors, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Manages Recordings.
 * @class
 * @memberof v1beta1
 */
export declare class RecordingsClient {
    private _terminated;
    private _opts;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    auth: any;
    descriptors: Descriptors;
    innerApiCalls: {
        [name: string]: Function;
    };
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    recordingsStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of RecordingsClient.
     *
     * @param {object} [options] - The configuration object. See the subsequent
     *   parameters for more details.
     * @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://developers.google.com/identity/protocols/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.
     */
    constructor(opts?: any);
    /**
     * 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.
     */
    static get servicePath(): string;
    /**
     * The DNS address for this API service - same as servicePath(),
     * exists for compatibility reasons.
     */
    static get apiEndpoint(): string;
    /**
     * The port for this API service.
     */
    static get port(): number;
    /**
     * The scopes needed to make gRPC calls for every method defined
     * in this service.
     */
    static get scopes(): string[];
    getProjectId(): Promise<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    getRecording(request: protos.enfonica.voice.v1beta1.IGetRecordingRequest, options?: gax.CallOptions): Promise<[protos.enfonica.voice.v1beta1.IRecording, protos.enfonica.voice.v1beta1.IGetRecordingRequest | undefined, {} | undefined]>;
    getRecording(request: protos.enfonica.voice.v1beta1.IGetRecordingRequest, options: gax.CallOptions, callback: Callback<protos.enfonica.voice.v1beta1.IRecording, protos.enfonica.voice.v1beta1.IGetRecordingRequest | null | undefined, {} | null | undefined>): void;
    getRecording(request: protos.enfonica.voice.v1beta1.IGetRecordingRequest, callback: Callback<protos.enfonica.voice.v1beta1.IRecording, protos.enfonica.voice.v1beta1.IGetRecordingRequest | null | undefined, {} | null | undefined>): void;
    deleteRecording(request: protos.enfonica.voice.v1beta1.IDeleteRecordingRequest, options?: gax.CallOptions): Promise<[protos.enfonica.voice.v1beta1.IRecording, protos.enfonica.voice.v1beta1.IDeleteRecordingRequest | undefined, {} | undefined]>;
    deleteRecording(request: protos.enfonica.voice.v1beta1.IDeleteRecordingRequest, options: gax.CallOptions, callback: Callback<protos.enfonica.voice.v1beta1.IRecording, protos.enfonica.voice.v1beta1.IDeleteRecordingRequest | null | undefined, {} | null | undefined>): void;
    deleteRecording(request: protos.enfonica.voice.v1beta1.IDeleteRecordingRequest, callback: Callback<protos.enfonica.voice.v1beta1.IRecording, protos.enfonica.voice.v1beta1.IDeleteRecordingRequest | null | undefined, {} | null | undefined>): void;
    listRecordings(request: protos.enfonica.voice.v1beta1.IListRecordingsRequest, options?: gax.CallOptions): Promise<[protos.enfonica.voice.v1beta1.IRecording[], protos.enfonica.voice.v1beta1.IListRecordingsRequest | null, protos.enfonica.voice.v1beta1.IListRecordingsResponse]>;
    listRecordings(request: protos.enfonica.voice.v1beta1.IListRecordingsRequest, options: gax.CallOptions, callback: PaginationCallback<protos.enfonica.voice.v1beta1.IListRecordingsRequest, protos.enfonica.voice.v1beta1.IListRecordingsResponse | null | undefined, protos.enfonica.voice.v1beta1.IRecording>): void;
    listRecordings(request: protos.enfonica.voice.v1beta1.IListRecordingsRequest, callback: PaginationCallback<protos.enfonica.voice.v1beta1.IListRecordingsRequest, protos.enfonica.voice.v1beta1.IListRecordingsResponse | null | undefined, protos.enfonica.voice.v1beta1.IRecording>): void;
    /**
     * Equivalent to {@link listRecordings}, but returns a NodeJS Stream object.
     *
     * This fetches the paged responses for {@link listRecordings} continuously
     * and invokes the callback registered for 'data' event for each element in the
     * responses.
     *
     * The returned object has 'end' method when no more elements are required.
     *
     * autoPaginate option will be ignored.
     *
     * @see {@link https://nodejs.org/api/stream.html}
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   The resource name of the parent of which to list recordings.
     *   May be of the form `projects/* /calls/*` to list the recordings of that
     *   specific call, or `projects/*` to list recordings across the entire project,
     *   which maps to `projects/* /calls/-`.
     * @param {number} request.pageSize
     *   The maximum number of Recordings to return in the response.
     *   Default value of 10 and maximum value of 100.
     * @param {string} request.pageToken
     *   A pagination token returned from a previous recording to `ListRecordings`
     *   that indicates where this listing should continue from.
     * @param {enfonica.voice.v1beta1.RecordingView} request.view
     *   Configuration of partial responses.
     *   Defaults to BASIC.
     * @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 [Recording]{@link enfonica.voice.v1beta1.Recording} on 'data' event.
     */
    listRecordingsStream(request?: protos.enfonica.voice.v1beta1.IListRecordingsRequest, options?: gax.CallOptions): Transform;
    /**
     * Equivalent to {@link listRecordings}, but 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.parent
     *   The resource name of the parent of which to list recordings.
     *   May be of the form `projects/* /calls/*` to list the recordings of that
     *   specific call, or `projects/*` to list recordings across the entire project,
     *   which maps to `projects/* /calls/-`.
     * @param {number} request.pageSize
     *   The maximum number of Recordings to return in the response.
     *   Default value of 10 and maximum value of 100.
     * @param {string} request.pageToken
     *   A pagination token returned from a previous recording to `ListRecordings`
     *   that indicates where this listing should continue from.
     * @param {enfonica.voice.v1beta1.RecordingView} request.view
     *   Configuration of partial responses.
     *   Defaults to BASIC.
     * @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 conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
     */
    listRecordingsAsync(request?: protos.enfonica.voice.v1beta1.IListRecordingsRequest, options?: gax.CallOptions): AsyncIterable<protos.enfonica.voice.v1beta1.IRecording>;
    /**
     * Return a fully-qualified alias resource name string.
     *
     * @param {string} project
     * @param {string} sip_domain
     * @param {string} alias
     * @returns {string} Resource name string.
     */
    aliasPath(project: string, sipDomain: string, alias: string): string;
    /**
     * Parse the project from Alias resource.
     *
     * @param {string} aliasName
     *   A fully-qualified path representing Alias resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromAliasName(aliasName: string): string | number;
    /**
     * Parse the sip_domain from Alias resource.
     *
     * @param {string} aliasName
     *   A fully-qualified path representing Alias resource.
     * @returns {string} A string representing the sip_domain.
     */
    matchSipDomainFromAliasName(aliasName: string): string | number;
    /**
     * Parse the alias from Alias resource.
     *
     * @param {string} aliasName
     *   A fully-qualified path representing Alias resource.
     * @returns {string} A string representing the alias.
     */
    matchAliasFromAliasName(aliasName: string): string | number;
    /**
     * Return a fully-qualified call resource name string.
     *
     * @param {string} project
     * @param {string} call
     * @returns {string} Resource name string.
     */
    callPath(project: string, call: string): string;
    /**
     * Parse the project from Call resource.
     *
     * @param {string} callName
     *   A fully-qualified path representing Call resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromCallName(callName: string): string | number;
    /**
     * Parse the call from Call resource.
     *
     * @param {string} callName
     *   A fully-qualified path representing Call resource.
     * @returns {string} A string representing the call.
     */
    matchCallFromCallName(callName: string): string | number;
    /**
     * Return a fully-qualified recording resource name string.
     *
     * @param {string} project
     * @param {string} call
     * @param {string} recording
     * @returns {string} Resource name string.
     */
    recordingPath(project: string, call: string, recording: string): string;
    /**
     * Parse the project from Recording resource.
     *
     * @param {string} recordingName
     *   A fully-qualified path representing Recording resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromRecordingName(recordingName: string): string | number;
    /**
     * Parse the call from Recording resource.
     *
     * @param {string} recordingName
     *   A fully-qualified path representing Recording resource.
     * @returns {string} A string representing the call.
     */
    matchCallFromRecordingName(recordingName: string): string | number;
    /**
     * Parse the recording from Recording resource.
     *
     * @param {string} recordingName
     *   A fully-qualified path representing Recording resource.
     * @returns {string} A string representing the recording.
     */
    matchRecordingFromRecordingName(recordingName: string): string | number;
    /**
     * Return a fully-qualified sipDomain resource name string.
     *
     * @param {string} project
     * @param {string} sip_domain
     * @returns {string} Resource name string.
     */
    sipDomainPath(project: string, sipDomain: string): string;
    /**
     * Parse the project from SipDomain resource.
     *
     * @param {string} sipDomainName
     *   A fully-qualified path representing SipDomain resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromSipDomainName(sipDomainName: string): string | number;
    /**
     * Parse the sip_domain from SipDomain resource.
     *
     * @param {string} sipDomainName
     *   A fully-qualified path representing SipDomain resource.
     * @returns {string} A string representing the sip_domain.
     */
    matchSipDomainFromSipDomainName(sipDomainName: string): string | number;
    /**
     * Return a fully-qualified sipInfo resource name string.
     *
     * @param {string} project
     * @param {string} call
     * @returns {string} Resource name string.
     */
    sipInfoPath(project: string, call: string): string;
    /**
     * Parse the project from SipInfo resource.
     *
     * @param {string} sipInfoName
     *   A fully-qualified path representing SipInfo resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromSipInfoName(sipInfoName: string): string | number;
    /**
     * Parse the call from SipInfo resource.
     *
     * @param {string} sipInfoName
     *   A fully-qualified path representing SipInfo resource.
     * @returns {string} A string representing the call.
     */
    matchCallFromSipInfoName(sipInfoName: string): string | number;
    /**
     * Return a fully-qualified transcription resource name string.
     *
     * @param {string} project
     * @param {string} call
     * @param {string} transcription
     * @returns {string} Resource name string.
     */
    transcriptionPath(project: string, call: string, transcription: string): string;
    /**
     * Parse the project from Transcription resource.
     *
     * @param {string} transcriptionName
     *   A fully-qualified path representing Transcription resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromTranscriptionName(transcriptionName: string): string | number;
    /**
     * Parse the call from Transcription resource.
     *
     * @param {string} transcriptionName
     *   A fully-qualified path representing Transcription resource.
     * @returns {string} A string representing the call.
     */
    matchCallFromTranscriptionName(transcriptionName: string): string | number;
    /**
     * Parse the transcription from Transcription resource.
     *
     * @param {string} transcriptionName
     *   A fully-qualified path representing Transcription resource.
     * @returns {string} A string representing the transcription.
     */
    matchTranscriptionFromTranscriptionName(transcriptionName: string): string | number;
    /**
     * Terminate the GRPC channel and close the client.
     *
     * The client will no longer be usable and all future behavior is undefined.
     */
    close(): Promise<void>;
}