@cosmoops/connect-sdk 0.48.0 → 0.50.0

package/dist/types/types.d.ts

@@ -267,9 +267,16 @@ export interface PlanAddonConsumable {
 export interface PlanAddon {
     id: string;
     name: string;
-    /** GST-exclusive, in paise. */
+    /** GST-exclusive, in paise. Per plan cycle, or per year when `billingCadence` is `"annual"`. */
     price: number;
     consumable?: PlanAddonConsumable | null;
+    /**
+     * When the add-on is billed. `"annual"` = once on the first cycle that holds
+     * it, then on each anniversary - on a monthly plan too - so render its price
+     * as "/year". `"plan"` (or absent, from a Connect that predates the field) =
+     * every plan cycle, as before.
+     */
+    billingCadence?: "plan" | "annual" | null;
 }
 /**
  * A plan feature with its label, as the **catalogue** read reports it.
@@ -1786,6 +1793,14 @@ export interface StoreCommitResult {
     /** The document id each operation wrote, positionally aligned with the operations sent. */
     ids: string[];
 }
+/** What `data.getMany` answers - see `POST /data-get-many`. */
+export interface StoreGetManyResult {
+    /**
+     * Positionally aligned with the ids asked for, `null` where a document does
+     * not exist. A missing document is an ordinary answer here, not a 404.
+     */
+    items: Array<StoreDocument | null>;
+}
 /** One entry from the `kv` store. */
 export interface KvEntry {
     key: string;
@@ -2951,6 +2966,45 @@ export interface CallSettings {
     /** Whether this member may change it - their `channel:manage`. Draw the switch disabled when not. */
     canManage: boolean;
 }
+/** A step of Connect's calling compliance journey - `connect.calls.getCallingReadiness()`. */
+export interface CallingReadinessStep {
+    key: "intent" | "business" | "number" | "header" | "autodialer" | "consent" | "rules";
+    label: string;
+    status: "not_started" | "submitted" | "returned" | "done";
+    /** Whether the business needs it for the calls it said it makes. */
+    required: boolean;
+    /** A returned step's reason, or what the numbers say. */
+    note: string | null;
+}
+/** One kind of calling, and whether the workspace may run it today. */
+export interface CallingReadinessRun {
+    /** `service` covers existing customers; `promotional` is any sales call. */
+    purpose: "service" | "promotional";
+    /** `preview`: a rep presses dial. `automatic`: software paces the dialing. */
+    mode: "preview" | "automatic";
+    allowed: boolean;
+    /** The first thing in the way, worded for the member. `null` when allowed. */
+    reason: string | null;
+}
+/**
+ * Where the workspace stands on the steps Indian telecom rules ask of a
+ * business before it calls - `connect.calls.getCallingReadiness()`. Read
+ * `runs`, not `steps`, to decide what to offer: Connect evaluates them with
+ * the gates the dialer refuses on.
+ */
+export interface CallingReadiness {
+    intent: "service_only" | "service_and_sales" | null;
+    progress: {
+        done: number;
+        required: number;
+    };
+    steps: CallingReadinessStep[];
+    runs: CallingReadinessRun[];
+    /** Connect's journey screen, carrying your `client_id` when SSO is on. */
+    setupUrl: string;
+    /** Whether this member may take the steps - their `channel:manage`. */
+    canManage: boolean;
+}
 export interface CallingAvailability {
     status: CallingAvailabilityStatus;
     /** The workspace's business number, E.164, when it holds one. */
@@ -3190,3 +3244,43 @@ export interface RegisterPushDeviceResponse {
     /** Hand this to `revokeDevice` to turn the same browser off again. */
     id: string;
 }
+/**
+ * One task, onto one of this application's declared task queues, for one
+ * workspace it serves. Hand-written like every wire type here;
+ * `conformance.test.ts` holds it to `EnqueueApplicationTaskInputSchema`.
+ */
+export interface EnqueueTaskInput {
+    workspaceId: string;
+    /** A queue declared for this application in Console. */
+    queue: string;
+    /** Any JSON. Delivered back as `payload`. Keep it to ids - 100 KB at most. */
+    payload?: unknown;
+    /**
+     * A dedup key. A second enqueue with the same name for the same workspace
+     * answers `duplicate` and queues nothing - name a self-chaining step after
+     * the step (`campaign-42-page-3`) so two runners cannot both queue it.
+     */
+    name?: string;
+    /** ISO-8601, at most 30 days ahead. Omit to run as soon as the queue's rate allows. */
+    scheduleAt?: string;
+}
+export interface EnqueueTaskResponse {
+    /**
+     * `unavailable` means this Connect deployment has no task queue (local
+     * development). Nothing was queued; fall back to whatever you would do
+     * without one.
+     */
+    status: "queued" | "duplicate" | "unavailable";
+    scheduleAt: string | null;
+}
+/** What Cloud Tasks POSTs to a queue's URL - and what `verifyConnectTask` returns. */
+export interface ConnectTaskDelivery<TPayload = unknown> {
+    /** The workspace the enqueue was gated on - trust this, not anything in `payload`. */
+    workspaceId: string;
+    queue: string;
+    payload: TPayload;
+    /** From Cloud Tasks' own headers: 0 on the first attempt. */
+    retryCount: number;
+    /** Cloud Tasks' task id, stable across retries. */
+    taskName: string | null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmoops/connect-sdk",
-  "version": "0.48.0",
+  "version": "0.50.0",
   "description": "Official server-side SDK for the CosmoOps Connect platform API - Login with Connect, entitlements, billing and metering.",
   "license": "SEE LICENSE IN LICENSE",
   "type": "commonjs",