@polymorfa/sdk 0.1.0-dev.20260923101121 → 0.1.0-dev.20260923115248

package/dist/platform/audiences.js

@@ -1,4 +1,5 @@
 import { HttpTransport } from "../transport/http.js";
+import { withoutAutomaticRetry } from "../transport/idempotency.js";
 export class AudiencesResource {
     transport;
     constructor(transport) {
@@ -11,8 +12,55 @@ export class AudiencesResource {
             ...options,
         });
     }
+    /**
+     * Create an audience from inline `members`, or from an uploaded spreadsheet
+     * with `fileId` and `mapping`. The result carries the import counts and up
+     * to 20 rejected rows.
+     */
     create(body, options = {}) {
-        return this.write("/platform/audiences", body, options);
+        return this.transport.request({
+            method: "POST",
+            path: "/platform/audiences",
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Append up to 1,000 members to an existing audience.
+     *
+     * The API declares no idempotent replay for this append, so by default the
+     * SDK sends it once and does not retry it. Setting both `maxNetworkRetries`
+     * and `idempotencyKey` on the request re-enables retries, and a retry can be
+     * processed as a new append. After a lost response, list the members before
+     * appending again.
+     */
+    addMembers(listId, body, options = {}) {
+        return this.transport.request({
+            method: "POST",
+            path: membersPath(listId),
+            body,
+            ...withoutAutomaticRetry(options),
+        });
+    }
+    /** One cursor page of an audience's members. */
+    listMembers(listId, params = {}, options = {}) {
+        return this.transport.request({
+            method: "GET",
+            path: membersPath(listId),
+            query: {
+                ...(params.cursor === undefined ? {} : { cursor: params.cursor }),
+                ...(params.limit === undefined ? {} : { limit: params.limit }),
+            },
+            ...options,
+        });
+    }
+    /** Remove one member by phone number. */
+    deleteMember(listId, phone, options = {}) {
+        return this.transport.request({
+            method: "DELETE",
+            path: `${membersPath(listId)}/${encodeURIComponent(phone)}`,
+            ...options,
+        });
     }
     retrieve(listId, options = {}) {
         return this.transport.request({
@@ -43,4 +91,7 @@ export class AudiencesResource {
 function audiencePath(listId) {
     return `/platform/audiences/${encodeURIComponent(listId)}`;
 }
+function membersPath(listId) {
+    return `${audiencePath(listId)}/members`;
+}
 //# sourceMappingURL=audiences.js.map

package/dist/platform/audiences.js.map

@@ -1 +1 @@
-{"version":3,"file":"audiences.js","sourceRoot":"","sources":["../../src/platform/audiences.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAMrD,MAAM,OAAO,iBAAiB;IACC;IAA7B,YAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;IAAG,CAAC;IAEzD,IAAI,CAAC,UAA0B,EAAE;QAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB;YAC3B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CACJ,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,KAAK,CAAC,qBAAqB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,QAAQ,CAAC,MAAc,EAAE,UAA0B,EAAE;QACnD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,UAA0B,EAAE;QACjD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,YAAY,CACV,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,KAAK,CAAC,6BAA6B,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAEO,KAAK,CACX,IAAY,EACZ,IAAiC,EACjC,OAAuB;QAEvB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;YACvC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,SAAS,YAAY,CAAC,MAAc;IAClC,OAAO,uBAAuB,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;AAC7D,CAAC"}
+{"version":3,"file":"audiences.js","sourceRoot":"","sources":["../../src/platform/audiences.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAgBpE,MAAM,OAAO,iBAAiB;IACC;IAA7B,YAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;IAAG,CAAC;IAEzD,IAAI,CAAC,UAA0B,EAAE;QAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB;YAC3B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,IAA2B,EAC3B,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,qBAAqB;YAC3B,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CACR,MAAc,EACd,IAA+B,EAC/B,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;YACzB,IAAI;YACJ,GAAG,qBAAqB,CAAC,OAAO,CAAC;SAClC,CAAC,CAAC;IACL,CAAC;IAED,gDAAgD;IAChD,WAAW,CACT,MAAc,EACd,SAAoC,EAAE,EACtC,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;YACzB,KAAK,EAAE;gBACL,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;gBACjE,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;aAC/D;YACD,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,yCAAyC;IACzC,YAAY,CACV,MAAc,EACd,KAAa,EACb,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE;YAC3D,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,MAAc,EAAE,UAA0B,EAAE;QACnD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,UAA0B,EAAE;QACjD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,YAAY,CACV,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,KAAK,CAAC,6BAA6B,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAEO,KAAK,CACX,IAAY,EACZ,IAAiC,EACjC,OAAuB;QAEvB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;YACvC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,SAAS,YAAY,CAAC,MAAc;IAClC,OAAO,uBAAuB,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;AAC7D,CAAC;AAED,SAAS,WAAW,CAAC,MAAc;IACjC,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC;AAC3C,CAAC"}

package/dist/platform/call-retention.d.ts

@@ -0,0 +1,86 @@
+import { HttpTransport } from "../transport/http.js";
+import { type ClientCredential, type SharedClientOptions } from "../credentials.js";
+import type { ApiResponse, RequestOptions } from "../transport/types.js";
+/**
+ * How long Polymorfa keeps a team's call data: `short` (7 days), `standard`
+ * (30 days), `extended` (90 days, the default), `compliance` (365 days), or
+ * `custom` (the number of days in `retentionDays`).
+ */
+export type CallRetentionPolicy = "short" | "standard" | "extended" | "compliance" | "custom";
+/** A team's call data retention. */
+export interface CallRetention {
+    readonly policy: CallRetentionPolicy;
+    /**
+     * Days Polymorfa keeps the team's call data, from 1 to 2555. Deletion of
+     * older call data starts on a date Polymorfa announces; until then the
+     * setting records a choice and nothing is deleted. Defaults to 90.
+     */
+    readonly retentionDays: number;
+    /**
+     * The call data the period applies to, such as `call_records`,
+     * `call_events`, and `client_reports`. New kinds of call data are added to
+     * this list and follow the same period.
+     */
+    readonly appliesTo: readonly string[];
+    /** Increases on every change; 0 while the team uses the default. */
+    readonly revision: number;
+    /** When the setting last changed, or `null` while the team uses the default. */
+    readonly updatedAt: string | null;
+}
+interface UpdateCallRetentionFields {
+    /**
+     * Apply the update only if the setting still has this `revision` (0 for a
+     * team on the default). Otherwise the update fails with `state_conflict`.
+     * Omit it to apply the update without a revision check (last write wins).
+     */
+    readonly expectedRevision?: number;
+}
+/**
+ * A new call data retention. `custom` requires `retentionDays`; a named
+ * policy sets its own period, so `retentionDays` is optional there.
+ */
+export type UpdateCallRetentionRequest = (UpdateCallRetentionFields & {
+    /** Keep call data for the number of days in `retentionDays`. */
+    readonly policy: "custom";
+    /** A whole number of days from 1 to 2555. */
+    readonly retentionDays: number;
+}) | (UpdateCallRetentionFields & {
+    /** A named policy sets its own period. */
+    readonly policy: Exclude<CallRetentionPolicy, "custom">;
+    /**
+     * Omit it or send exactly that policy's period; any other value fails
+     * with `invalid_parameter`.
+     */
+    readonly retentionDays?: number;
+});
+/** A team-wide retention request does not need a project ID, even for a project token. */
+export interface TeamCallRetentionClientOptions extends SharedClientOptions {
+    readonly credential: ClientCredential;
+}
+/**
+ * Creates only the team-wide call retention resource. Use this entrypoint
+ * when a project token has no project ID; project-scoped Client methods still
+ * require an explicit project ID.
+ */
+export declare function createTeamCallRetentionClient(options: TeamCallRetentionClientOptions): CallRetentionResource;
+/**
+ * The team's call data retention. It is one setting per team: project clients
+ * read the same value as their team. Changing it requires a team API key.
+ */
+export declare class CallRetentionResource {
+    private readonly transport;
+    constructor(transport: HttpTransport);
+    /** Returns the saved setting, or the default when the team never saved one. */
+    retrieve(options?: RequestOptions): Promise<ApiResponse<CallRetention>>;
+    /**
+     * Replaces the team's call data retention. Requires a team API key; project
+     * tokens receive `PolymorfaAuthorizationError`.
+     *
+     * Once deletion runs, a shorter period also applies to call data already
+     * stored, and deleted data cannot be recovered. Until Polymorfa announces
+     * that deletion has started, saving a period deletes nothing.
+     */
+    update(input: UpdateCallRetentionRequest, options?: RequestOptions): Promise<ApiResponse<CallRetention>>;
+}
+export {};
+//# sourceMappingURL=call-retention.d.ts.map

package/dist/platform/call-retention.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"call-retention.d.ts","sourceRoot":"","sources":["../../src/platform/call-retention.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAGL,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAGzE;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC7B,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,GAAG,QAAQ,CAAC;AAE9D,oCAAoC;AACpC,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IACtC,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,gFAAgF;IAChF,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,UAAU,yBAAyB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAClC,CAAC,yBAAyB,GAAG;IAC3B,gEAAgE;IAChE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC1B,6CAA6C;IAC7C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAChC,CAAC,GACF,CAAC,yBAAyB,GAAG;IAC3B,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IACxD;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC,CAAC;AAIP,0FAA0F;AAC1F,MAAM,WAAW,8BAA+B,SAAQ,mBAAmB;IACzE,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC;CACvC;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,8BAA8B,GACtC,qBAAqB,CAevB;AAED;;;GAGG;AACH,qBAAa,qBAAqB;IACpB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,aAAa;IAErD,+EAA+E;IAC/E,QAAQ,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IAU3E;;;;;;;OAOG;IACH,MAAM,CACJ,KAAK,EAAE,0BAA0B,EACjC,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;CAUvC"}

package/dist/platform/call-retention.js

@@ -0,0 +1,62 @@
+import { HttpTransport } from "../transport/http.js";
+import { assertServerRuntime, validateClientCredential, } from "../credentials.js";
+import { unwrapResponse } from "./response.js";
+const PATH = "/platform/call-retention";
+/**
+ * Creates only the team-wide call retention resource. Use this entrypoint
+ * when a project token has no project ID; project-scoped Client methods still
+ * require an explicit project ID.
+ */
+export function createTeamCallRetentionClient(options) {
+    const credential = validateClientCredential(options.credential);
+    assertServerRuntime();
+    return new CallRetentionResource(new HttpTransport({
+        baseUrl: options.baseUrl ?? "https://api.polymorfa.com",
+        authorization: `Bearer ${credential.value}`,
+        timeoutMs: options.timeoutMs ?? 30_000,
+        maxNetworkRetries: options.maxNetworkRetries ?? 2,
+        ...(options.apiVersion === undefined
+            ? {}
+            : { apiVersion: options.apiVersion }),
+        ...(options.fetch === undefined ? {} : { fetch: options.fetch }),
+    }));
+}
+/**
+ * The team's call data retention. It is one setting per team: project clients
+ * read the same value as their team. Changing it requires a team API key.
+ */
+export class CallRetentionResource {
+    transport;
+    constructor(transport) {
+        this.transport = transport;
+    }
+    /** Returns the saved setting, or the default when the team never saved one. */
+    retrieve(options = {}) {
+        return this.transport
+            .request({
+            method: "GET",
+            path: PATH,
+            ...options,
+        })
+            .then(unwrapResponse);
+    }
+    /**
+     * Replaces the team's call data retention. Requires a team API key; project
+     * tokens receive `PolymorfaAuthorizationError`.
+     *
+     * Once deletion runs, a shorter period also applies to call data already
+     * stored, and deleted data cannot be recovered. Until Polymorfa announces
+     * that deletion has started, saving a period deletes nothing.
+     */
+    update(input, options = {}) {
+        return this.transport
+            .request({
+            method: "PUT",
+            path: PATH,
+            body: input,
+            ...options,
+        })
+            .then(unwrapResponse);
+    }
+}
+//# sourceMappingURL=call-retention.js.map

package/dist/platform/call-retention.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"call-retention.js","sourceRoot":"","sources":["../../src/platform/call-retention.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EACL,mBAAmB,EACnB,wBAAwB,GAGzB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAqB,cAAc,EAAE,MAAM,eAAe,CAAC;AA6DlE,MAAM,IAAI,GAAG,0BAA0B,CAAC;AAOxC;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAC3C,OAAuC;IAEvC,MAAM,UAAU,GAAG,wBAAwB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAChE,mBAAmB,EAAE,CAAC;IACtB,OAAO,IAAI,qBAAqB,CAC9B,IAAI,aAAa,CAAC;QAChB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,2BAA2B;QACvD,aAAa,EAAE,UAAU,UAAU,CAAC,KAAK,EAAE;QAC3C,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,MAAM;QACtC,iBAAiB,EAAE,OAAO,CAAC,iBAAiB,IAAI,CAAC;QACjD,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS;YAClC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC;QACvC,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;KACjE,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IACH;IAA7B,YAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;IAAG,CAAC;IAEzD,+EAA+E;IAC/E,QAAQ,CAAC,UAA0B,EAAE;QACnC,OAAO,IAAI,CAAC,SAAS;aAClB,OAAO,CAA8B;YACpC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,GAAG,OAAO;SACX,CAAC;aACD,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,KAAiC,EACjC,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS;aAClB,OAAO,CAA8B;YACpC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,KAAK;YACX,GAAG,OAAO;SACX,CAAC;aACD,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1B,CAAC;CACF"}

package/dist/platform/campaigns.d.ts

@@ -1,15 +1,20 @@
 import { HttpTransport } from "../transport/http.js";
 import type { ApiResponse, RequestOptions } from "../transport/types.js";
-import type { DataEnvelope, ListCampaignsParams, PlatformPayload } from "./types.js";
+import type { AddPlatformCampaignRecipientsRequest, AddPlatformCampaignRecipientsResult, CreatePlatformCampaignRequest, DataEnvelope, ListCampaignsParams, ListPlatformCampaignRecipientsParams, PlatformCampaignParams, PlatformCampaignRecipientsEnvelope, PlatformPayload, UpdatePlatformCampaignRequest } from "./types.js";
 type CampaignResponse = Promise<ApiResponse<DataEnvelope<PlatformPayload>>>;
 export declare class CampaignsResource {
     private readonly transport;
     constructor(transport: HttpTransport);
     list(params: ListCampaignsParams, options?: RequestOptions): CampaignResponse;
-    create(body?: PlatformPayload, options?: RequestOptions): CampaignResponse;
-    retrieve(campaignId: string, options?: RequestOptions): CampaignResponse;
-    update(campaignId: string, body?: PlatformPayload, options?: RequestOptions): CampaignResponse;
-    delete(campaignId: string, options?: RequestOptions): CampaignResponse;
+    create(body: CreatePlatformCampaignRequest, options?: RequestOptions): CampaignResponse;
+    retrieve(campaignId: string, params: PlatformCampaignParams, options?: RequestOptions): CampaignResponse;
+    /**
+     * Change a campaign. `recipientListId` points an unlaunched draft at another
+     * audience, or detaches it with null; the API refuses the change once the
+     * campaign has launched or its audience has been copied into recipients.
+     */
+    update(campaignId: string, body: UpdatePlatformCampaignRequest | undefined, params: PlatformCampaignParams, options?: RequestOptions): CampaignResponse;
+    delete(campaignId: string, params: PlatformCampaignParams, options?: RequestOptions): CampaignResponse;
     launch(campaignId: string, body?: PlatformPayload, options?: RequestOptions): CampaignResponse;
     pause(campaignId: string, body?: PlatformPayload, options?: RequestOptions): CampaignResponse;
     resume(campaignId: string, body?: PlatformPayload, options?: RequestOptions): CampaignResponse;
@@ -17,9 +22,25 @@ export declare class CampaignsResource {
     archive(campaignId: string, body?: PlatformPayload, options?: RequestOptions): CampaignResponse;
     duplicate(campaignId: string, body?: PlatformPayload, options?: RequestOptions): CampaignResponse;
     requeue(campaignId: string, body?: PlatformPayload, options?: RequestOptions): CampaignResponse;
-    analytics(campaignId: string, options?: RequestOptions): CampaignResponse;
-    events(campaignId: string, options?: RequestOptions): CampaignResponse;
-    recipients(campaignId: string, options?: RequestOptions): CampaignResponse;
+    analytics(campaignId: string, params: PlatformCampaignParams, options?: RequestOptions): CampaignResponse;
+    events(campaignId: string, params: PlatformCampaignParams, options?: RequestOptions): CampaignResponse;
+    /**
+     * One cursor page of a campaign's recipients in queue order.
+     *
+     * This replaces the earlier bare array: the response is now
+     * `{ data, page }`, and each recipient carries its own delivery timestamps.
+     */
+    recipients(campaignId: string, params: ListPlatformCampaignRecipientsParams, options?: RequestOptions): Promise<ApiResponse<PlatformCampaignRecipientsEnvelope>>;
+    /**
+     * Add up to 1,000 recipients to a campaign that has not started sending.
+     *
+     * The API declares no idempotent replay for this append, so by default the
+     * SDK sends it once and does not retry it. Setting both `maxNetworkRetries`
+     * and `idempotencyKey` on the request re-enables retries, and a retry can be
+     * processed as a new append. After a lost response, list the recipients before
+     * appending again.
+     */
+    addRecipients(campaignId: string, body: AddPlatformCampaignRecipientsRequest, options?: RequestOptions): Promise<ApiResponse<DataEnvelope<AddPlatformCampaignRecipientsResult>>>;
     private action;
     private read;
     private write;

package/dist/platform/campaigns.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../../src/platform/campaigns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,KAAK,EACV,YAAY,EACZ,mBAAmB,EACnB,eAAe,EAChB,MAAM,YAAY,CAAC;AAEpB,KAAK,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;AAK5E,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,aAAa;IAErD,IAAI,CACF,MAAM,EAAE,mBAAmB,EAC3B,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAcnB,MAAM,CACJ,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,gBAAgB;IAQ5E,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,gBAAgB;IAQ1E,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,KAAK,CACH,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,OAAO,CACL,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,OAAO,CACL,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,gBAAgB;IAI1E,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,OAAO,CAAC,MAAM;IAcd,OAAO,CAAC,IAAI;IAYZ,OAAO,CAAC,KAAK;CAad"}
+{"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../../src/platform/campaigns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAKrD,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,KAAK,EACV,oCAAoC,EACpC,mCAAmC,EACnC,6BAA6B,EAC7B,YAAY,EACZ,mBAAmB,EACnB,oCAAoC,EACpC,sBAAsB,EACtB,kCAAkC,EAClC,eAAe,EACf,6BAA6B,EAC9B,MAAM,YAAY,CAAC;AAEpB,KAAK,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;AAK5E,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,aAAa;IAErD,IAAI,CACF,MAAM,EAAE,mBAAmB,EAC3B,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAcnB,MAAM,CACJ,IAAI,EAAE,6BAA6B,EACnC,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IASnB,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IASnB;;;;OAIG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,6BAA6B,GAAG,SAAS,EAC/C,MAAM,EAAE,sBAAsB,EAC9B,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAUnB,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IASnB,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,KAAK,CACH,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,OAAO,CACL,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,OAAO,CACL,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,GAAE,cAAmB,GAC3B,gBAAgB;IAInB;;;;;OAKG;IACH,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,oCAAoC,EAC5C,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAAC;IAc3D;;;;;;;;OAQG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,oCAAoC,EAC1C,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,mCAAmC,CAAC,CAAC,CAAC;IAS1E,OAAO,CAAC,MAAM;IAmBd,OAAO,CAAC,IAAI;IAcZ,OAAO,CAAC,KAAK;CAad"}

package/dist/platform/campaigns.js

@@ -1,4 +1,5 @@
 import { HttpTransport } from "../transport/http.js";
+import { withIdempotencyKey, withoutAutomaticRetry, } from "../transport/idempotency.js";
 export class CampaignsResource {
     transport;
     constructor(transport) {
@@ -18,22 +19,40 @@ export class CampaignsResource {
         });
     }
     create(body, options = {}) {
-        return this.write("POST", "/platform/campaigns", body, options);
+        return this.transport.request({
+            method: "POST",
+            path: "/platform/campaigns",
+            body,
+            ...options,
+        });
     }
-    retrieve(campaignId, options = {}) {
+    retrieve(campaignId, params, options = {}) {
         return this.transport.request({
             method: "GET",
             path: campaignPath(campaignId),
+            query: campaignQuery(params),
             ...options,
         });
     }
-    update(campaignId, body, options = {}) {
-        return this.write("PATCH", campaignPath(campaignId), body, options);
+    /**
+     * Change a campaign. `recipientListId` points an unlaunched draft at another
+     * audience, or detaches it with null; the API refuses the change once the
+     * campaign has launched or its audience has been copied into recipients.
+     */
+    update(campaignId, body, params, options = {}) {
+        return this.transport.request({
+            method: "PATCH",
+            path: campaignPath(campaignId),
+            query: campaignQuery(params),
+            ...(body === undefined ? {} : { body }),
+            ...options,
+        });
     }
-    delete(campaignId, options = {}) {
+    delete(campaignId, params, options = {}) {
         return this.transport.request({
             method: "DELETE",
             path: campaignPath(campaignId),
+            query: campaignQuery(params),
             ...options,
         });
     }
@@ -58,22 +77,60 @@ export class CampaignsResource {
     requeue(campaignId, body, options = {}) {
         return this.action(campaignId, "requeue", body, options);
     }
-    analytics(campaignId, options = {}) {
-        return this.read(campaignId, "analytics", options);
+    analytics(campaignId, params, options = {}) {
+        return this.read(campaignId, "analytics", params, options);
     }
-    events(campaignId, options = {}) {
-        return this.read(campaignId, "events", options);
+    events(campaignId, params, options = {}) {
+        return this.read(campaignId, "events", params, options);
     }
-    recipients(campaignId, options = {}) {
-        return this.read(campaignId, "recipients", options);
+    /**
+     * One cursor page of a campaign's recipients in queue order.
+     *
+     * This replaces the earlier bare array: the response is now
+     * `{ data, page }`, and each recipient carries its own delivery timestamps.
+     */
+    recipients(campaignId, params, options = {}) {
+        return this.transport.request({
+            method: "GET",
+            path: recipientsPath(campaignId),
+            query: {
+                projectId: params.projectId,
+                ...(params.status === undefined ? {} : { status: params.status }),
+                ...(params.cursor === undefined ? {} : { cursor: params.cursor }),
+                ...(params.limit === undefined ? {} : { limit: params.limit }),
+            },
+            ...options,
+        });
+    }
+    /**
+     * Add up to 1,000 recipients to a campaign that has not started sending.
+     *
+     * The API declares no idempotent replay for this append, so by default the
+     * SDK sends it once and does not retry it. Setting both `maxNetworkRetries`
+     * and `idempotencyKey` on the request re-enables retries, and a retry can be
+     * processed as a new append. After a lost response, list the recipients before
+     * appending again.
+     */
+    addRecipients(campaignId, body, options = {}) {
+        return this.transport.request({
+            method: "POST",
+            path: recipientsPath(campaignId),
+            body,
+            ...withoutAutomaticRetry(options),
+        });
     }
     action(campaignId, action, body, options) {
-        return this.write("POST", `${campaignPath(campaignId)}/${action}`, body, options);
+        const retryable = action === "launch" ||
+            action === "pause" ||
+            action === "resume" ||
+            action === "stop";
+        return this.write("POST", `${campaignPath(campaignId)}/${action}`, body, retryable ? withIdempotencyKey(options) : options);
     }
-    read(campaignId, resource, options) {
+    read(campaignId, resource, params, options) {
         return this.transport.request({
             method: "GET",
             path: `${campaignPath(campaignId)}/${resource}`,
+            query: campaignQuery(params),
             ...options,
         });
     }
@@ -89,4 +146,10 @@ export class CampaignsResource {
 function campaignPath(campaignId) {
     return `/platform/campaigns/${encodeURIComponent(campaignId)}`;
 }
+function campaignQuery(params) {
+    return { projectId: params.projectId };
+}
+function recipientsPath(campaignId) {
+    return `${campaignPath(campaignId)}/recipients`;
+}
 //# sourceMappingURL=campaigns.js.map

package/dist/platform/campaigns.js.map

@@ -1 +1 @@
-{"version":3,"file":"campaigns.js","sourceRoot":"","sources":["../../src/platform/campaigns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAarD,MAAM,OAAO,iBAAiB;IACC;IAA7B,YAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;IAAG,CAAC;IAEzD,IAAI,CACF,MAA2B,EAC3B,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB;YAC3B,KAAK,EAAE;gBACL,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,GAAG,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS;oBAClC,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CACJ,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED,QAAQ,CAAC,UAAkB,EAAE,UAA0B,EAAE;QACvD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC;YAC9B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CACJ,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,CAAC,UAAkB,EAAE,UAA0B,EAAE;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC;YAC9B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CACJ,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CACH,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,CACJ,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,CACF,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,CACL,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,SAAS,CACP,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,CACL,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,SAAS,CACP,UAAkB,EAClB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,CAAC,UAAkB,EAAE,UAA0B,EAAE;QACrD,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,UAAU,CACR,UAAkB,EAClB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAEO,MAAM,CACZ,UAAkB,EAClB,MAAsB,EACtB,IAAiC,EACjC,OAAuB;QAEvB,OAAO,IAAI,CAAC,KAAK,CACf,MAAM,EACN,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,MAAM,EAAE,EACvC,IAAI,EACJ,OAAO,CACR,CAAC;IACJ,CAAC;IAEO,IAAI,CACV,UAAkB,EAClB,QAAsB,EACtB,OAAuB;QAEvB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,QAAQ,EAAE;YAC/C,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CACX,MAAwB,EACxB,IAAY,EACZ,IAAiC,EACjC,OAAuB;QAEvB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM;YACN,IAAI;YACJ,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;YACvC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,SAAS,YAAY,CAAC,UAAkB;IACtC,OAAO,uBAAuB,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;AACjE,CAAC"}
+{"version":3,"file":"campaigns.js","sourceRoot":"","sources":["../../src/platform/campaigns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EACL,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,6BAA6B,CAAC;AAoBrC,MAAM,OAAO,iBAAiB;IACC;IAA7B,YAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;IAAG,CAAC;IAEzD,IAAI,CACF,MAA2B,EAC3B,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB;YAC3B,KAAK,EAAE;gBACL,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,GAAG,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS;oBAClC,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CACJ,IAAmC,EACnC,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,qBAAqB;YAC3B,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CACN,UAAkB,EAClB,MAA8B,EAC9B,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC;YAC9B,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC;YAC5B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,UAAkB,EAClB,IAA+C,EAC/C,MAA8B,EAC9B,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC;YAC9B,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC;YAC5B,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;YACvC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CACJ,UAAkB,EAClB,MAA8B,EAC9B,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC;YAC9B,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC;YAC5B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CACJ,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CACH,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,CACJ,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,CACF,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,CACL,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,SAAS,CACP,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,CACL,UAAkB,EAClB,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,SAAS,CACP,UAAkB,EAClB,MAA8B,EAC9B,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,CACJ,UAAkB,EAClB,MAA8B,EAC9B,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACH,UAAU,CACR,UAAkB,EAClB,MAA4C,EAC5C,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC;YAChC,KAAK,EAAE;gBACL,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;gBACjE,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;gBACjE,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;aAC/D;YACD,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CACX,UAAkB,EAClB,IAA0C,EAC1C,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC;YAChC,IAAI;YACJ,GAAG,qBAAqB,CAAC,OAAO,CAAC;SAClC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CACZ,UAAkB,EAClB,MAAsB,EACtB,IAAiC,EACjC,OAAuB;QAEvB,MAAM,SAAS,GACb,MAAM,KAAK,QAAQ;YACnB,MAAM,KAAK,OAAO;YAClB,MAAM,KAAK,QAAQ;YACnB,MAAM,KAAK,MAAM,CAAC;QACpB,OAAO,IAAI,CAAC,KAAK,CACf,MAAM,EACN,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,MAAM,EAAE,EACvC,IAAI,EACJ,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAClD,CAAC;IACJ,CAAC;IAEO,IAAI,CACV,UAAkB,EAClB,QAAsB,EACtB,MAA8B,EAC9B,OAAuB;QAEvB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,QAAQ,EAAE;YAC/C,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC;YAC5B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CACX,MAAwB,EACxB,IAAY,EACZ,IAAiC,EACjC,OAAuB;QAEvB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM;YACN,IAAI;YACJ,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;YACvC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,SAAS,YAAY,CAAC,UAAkB;IACtC,OAAO,uBAAuB,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;AACjE,CAAC;AAED,SAAS,aAAa,CACpB,MAA8B;IAE9B,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;AACzC,CAAC;AAED,SAAS,cAAc,CAAC,UAAkB;IACxC,OAAO,GAAG,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC;AAClD,CAAC"}

package/dist/platform/opt-outs.d.ts

@@ -1,6 +1,6 @@
 import { HttpTransport } from "../transport/http.js";
 import type { ApiResponse, RequestOptions } from "../transport/types.js";
-import type { DataEnvelope, PlatformPayload } from "./types.js";
+import type { DataEnvelope, OptOutSettings, PlatformPayload, UpdateOptOutSettingsRequest } from "./types.js";
 type OptOutResponse = Promise<ApiResponse<DataEnvelope<PlatformPayload>>>;
 export declare class OptOutsResource {
     private readonly transport;
@@ -8,6 +8,10 @@ export declare class OptOutsResource {
     list(options?: RequestOptions): OptOutResponse;
     create(body?: PlatformPayload, options?: RequestOptions): OptOutResponse;
     createBatch(body?: PlatformPayload, options?: RequestOptions): OptOutResponse;
+    /** Read the organization's STOP/START keyword capture settings. */
+    getSettings(options?: RequestOptions): Promise<ApiResponse<DataEnvelope<OptOutSettings>>>;
+    /** Replace the keyword capture settings. Every field is required. */
+    updateSettings(body: UpdateOptOutSettingsRequest, options?: RequestOptions): Promise<ApiResponse<DataEnvelope<OptOutSettings>>>;
     delete(phone: string, options?: RequestOptions): OptOutResponse;
     private write;
 }

package/dist/platform/opt-outs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"opt-outs.d.ts","sourceRoot":"","sources":["../../src/platform/opt-outs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAEhE,KAAK,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;AAE1E,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,aAAa;IAErD,IAAI,CAAC,OAAO,GAAE,cAAmB,GAAG,cAAc;IAQlD,MAAM,CAAC,IAAI,CAAC,EAAE,eAAe,EAAE,OAAO,GAAE,cAAmB,GAAG,cAAc;IAI5E,WAAW,CACT,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,cAAc;IAIjB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,cAAc;IAQnE,OAAO,CAAC,KAAK;CAYd"}
+{"version":3,"file":"opt-outs.d.ts","sourceRoot":"","sources":["../../src/platform/opt-outs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,KAAK,EACV,YAAY,EACZ,cAAc,EACd,eAAe,EACf,2BAA2B,EAC5B,MAAM,YAAY,CAAC;AAEpB,KAAK,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;AAI1E,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,aAAa;IAErD,IAAI,CAAC,OAAO,GAAE,cAAmB,GAAG,cAAc;IAQlD,MAAM,CAAC,IAAI,CAAC,EAAE,eAAe,EAAE,OAAO,GAAE,cAAmB,GAAG,cAAc;IAI5E,WAAW,CACT,IAAI,CAAC,EAAE,eAAe,EACtB,OAAO,GAAE,cAAmB,GAC3B,cAAc;IAIjB,mEAAmE;IACnE,WAAW,CACT,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC;IAQrD,qEAAqE;IACrE,cAAc,CACZ,IAAI,EAAE,2BAA2B,EACjC,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC;IASrD,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,cAAc;IAQnE,OAAO,CAAC,KAAK;CAYd"}

package/dist/platform/opt-outs.js

@@ -1,4 +1,5 @@
 import { HttpTransport } from "../transport/http.js";
+const SETTINGS_PATH = "/platform/optouts/settings";
 export class OptOutsResource {
     transport;
     constructor(transport) {
@@ -17,6 +18,23 @@ export class OptOutsResource {
     createBatch(body, options = {}) {
         return this.write("/platform/optouts/batch", body, options);
     }
+    /** Read the organization's STOP/START keyword capture settings. */
+    getSettings(options = {}) {
+        return this.transport.request({
+            method: "GET",
+            path: SETTINGS_PATH,
+            ...options,
+        });
+    }
+    /** Replace the keyword capture settings. Every field is required. */
+    updateSettings(body, options = {}) {
+        return this.transport.request({
+            method: "PUT",
+            path: SETTINGS_PATH,
+            body,
+            ...options,
+        });
+    }
     delete(phone, options = {}) {
         return this.transport.request({
             method: "DELETE",

package/dist/platform/opt-outs.js.map

@@ -1 +1 @@
-{"version":3,"file":"opt-outs.js","sourceRoot":"","sources":["../../src/platform/opt-outs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAMrD,MAAM,OAAO,eAAe;IACG;IAA7B,YAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;IAAG,CAAC;IAEzD,IAAI,CAAC,UAA0B,EAAE;QAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,mBAAmB;YACzB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,IAAsB,EAAE,UAA0B,EAAE;QACzD,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED,WAAW,CACT,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,KAAK,CAAC,yBAAyB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,MAAM,CAAC,KAAa,EAAE,UAA0B,EAAE;QAChD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,qBAAqB,kBAAkB,CAAC,KAAK,CAAC,EAAE;YACtD,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CACX,IAAY,EACZ,IAAiC,EACjC,OAAuB;QAEvB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;YACvC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"opt-outs.js","sourceRoot":"","sources":["../../src/platform/opt-outs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAWrD,MAAM,aAAa,GAAG,4BAA4B,CAAC;AAEnD,MAAM,OAAO,eAAe;IACG;IAA7B,YAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;IAAG,CAAC;IAEzD,IAAI,CAAC,UAA0B,EAAE;QAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,mBAAmB;YACzB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,IAAsB,EAAE,UAA0B,EAAE;QACzD,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED,WAAW,CACT,IAAsB,EACtB,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,KAAK,CAAC,yBAAyB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,mEAAmE;IACnE,WAAW,CACT,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,aAAa;YACnB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,qEAAqE;IACrE,cAAc,CACZ,IAAiC,EACjC,UAA0B,EAAE;QAE5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,aAAa;YACnB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAa,EAAE,UAA0B,EAAE;QAChD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,qBAAqB,kBAAkB,CAAC,KAAK,CAAC,EAAE;YACtD,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CACX,IAAY,EACZ,IAAiC,EACjC,OAAuB;QAEvB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;YACvC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}