rcs-js 2.0.21 → 2.0.23-rc.1

package/dist/cjs/api/resources/calls/client/Client.d.ts

@@ -0,0 +1,181 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Pinnacle from "../../../index.js";
+export declare namespace Calls {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Calls {
+    protected readonly _options: Calls.Options;
+    constructor(_options: Calls.Options);
+    /**
+     * List voice calls for your team. Results are sorted newest first.
+     *
+     * @param {Pinnacle.CallsListRequest} request
+     * @param {Calls.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.calls.list()
+     */
+    list(request?: Pinnacle.CallsListRequest, requestOptions?: Calls.RequestOptions): core.HttpResponsePromise<Pinnacle.ListCallsResponse>;
+    private __list;
+    /**
+     * Start an outbound voice call from a voice-enabled phone number owned by your team.
+     *
+     * @param {Pinnacle.CreateCallParams} request
+     * @param {Calls.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     * @throws {@link Pinnacle.BadGatewayError}
+     * @throws {@link Pinnacle.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.calls.create({
+     *         to: "to",
+     *         from: "from"
+     *     })
+     */
+    create(request: Pinnacle.CreateCallParams, requestOptions?: Calls.RequestOptions): core.HttpResponsePromise<Pinnacle.CreatedCall>;
+    private __create;
+    /**
+     * Retrieve one voice call by its Pinnacle call ID.
+     *
+     * @param {string} id - Pinnacle call ID.
+     * @param {Calls.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.calls.get("call_7cQe4F8xT1yB2mN9pK3L")
+     */
+    get(id: string, requestOptions?: Calls.RequestOptions): core.HttpResponsePromise<Pinnacle.Call>;
+    private __get;
+    /**
+     * End a live call. Terminal calls are returned unchanged.
+     *
+     * @param {string} id - Pinnacle call ID.
+     * @param {Calls.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.BadGatewayError}
+     * @throws {@link Pinnacle.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.calls.cancel("call_7cQe4F8xT1yB2mN9pK3L")
+     */
+    cancel(id: string, requestOptions?: Calls.RequestOptions): core.HttpResponsePromise<Pinnacle.Call>;
+    private __cancel;
+    /**
+     * Replace a call's metadata. For live calls, future call events carry the updated metadata.
+     *
+     * @param {string} id - Pinnacle call ID.
+     * @param {Pinnacle.UpdateCallParams} request
+     * @param {Calls.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.BadGatewayError}
+     * @throws {@link Pinnacle.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.calls.update("call_7cQe4F8xT1yB2mN9pK3L", {
+     *         metadata: {
+     *             "key": "value"
+     *         }
+     *     })
+     */
+    update(id: string, request: Pinnacle.UpdateCallParams, requestOptions?: Calls.RequestOptions): core.HttpResponsePromise<Pinnacle.Call>;
+    private __update;
+    /**
+     * List the event timeline for a call.
+     *
+     * @param {string} id - Pinnacle call ID.
+     * @param {Pinnacle.CallsListEventsRequest} request
+     * @param {Calls.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.calls.listEvents("call_7cQe4F8xT1yB2mN9pK3L")
+     */
+    listEvents(id: string, request?: Pinnacle.CallsListEventsRequest, requestOptions?: Calls.RequestOptions): core.HttpResponsePromise<Pinnacle.ListCallEventsResponse>;
+    private __listEvents;
+    /**
+     * Mint a short-lived WebSocket token for a call. Use the returned `stream_url` to connect to Pinnacle's bidirectional voice stream.
+     *
+     * @param {string} id - Pinnacle call ID.
+     * @param {Pinnacle.CreateStreamTokenParams} request
+     * @param {Calls.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.ConflictError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.calls.createStreamToken("call_7cQe4F8xT1yB2mN9pK3L")
+     */
+    createStreamToken(id: string, request?: Pinnacle.CreateStreamTokenParams, requestOptions?: Calls.RequestOptions): core.HttpResponsePromise<Pinnacle.CallStreamToken>;
+    private __createStreamToken;
+    /**
+     * Return a short-lived signed URL for the call recording.
+     *
+     * @param {string} id - Pinnacle call ID.
+     * @param {Pinnacle.CallsDownloadRecordingRequest} request
+     * @param {Calls.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.GoneError}
+     * @throws {@link Pinnacle.UnprocessableEntityError}
+     * @throws {@link Pinnacle.TooEarlyError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.calls.downloadRecording("call_7cQe4F8xT1yB2mN9pK3L")
+     */
+    downloadRecording(id: string, request?: Pinnacle.CallsDownloadRecordingRequest, requestOptions?: Calls.RequestOptions): core.HttpResponsePromise<Pinnacle.RecordingDownload>;
+    private __downloadRecording;
+    /**
+     * Delete the canonical recording and queued fragments for a terminal call.
+     *
+     * @param {string} id - Pinnacle call ID.
+     * @param {Calls.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.ConflictError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.BadGatewayError}
+     * @throws {@link Pinnacle.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.calls.deleteRecording("call_7cQe4F8xT1yB2mN9pK3L")
+     */
+    deleteRecording(id: string, requestOptions?: Calls.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteRecording;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+}