@sentdm/sentdm 0.41.0 → 0.42.0

package/resources/calls/calls.mjs

@@ -0,0 +1,153 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as ParticipantsAPI from "./participants.mjs";
+import { Participants, } from "./participants.mjs";
+import { CallsPage } from "../../core/pagination.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * 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 class Calls extends 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(path `/v3/calls/${id}`, {
+            ...options,
+            headers: 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', (CallsPage), {
+            query,
+            ...options,
+            headers: 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(path `/v3/calls/${id}/hangup`, {
+            body,
+            ...options,
+            headers: 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(path `/v3/calls/${id}/recordings`, {
+            ...options,
+            headers: 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(path `/v3/calls/${id}/recordings`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    Accept: '*/*',
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+Calls.Participants = Participants;
+//# sourceMappingURL=calls.mjs.map

package/resources/calls/calls.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"calls.mjs","sourceRoot":"","sources":["../../src/resources/calls/calls.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,eAAe,2BAAuB;AAClD,OAAO,EASL,YAAY,GACb,2BAAuB;AAExB,OAAO,EAAE,SAAS,EAAqC,kCAA8B;AACrF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;;;;;GAMG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;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,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE;YAC7C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;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,SAAe,CAAA,EAAE;YAC3D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;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,IAAI,CAAA,aAAa,EAAE,SAAS,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;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,IAAI,CAAA,aAAa,EAAE,aAAa,EAAE;YACxD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;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,IAAI,CAAA,aAAa,EAAE,aAAa,EAAE;YACzD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;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;AAuVD,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC"}

package/resources/calls/index.d.mts

@@ -0,0 +1,3 @@
+export { Calls, type APIResponseOfCall, type APIResponseOfCallRecordings, type APIResponseOfCallsList, type Call, type CallParty, type CallRecording, type CallRecordings, type CallTimelineEntry, type CallsList, type CallRetrieveParams, type CallListParams, type CallHangupParams, type CallListRecordingsParams, type CallRecordParams, type CallsCallsPage, } from "./calls.mjs";
+export { Participants, type APIResponseOfListOfCallParticipant, type CallParticipant, type CallParticipantTarget, type ParticipantUpdateParams, type ParticipantListParams, type ParticipantAddParams, type ParticipantRemoveParams, type ParticipantRemoveAllParams, } from "./participants.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/calls/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/calls/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,EAChC,KAAK,sBAAsB,EAC3B,KAAK,IAAI,EACT,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,SAAS,EACd,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,cAAc,GACpB,oBAAgB;AACjB,OAAO,EACL,YAAY,EACZ,KAAK,kCAAkC,EACvC,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,GAChC,2BAAuB"}

package/resources/calls/index.d.ts

@@ -0,0 +1,3 @@
+export { Calls, type APIResponseOfCall, type APIResponseOfCallRecordings, type APIResponseOfCallsList, type Call, type CallParty, type CallRecording, type CallRecordings, type CallTimelineEntry, type CallsList, type CallRetrieveParams, type CallListParams, type CallHangupParams, type CallListRecordingsParams, type CallRecordParams, type CallsCallsPage, } from "./calls.js";
+export { Participants, type APIResponseOfListOfCallParticipant, type CallParticipant, type CallParticipantTarget, type ParticipantUpdateParams, type ParticipantListParams, type ParticipantAddParams, type ParticipantRemoveParams, type ParticipantRemoveAllParams, } from "./participants.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/calls/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,EAChC,KAAK,sBAAsB,EAC3B,KAAK,IAAI,EACT,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,SAAS,EACd,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,cAAc,GACpB,mBAAgB;AACjB,OAAO,EACL,YAAY,EACZ,KAAK,kCAAkC,EACvC,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,GAChC,0BAAuB"}

package/resources/calls/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Participants = exports.Calls = void 0;
+var calls_1 = require("./calls.js");
+Object.defineProperty(exports, "Calls", { enumerable: true, get: function () { return calls_1.Calls; } });
+var participants_1 = require("./participants.js");
+Object.defineProperty(exports, "Participants", { enumerable: true, get: function () { return participants_1.Participants; } });
+//# sourceMappingURL=index.js.map

package/resources/calls/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/calls/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oCAiBiB;AAhBf,8FAAA,KAAK,OAAA;AAiBP,kDAUwB;AATtB,4GAAA,YAAY,OAAA"}

package/resources/calls/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Calls, } from "./calls.mjs";
+export { Participants, } from "./participants.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/calls/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/calls/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,KAAK,GAgBN,oBAAgB;AACjB,OAAO,EACL,YAAY,GASb,2BAAuB"}

package/resources/calls/participants.d.mts

@@ -0,0 +1,258 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as WebhooksAPI from "../webhooks.mjs";
+import * as CallsAPI from "./calls.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * 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 Participants extends APIResource {
+    /**
+     * Mutes or unmutes one participant of the conference room a live call is in, named
+     * by the participant's own call id from the participants list: send muted true to
+     * silence them, muted false to let them be heard again. Muting a participant who
+     * is already muted succeeds, as does unmuting one who is not. A participant who is
+     * not in this call's room answers 404. A call that has ended answers 409, as does
+     * a call that is not in a conference.
+     *
+     * @example
+     * ```ts
+     * await client.calls.participants.update(
+     *   'call_9f2ab000-0000-4000-8000-000000000002',
+     *   { id: 'call_9f2ab000-0000-4000-8000-000000000001' },
+     * );
+     * ```
+     */
+    update(participantID: string, params: ParticipantUpdateParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Lists who is in the conference room one of your live calls is in: each
+     * participant's own call id, who they are, whether the room mutes them, and how
+     * long they have been connected. The call itself is one of the participants. Use a
+     * participant's id to mute or remove them; it is also a call id, so GET
+     * /v3/calls/{id} accepts it. A call that has ended answers 409, as does a call
+     * that is not in a conference.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfListOfCallParticipant =
+     *   await client.calls.participants.list(
+     *     'call_9f2ab000-0000-4000-8000-000000000001',
+     *   );
+     * ```
+     */
+    list(id: string, params?: ParticipantListParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfListOfCallParticipant>;
+    /**
+     * Dials one of your app users or a phone number into a call that is in a
+     * conference room, and answers with the participant's own call record. The
+     * participant is a call of their own: it has its own id, can be looked up and hung
+     * up, and is billed and reported through call.completed and call.failed like any
+     * other call. A phone participant is called from caller_id, which must be one of
+     * your numbers, or from the call's owning number when omitted, and needs a
+     * destination you may call and a positive balance. Only a call your answer
+     * connected to a conference can take participants: a call connected to a user or a
+     * number answers 409.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfCall =
+     *   await client.calls.participants.add(
+     *     'call_9f2ab000-0000-4000-8000-000000000001',
+     *   );
+     * ```
+     */
+    add(id: string, params: ParticipantAddParams, options?: RequestOptions): APIPromise<CallsAPI.APIResponseOfCall>;
+    /**
+     * Removes one participant from the conference room a live call is in, named by the
+     * participant's own call id from the participants list. Their leg ends and is
+     * reported through call.completed like any other call; everyone else stays
+     * connected. A participant who is not in this call's room answers 404. A call that
+     * has ended answers 409, as does a call that is not in a conference.
+     *
+     * @example
+     * ```ts
+     * await client.calls.participants.remove(
+     *   'call_9f2ab000-0000-4000-8000-000000000002',
+     *   { id: 'call_9f2ab000-0000-4000-8000-000000000001' },
+     * );
+     * ```
+     */
+    remove(participantID: string, params: ParticipantRemoveParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Removes every participant from the conference room a live call is in, the call
+     * itself included. Every leg ends and is reported through call.completed like any
+     * other call. A room that is already empty answers 204 as well. A call that has
+     * ended answers 409, as does a call that is not in a conference.
+     *
+     * @example
+     * ```ts
+     * await client.calls.participants.removeAll(
+     *   'call_9f2ab000-0000-4000-8000-000000000001',
+     * );
+     * ```
+     */
+    removeAll(id: string, params: ParticipantRemoveAllParams, options?: RequestOptions): APIPromise<void>;
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfListOfCallParticipant {
+    /**
+     * The response data (null if error)
+     */
+    data?: Array<CallParticipant> | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+/**
+ * A participant of a conference call
+ */
+export interface CallParticipant {
+    /**
+     * The participant's own call id: what the mute and remove endpoints take, and what
+     * GET /v3/calls/{id} accepts
+     */
+    id?: string;
+    /**
+     * How long the participant has been connected to the room, in seconds
+     */
+    duration_seconds?: number;
+    /**
+     * user for one of your app users, number for a phone number, anonymous for a
+     * caller who withheld their number
+     */
+    kind?: string;
+    /**
+     * True while the room mutes this participant
+     */
+    muted?: boolean;
+    /**
+     * The app user's identity or the phone number in E.164 format. Null when the kind
+     * is anonymous
+     */
+    value?: string | null;
+}
+/**
+ * A participant to add to a call
+ */
+export interface CallParticipantTarget {
+    /**
+     * user for one of your app users, number for a phone number
+     */
+    kind?: string;
+    /**
+     * The app user's identity, or the phone number in E.164 format
+     */
+    value?: string;
+}
+export interface ParticipantUpdateParams {
+    /**
+     * Path param: The call id from the route, as carried by call webhooks and the
+     * calls list, for example call_9f2ab000-0000-4000-8000-000000000001
+     */
+    id: string;
+    /**
+     * Body param: true to mute the participant, false to unmute them
+     */
+    muted?: boolean;
+    /**
+     * 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 ParticipantListParams {
+    /**
+     * 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 ParticipantAddParams {
+    /**
+     * Body param: The number shown to a phone participant as the caller, in E.164
+     * format. Must be one of your numbers. The call's owning number when omitted
+     */
+    caller_id?: string | null;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Body param: A participant to add to a call
+     */
+    to?: CallParticipantTarget;
+    /**
+     * 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 ParticipantRemoveParams {
+    /**
+     * Path param: The call id from the route, as carried by call webhooks and the
+     * calls list, for example call_9f2ab000-0000-4000-8000-000000000001
+     */
+    id: 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: 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 ParticipantRemoveAllParams {
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * 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 Participants {
+    export { 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=participants.d.mts.map

package/resources/calls/participants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"participants.d.mts","sourceRoot":"","sources":["../../src/resources/calls/participants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,WAAW,wBAAoB;AAC3C,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAgB1G;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;IAWjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CACD,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IAezC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAY1G;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAWtG;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC;IAErC;;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,eAAe;IAC9B;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,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;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,EAAE,CAAC,EAAE,qBAAqB,CAAC;IAE3B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,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"}