@sentdm/sentdm 0.41.0 → 0.42.0

package/resources/calls/calls.d.ts

@@ -0,0 +1,386 @@
+import { APIResource } from "../../core/resource.js";
+import * as WebhooksAPI from "../webhooks.js";
+import * as ParticipantsAPI from "./participants.js";
+import { APIResponseOfListOfCallParticipant, CallParticipant, CallParticipantTarget, ParticipantAddParams, ParticipantListParams, ParticipantRemoveAllParams, ParticipantRemoveParams, ParticipantUpdateParams, Participants } from "./participants.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { CallsPage, type CallsPageParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Phone calls from the numbers you hold, driven by your own callback URL.
+ *
+ * `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent asks what to do with each call on it, and `POST /v3/channels/voice/tokens` mints a short-lived token that lets a user of your app place and receive calls as that number. When a call arrives or a caller presses a key, a signed question is POSTed to the callback URL and the answer decides the call; `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need before a real call reaches it, and `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret. The call events themselves (`call.completed` and the rest) arrive through your webhooks.
+ *
+ * Every call is a record under `/v3/calls`: read it, list its recordings once one is ready, hang it up, start or stop recording, and add, mute or remove conference participants while it is live. A leg to a phone number runs for at most what your balance affords at the destination's rate.
+ */
+export declare class Calls extends APIResource {
+    participants: ParticipantsAPI.Participants;
+    /**
+     * Retrieves one of your calls by id: the parties, the owning number, the current
+     * status with its failure reason, duration, price, recording availability, and a
+     * timeline of when the call entered each status.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfCall = await client.calls.retrieve(
+     *   'call_9f2ab000-0000-4000-8000-000000000001',
+     * );
+     * ```
+     */
+    retrieve(id: string, params?: CallRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfCall>;
+    /**
+     * Retrieves a paginated list of your calls, most recent first. Filter by
+     * direction, status, the owning number, and the time the call started (from and to
+     * are inclusive). Use the call webhooks for real-time updates; this list is for
+     * looking calls up afterwards.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const call of client.calls.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(params?: CallListParams | null | undefined, options?: RequestOptions): PagePromise<CallsCallsPage, Call>;
+    /**
+     * Ends one of your live calls. The call then ends the way any other call does: its
+     * status moves to completed and call.completed is sent once the disconnect is
+     * reported. A call that has already ended answers 409, and so does a call with no
+     * phone leg, such as one between two app users.
+     *
+     * @example
+     * ```ts
+     * await client.calls.hangup(
+     *   'call_9f2ab000-0000-4000-8000-000000000001',
+     * );
+     * ```
+     */
+    hangup(id: string, params: CallHangupParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Returns pre-signed links to the recordings of one of your calls, each valid
+     * until its url_expires_at. A recording appears once the call was recorded, by a
+     * connect answer with record set, a startRecording instruction or the recordings
+     * command, and the call.recording_ready webhook has been sent; until then, and for
+     * a call that was never recorded, the list is empty. A call recorded more than
+     * once lists every recording, oldest first, each under the recording_id its
+     * call.recording_ready webhook carried.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfCallRecordings =
+     *   await client.calls.listRecordings(
+     *     'call_9f2ab000-0000-4000-8000-000000000001',
+     *   );
+     * ```
+     */
+    listRecordings(id: string, params?: CallListRecordingsParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfCallRecordings>;
+    /**
+     * Starts or stops recording one of your live calls. Use start to begin recording
+     * mid-call, or stop to end a recording, whether it was started here or by a
+     * connect answer with record set. A call that has already ended answers 409, and
+     * so does a call with no phone leg, such as one between two app users, which can't
+     * be recorded.
+     *
+     * @example
+     * ```ts
+     * await client.calls.record(
+     *   'call_9f2ab000-0000-4000-8000-000000000001',
+     * );
+     * ```
+     */
+    record(id: string, params: CallRecordParams, options?: RequestOptions): APIPromise<void>;
+}
+export type CallsCallsPage = CallsPage<Call>;
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfCall {
+    /**
+     * A call record
+     */
+    data?: Call | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfCallRecordings {
+    /**
+     * The recordings of a call, each as a short-lived download link
+     */
+    data?: CallRecordings | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfCallsList {
+    /**
+     * Paginated list of calls
+     */
+    data?: CallsList | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+/**
+ * A call record
+ */
+export interface Call {
+    /**
+     * The call id, the same one carried by the call.request question and every call
+     * webhook
+     */
+    id?: string;
+    /**
+     * When the call was answered (UTC). Null until then, and always null for a call
+     * between two of your app users
+     */
+    answered_at?: string | null;
+    /**
+     * outbound for a call placed from your app, inbound for a call to one of your
+     * numbers
+     */
+    direction?: string;
+    /**
+     * Billable duration in seconds. Null while the call is live
+     */
+    duration_seconds?: number | null;
+    /**
+     * When the call ended (UTC). Null while the call is live
+     */
+    ended_at?: string | null;
+    /**
+     * Why the call did not complete: callback_timeout, invalid_answer,
+     * insufficient_balance, destination_blocked, rejected or no_answer. Null while the
+     * call is live, when it completed, and when it failed without a recorded reason
+     */
+    failure_reason?: string | null;
+    /**
+     * One end of a call
+     */
+    from?: CallParty;
+    /**
+     * Your number that owns the call, in E.164 format: the dialed number for an
+     * inbound call, the caller's bound number for a call placed from your app
+     */
+    number?: string;
+    /**
+     * What the call cost. Null until it has been priced
+     */
+    price?: number | null;
+    /**
+     * True once a recording of the call is available
+     */
+    recording_available?: boolean;
+    /**
+     * When the call was placed (UTC)
+     */
+    started_at?: string;
+    /**
+     * initiated, ringing, answered, completed, failed, no_answer or rejected
+     */
+    status?: string;
+    /**
+     * When the call entered each status, oldest first. Only returned when reading one
+     * call
+     */
+    timeline?: Array<CallTimelineEntry> | null;
+    /**
+     * One end of a call
+     */
+    to?: CallParty;
+}
+/**
+ * One end of a call
+ */
+export interface CallParty {
+    /**
+     * user for one of your app users, number for a phone number, conference for a
+     * room, anonymous for a caller who withheld their number
+     */
+    kind?: string;
+    /**
+     * The app user's identity, the phone number in E.164 format, or the room name.
+     * Null when the kind is anonymous
+     */
+    value?: string | null;
+}
+/**
+ * A short-lived link to a call recording
+ */
+export interface CallRecording {
+    /**
+     * A pre-signed link that downloads the recording as an MP3 file. Anyone holding it
+     * can download the recording until it expires
+     */
+    download_url?: string;
+    /**
+     * The recording's id, the one the call.recording_ready webhook announced it under
+     */
+    recording_id?: string;
+    /**
+     * When the link stops working (UTC). Request the recordings again for a fresh link
+     */
+    url_expires_at?: string;
+}
+/**
+ * The recordings of a call, each as a short-lived download link
+ */
+export interface CallRecordings {
+    /**
+     * Every recording of the call, oldest first. Empty until the first
+     * call.recording_ready webhook has been sent, and for a call that was never
+     * recorded
+     */
+    recordings?: Array<CallRecording>;
+}
+/**
+ * When a call entered a status
+ */
+export interface CallTimelineEntry {
+    /**
+     * initiated, ringing, answered, completed, failed, no_answer or rejected
+     */
+    status?: string;
+    /**
+     * When the call entered this status (UTC)
+     */
+    timestamp?: string;
+}
+/**
+ * Paginated list of calls
+ */
+export interface CallsList {
+    /**
+     * The calls on this page, most recent first
+     */
+    calls?: Array<Call>;
+    /**
+     * Pagination metadata for list responses
+     */
+    pagination?: WebhooksAPI.PaginationMeta;
+}
+export interface CallRetrieveParams {
+    /**
+     * Profile UUID to scope the request to a child profile. Only organization API keys
+     * can use this header. The profile must belong to the calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface CallListParams extends CallsPageParams {
+    /**
+     * Query param: Optional direction filter: outbound for calls placed from your app,
+     * inbound for calls to one of your numbers
+     */
+    direction?: string | null;
+    /**
+     * Query param: Only calls started at or after this time (ISO 8601)
+     */
+    from?: string | null;
+    /**
+     * Query param: Optional filter on the number that owns the call, one of your
+     * voice-enabled numbers in E.164 format
+     */
+    number?: string | null;
+    /**
+     * Query param: Optional status filter: initiated, ringing, answered, completed,
+     * failed, no_answer or rejected
+     */
+    status?: string | null;
+    /**
+     * Query param: Only calls started at or before this time (ISO 8601)
+     */
+    to?: string | null;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface CallHangupParams {
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface CallListRecordingsParams {
+    /**
+     * Profile UUID to scope the request to a child profile. Only organization API keys
+     * can use this header. The profile must belong to the calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface CallRecordParams {
+    /**
+     * Body param: start to begin recording, stop to end it
+     */
+    action?: string;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export declare namespace Calls {
+    export { type APIResponseOfCall as APIResponseOfCall, type APIResponseOfCallRecordings as APIResponseOfCallRecordings, type APIResponseOfCallsList as APIResponseOfCallsList, type Call as Call, type CallParty as CallParty, type CallRecording as CallRecording, type CallRecordings as CallRecordings, type CallTimelineEntry as CallTimelineEntry, type CallsList as CallsList, type CallsCallsPage as CallsCallsPage, type CallRetrieveParams as CallRetrieveParams, type CallListParams as CallListParams, type CallHangupParams as CallHangupParams, type CallListRecordingsParams as CallListRecordingsParams, type CallRecordParams as CallRecordParams, };
+    export { Participants as Participants, type APIResponseOfListOfCallParticipant as APIResponseOfListOfCallParticipant, type CallParticipant as CallParticipant, type CallParticipantTarget as CallParticipantTarget, type ParticipantUpdateParams as ParticipantUpdateParams, type ParticipantListParams as ParticipantListParams, type ParticipantAddParams as ParticipantAddParams, type ParticipantRemoveParams as ParticipantRemoveParams, type ParticipantRemoveAllParams as ParticipantRemoveAllParams, };
+}
+//# sourceMappingURL=calls.d.ts.map

package/resources/calls/calls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calls.d.ts","sourceRoot":"","sources":["../../src/resources/calls/calls.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,WAAW,uBAAoB;AAC3C,OAAO,KAAK,eAAe,0BAAuB;AAClD,OAAO,EACL,kCAAkC,EAClC,eAAe,EACf,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,0BAA0B,EAC1B,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,EACb,0BAAuB;AACxB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,WAAW,EAAE,iCAA8B;AAErF,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;;;;;GAMG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,YAAY,EAAE,eAAe,CAAC,YAAY,CAAkD;IAE5F;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAWhC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,MAAM,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,IAAI,CAAC;IAYpC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAgBxF;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAW1C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAezF;AAED,MAAM,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,EAAE,CAAC,EAAE,SAAS,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;CACzC;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/calls/calls.js

@@ -0,0 +1,158 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Calls = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const ParticipantsAPI = tslib_1.__importStar(require("./participants.js"));
+const participants_1 = require("./participants.js");
+const pagination_1 = require("../../core/pagination.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Phone calls from the numbers you hold, driven by your own callback URL.
+ *
+ * `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent asks what to do with each call on it, and `POST /v3/channels/voice/tokens` mints a short-lived token that lets a user of your app place and receive calls as that number. When a call arrives or a caller presses a key, a signed question is POSTed to the callback URL and the answer decides the call; `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need before a real call reaches it, and `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret. The call events themselves (`call.completed` and the rest) arrive through your webhooks.
+ *
+ * Every call is a record under `/v3/calls`: read it, list its recordings once one is ready, hang it up, start or stop recording, and add, mute or remove conference participants while it is live. A leg to a phone number runs for at most what your balance affords at the destination's rate.
+ */
+class Calls extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.participants = new ParticipantsAPI.Participants(this._client);
+    }
+    /**
+     * Retrieves one of your calls by id: the parties, the owning number, the current
+     * status with its failure reason, duration, price, recording availability, and a
+     * timeline of when the call entered each status.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfCall = await client.calls.retrieve(
+     *   'call_9f2ab000-0000-4000-8000-000000000001',
+     * );
+     * ```
+     */
+    retrieve(id, params = {}, options) {
+        const { 'x-profile-id': xProfileID } = params ?? {};
+        return this._client.get((0, path_1.path) `/v3/calls/${id}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves a paginated list of your calls, most recent first. Filter by
+     * direction, status, the owning number, and the time the call started (from and to
+     * are inclusive). Use the call webhooks for real-time updates; this list is for
+     * looking calls up afterwards.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const call of client.calls.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'x-profile-id': xProfileID, ...query } = params ?? {};
+        return this._client.getAPIList('/v3/calls', (pagination_1.CallsPage), {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Ends one of your live calls. The call then ends the way any other call does: its
+     * status moves to completed and call.completed is sent once the disconnect is
+     * reported. A call that has already ended answers 409, and so does a call with no
+     * phone leg, such as one between two app users.
+     *
+     * @example
+     * ```ts
+     * await client.calls.hangup(
+     *   'call_9f2ab000-0000-4000-8000-000000000001',
+     * );
+     * ```
+     */
+    hangup(id, params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+        return this._client.post((0, path_1.path) `/v3/calls/${id}/hangup`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    Accept: '*/*',
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns pre-signed links to the recordings of one of your calls, each valid
+     * until its url_expires_at. A recording appears once the call was recorded, by a
+     * connect answer with record set, a startRecording instruction or the recordings
+     * command, and the call.recording_ready webhook has been sent; until then, and for
+     * a call that was never recorded, the list is empty. A call recorded more than
+     * once lists every recording, oldest first, each under the recording_id its
+     * call.recording_ready webhook carried.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfCallRecordings =
+     *   await client.calls.listRecordings(
+     *     'call_9f2ab000-0000-4000-8000-000000000001',
+     *   );
+     * ```
+     */
+    listRecordings(id, params = {}, options) {
+        const { 'x-profile-id': xProfileID } = params ?? {};
+        return this._client.get((0, path_1.path) `/v3/calls/${id}/recordings`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Starts or stops recording one of your live calls. Use start to begin recording
+     * mid-call, or stop to end a recording, whether it was started here or by a
+     * connect answer with record set. A call that has already ended answers 409, and
+     * so does a call with no phone leg, such as one between two app users, which can't
+     * be recorded.
+     *
+     * @example
+     * ```ts
+     * await client.calls.record(
+     *   'call_9f2ab000-0000-4000-8000-000000000001',
+     * );
+     * ```
+     */
+    record(id, params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+        return this._client.post((0, path_1.path) `/v3/calls/${id}/recordings`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    Accept: '*/*',
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Calls = Calls;
+Calls.Participants = participants_1.Participants;
+//# sourceMappingURL=calls.js.map

package/resources/calls/calls.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calls.js","sourceRoot":"","sources":["../../src/resources/calls/calls.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,2EAAkD;AAClD,oDAUwB;AAExB,yDAAqF;AACrF,uDAAsD;AAEtD,uDAAiD;AAEjD;;;;;;GAMG;AACH,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAoJ9F,CAAC;IAlJC;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE;YAC7C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,SAA4C,EAAE,EAC9C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,sBAAe,CAAA,EAAE;YAC3D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,MAAwB,EAAE,OAAwB;QACnE,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,SAAS,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,MAAM,EAAE,KAAK;oBACb,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CACZ,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,aAAa,EAAE;YACxD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,MAAwB,EAAE,OAAwB;QACnE,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,aAAa,EAAE;YACzD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,MAAM,EAAE,KAAK;oBACb,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AArJD,sBAqJC;AAuVD,KAAK,CAAC,YAAY,GAAG,2BAAY,CAAC"}