@enfonica/voice
Version:
Enfonica Numbering SDK for Node.js
305 lines (304 loc) • 11.8 kB
TypeScript
import * as gax from 'google-gax';
import { Callback, Descriptors } from 'google-gax';
/**
* A stream is a two-way audio bridge with a call. You operate a stream with the
* {@link enfonica.voice.v1beta1.Streams.StreamCall|StreamCall} method. You supply a
* unique, user-generated stream resource name, and then bridge a call to the stream
* using the Stream VoiceML action.
* @class
* @memberof v1beta1
*/
export declare class StreamsClient {
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;
};
streamsStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of StreamsClient.
*
* @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;
/**
* Operates a stream which can be bridged to by a call. This allows bi-directional
* audio to be passed. This method is only available via the gRPC API (not REST).
* If the stream is not connected to a call within 30 seconds of establishment,
* this method will fail.
*
* @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 is both readable and writable. It accepts objects
* representing [StreamCallRequest]{@link enfonica.voice.v1beta1.StreamCallRequest} for write() method, and
* will emit objects representing [StreamCallResponse]{@link enfonica.voice.v1beta1.StreamCallResponse} on 'data' event asynchronously.
*/
streamCall(options?: gax.CallOptions): gax.CancellableStream;
/**
* 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 stream resource name string.
*
* @param {string} project
* @param {string} streams
* @returns {string} Resource name string.
*/
streamPath(project: string, streams: string): string;
/**
* Parse the project from Stream resource.
*
* @param {string} streamName
* A fully-qualified path representing Stream resource.
* @returns {string} A string representing the project.
*/
matchProjectFromStreamName(streamName: string): string | number;
/**
* Parse the streams from Stream resource.
*
* @param {string} streamName
* A fully-qualified path representing Stream resource.
* @returns {string} A string representing the streams.
*/
matchStreamsFromStreamName(streamName: 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>;
}