@arbol-ai/sdk 1.20261019.4056 → 2.2.0

package/README.md

@@ -3,8 +3,9 @@
 The Arbol API for TypeScript and JavaScript, generated by
 [Cloudflare Forge](https://github.com/cloudflare/forge) from the platform's public OpenAPI,
 [`https://api.getarbol.com/openapi.json`](https://api.getarbol.com/openapi.json). Everything in `src/`
-is Forge's TypeScript output, unedited, and the package's version is the API release it was generated
-from (`1.YYYYMMDD.n`).
+is Forge's TypeScript output, unedited. Versions are semver, and each one records the OpenAPI it was
+generated from: `npm view @arbol-ai/sdk@<version> arbol.openapi` prints its `release` (`info.version`)
+and content hash (`sha256`).
 
 ```sh
 npm install @arbol-ai/sdk
@@ -56,49 +57,63 @@ The server authorizes every call: a method in the client is not a grant.
 bun install
 bun run forge       # build the pinned Cloudflare Forge with cargo into .forge/ (once; needs Rust)
 bun run openapi     # download https://api.getarbol.com/openapi.json
-bun run generate    # src/ from openapi.json with `forge --target ts`; the version from its info.version
+bun run generate    # src/ from openapi.json with `forge --target ts`; its release and hash in arbol.openapi
 bun run hash        # the OpenAPI's content hash (see Releases)
 bun run verify      # typecheck and build dist/
 ```
 
-`openapi.json` is downloaded at generation time and not committed; `package.json`'s version is the
-OpenAPI version `src/` was generated from, and `release.json` records that version and the OpenAPI's
-content hash. Forge is pinned to its commit
+`openapi.json` is downloaded at generation time and not committed. `package.json`'s `arbol.openapi`
+records the OpenAPI `src/` was generated from, its `info.version` as `release` and its content hash as
+`sha256`; `version` and `arbol` are release metadata the workflows set. Forge is pinned to its commit
 `7f86447210b7bea3779bfdab3cd5655eade0eadb` (0.1.0) in the `forge` script.
 
 ## Releases
 
-Releases are automatic, from the API down to the CLI:
+Versions are semver, independent of the OpenAPI's release number. The 1.x versions (`1.YYYYMMDD.n`)
+were the OpenAPI's date releases; 2.x starts at 2.1.0.
+
+Releases of a new OpenAPI are automatic, from the API down to the CLI:
 
 1. **Gateway.** When the Arbol API ships an OpenAPI release, the gateway sends this repository a
    `repository_dispatch` `openapi-release` with `{ "version": "<release>" }`.
 2. **SDK (this repository).** [Generate](.github/workflows/generate.yml) runs on that dispatch, every
    six hours, and by hand. It downloads the OpenAPI (waiting until the API serves the announced release)
-   and hashes its content. When the hash differs from the one in `release.json`, it regenerates `src/`
-   with Forge, verifies it, commits `Release <version>` to `main` as Arbol, and publishes
-   `@arbol-ai/sdk` to npm with [Publish](.github/workflows/publish.yml), with a provenance statement.
-3. **CLI.** After publishing, Generate sends
+   and hashes its content. When the hash differs from `arbol.openapi.sha256` in `package.json`, it
+   regenerates `src/` with Forge, records the OpenAPI in `arbol.openapi`, and takes the highest version
+   on npm with the minor raised and the patch at 0 (2.1.0, 2.2.0, 2.3.0, …). It verifies the result,
+   commits `Release <version>` to `main` as Arbol, and publishes `@arbol-ai/sdk` to npm with
+   [Publish](.github/workflows/publish.yml), with a provenance statement.
+3. **CLI.** After publishing, Publish sends
    [project-arbol-cli](https://github.com/getarbol/project-arbol-cli) a `repository_dispatch`
-   `sdk-release` with `{ "version": "<published version>", "sha256": "<OpenAPI hash>" }`, and the CLI
-   releases itself on it.
+   `sdk-release` with `{ "version": "<published version>", "openapi": { "release": "…", "sha256": "…" } }`,
+   the published `version` and `arbol.openapi`, and the CLI releases itself on it.
 
 The hash ([`scripts/release.ts`](scripts/release.ts)) is the SHA-256 hex of the OpenAPI's canonical
 JSON (object keys sorted recursively, arrays in order, no whitespace) with `info.version` removed. A new
-release number with an identical API hashes the same, so it commits, publishes, and announces nothing.
-A version on `main` that is not on npm yet, such as one a failed run left behind, is published by the
-next run.
+release number with an identical API hashes the same, so Generate commits, publishes, and announces
+nothing. A version on `main` that is not on npm yet, such as one a failed run left behind, is published
+by the next run.
+
+Changes to the SDK itself, such as a new Forge pin, are released by hand: commit them to `main`
+(regenerated with `bun run generate` when they change `src/`), then run Publish on `main` with `bump`
+`patch` (the default), `minor` or `major`:
+
+```sh
+gh workflow run publish.yml --repo getarbol/project-arbol-sdk-js --ref main -f bump=patch
+```
 
-Changes outside the OpenAPI, such as a new Forge pin, release nothing on their own: they ship with the
-next OpenAPI change.
+It raises that part of the highest version on npm (while no 2.x version is published, the result is
+2.1.0 whatever the bump), commits `Release <version>` to `main`, publishes it, and announces it to the
+CLI like Generate. It refuses when `main`'s version is not on npm yet (run Generate, which publishes it),
+and when nothing that goes into the package (`src/`, `package.json`, `tsconfig.json`, `bun.lock`,
+`README.md`, `LICENSE`) changed since the commit that released `main`'s version, so the same SDK is
+never published twice. A manual release and Generate wait for each other.
 
-Generate pushes and dispatches as the Arbol Bot GitHub App, so its commit to `main` runs
-[Verify](.github/workflows/verify.yml). It needs the organization variable `ARBOL_BOT_APP_ID`, the
+Generate and Publish push and dispatch as the Arbol Bot GitHub App, so their commits to `main` run
+[Verify](.github/workflows/verify.yml). They need the organization variable `ARBOL_BOT_APP_ID`, the
 organization secret `ARBOL_BOT_PRIVATE_KEY`, and the App installed with contents write access to this
 repository and project-arbol-cli. npm publishing uses the organization secret `NPM_TOKEN`.
 
-Run Publish by hand on `main` to publish the version in `package.json`; a version that is already on npm
-is left untouched.
-
 ## License
 
 [Apache License 2.0](LICENSE)

package/dist/raiz/agents/client.js

@@ -26,14 +26,14 @@ const GetOperation = {
     route: "/v1/raiz/agents/get",
     query: { agentId: "agentId" },
     response: object([["data", null, () => RaizAgentCodec]]),
-    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "422": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "413": true, "415": true, "429": true, "500": true, "502": true, "503": true, "504": true },
 };
 const ListOperation = {
     method: "GET",
     route: "/v1/raiz/agents",
     query: { cursor: "cursor", direction: "direction", limit: "limit", modality: "modality", q: "q", status: "status" },
     response: object([["data", null, () => RaizAgentPageCodec]]),
-    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "422": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "413": true, "415": true, "429": true, "500": true, "502": true, "503": true, "504": true },
 };
 const UpdateOperation = {
     method: "PATCH",

package/dist/raiz/agents/index.d.ts

@@ -2,4 +2,4 @@ export { ApiError } from "../../_/index.js";
 export type { RequestOptions } from "../../_/index.js";
 export { createClient } from "./client.js";
 export type { Client, ClientOptions, CreateRequest, CreateResponse, GetRequest, GetResponse, ListRequest, ListResponse, UpdateRequest, UpdateResponse, } from "./client.js";
-export type { RaizAgent, RaizAgentGreeting, RaizAgentIntegrationToolInput, RaizAgentModelTrial, RaizAgentPage, RaizAgentSettings, RaizAgentSettingsInput, RaizAgentSummary, RaizAgentTurnPolicy, RaizAgentVoiceSettings, } from "./models.js";
+export type { RaizAgent, RaizAgentGreeting, RaizAgentIntegrationToolInput, RaizAgentModelTrial, RaizAgentPage, RaizAgentSettings, RaizAgentSettingsInput, RaizAgentTurnPolicy, RaizAgentVoiceSettings, } from "./models.js";

package/dist/raiz/agents/models.d.ts

@@ -126,7 +126,7 @@ export interface RaizAgentPage {
     /**
      * Items admitted by this resource contract within the verified organization.
      */
-    data: RaizAgentSummary[];
+    data: RaizAgent[];
     /**
      * Discriminator for a resource list response.
      */
@@ -181,50 +181,6 @@ export interface RaizAgentSettingsInput {
     toolDiscovery?: boolean | null;
     voice?: RaizAgentVoiceSettings | null;
 }
-export interface RaizAgentSummary {
-    channelCount: number;
-    /**
-     * An instant in RFC 3339 format, in UTC.
-     */
-    createdAt: Temporal.Instant;
-    description: string | null;
-    firstMessage: string | null;
-    /**
-     * Agent id.
-     */
-    id: string;
-    /**
-     * BCP 47 language tag.
-     */
-    language: string;
-    /**
-     * `voice`: phone calls. `text`: WhatsApp and web chat.
-     */
-    modality: "voice" | "text";
-    name: string;
-    /**
-     * Whether the Agent can hold conversations: active, with instructions and,
-     * for voice, published for calls.
-     */
-    ready: boolean;
-    /**
-     * A paused Agent answers nothing and places no calls.
-     */
-    status: "active" | "paused";
-    syncErrorCode: string | null;
-    /**
-     * Whether calls already use the current version (it is published on the
-     * Agent's voice channels). Always true for text Agents.
-     */
-    synced: boolean;
-    timeZone: string | null;
-    toolCount: number;
-    /**
-     * An instant in RFC 3339 format, in UTC.
-     */
-    updatedAt: Temporal.Instant;
-    version: number;
-}
 export interface RaizAgentTurnPolicy {
     /**
      * Output tokens per model call, reasoning included. Default 4096.
@@ -282,4 +238,3 @@ export interface RaizAgentVoiceSettings {
 export declare const RaizAgentCodec: import("../../_/codec.js").Codec;
 export declare const RaizAgentPageCodec: import("../../_/codec.js").Codec;
 export declare const RaizAgentSettingsInputCodec: import("../../_/codec.js").Codec;
-export declare const RaizAgentSummaryCodec: import("../../_/codec.js").Codec;

package/dist/raiz/agents/models.js

@@ -7,12 +7,8 @@ export const RaizAgentCodec = object([
     ["updatedAt", null, instant],
 ]);
 export const RaizAgentPageCodec = object([
-    ["data", null, array(() => RaizAgentSummaryCodec)],
+    ["data", null, array(() => RaizAgentCodec)],
 ]);
 export const RaizAgentSettingsInputCodec = object([
     ["businessHours", null, () => RaizBusinessHoursCodec],
 ]);
-export const RaizAgentSummaryCodec = object([
-    ["createdAt", null, instant],
-    ["updatedAt", null, instant],
-]);

package/dist/raiz/bulletins/client.d.ts

@@ -0,0 +1,182 @@
+import { type BaseClientOptions, type RequestOptions, Transport } from "../../_/index.js";
+import type { DeletedObject, ResponseMetadata } from "../../models.js";
+import { type RaizBulletin, type RaizBulletinPage } from "./models.js";
+export interface ClientOptions extends BaseClientOptions {
+    /**
+     * The URL the paths of the API are relative to.
+     */
+    baseUrl: string;
+}
+export interface Client {
+    /**
+     * Post a bulletin
+     *
+     * Post a bulletin: something happening now that the organization's Agents
+     * must apply on calls, WhatsApp and web chat while it lasts (for example:
+     * there is no nutrition service; no appointments at the North site for four
+     * days; closed on Monday the 26th; a promotion). Write `text` as you would
+     * tell the Agents, including what they should offer instead. Omit `agentId`
+     * for every Agent, or name one Agent. Agents apply it from their next reply
+     * or call once `startsAt` (default now) is reached, until `endsAt` (omit it
+     * for no end). Resolve phrases such as 'for four days' or 'until Friday' in
+     * the organization's time zone (`get_organization`), ending whole days at
+     * local midnight. No Agent reads a bulletin before it starts: for Agents to
+     * know ahead (so they book nothing on a closed day), start it now and write
+     * the dates in the text. Fails with BULLETIN_PERIOD_INVALID when it would end
+     * before it starts or is already over, and BULLETIN_LIMIT_REACHED at 30
+     * bulletins in force or scheduled.
+     */
+    create(request: CreateRequest, options?: RequestOptions): Promise<CreateResponse>;
+    /**
+     * Delete a bulletin
+     *
+     * Delete a bulletin that was a mistake or is no longer wanted: Agents stop
+     * applying it from their next reply or call. The history keeps who deleted it
+     * and when. To keep it listed as ended instead, set its `endsAt` to now with
+     * `update_bulletin`.
+     */
+    delete(request: DeleteRequest, options?: RequestOptions): Promise<DeleteResponse>;
+    /**
+     * Get a bulletin
+     *
+     * Read one bulletin: its text, the Agent that applies it (null for every
+     * Agent), its period and its status.
+     */
+    get(request: GetRequest, options?: RequestOptions): Promise<GetResponse>;
+    /**
+     * List bulletins
+     *
+     * List the organization's bulletins (Settings → Bulletins in the Dashboard;
+     * people may call them novedades, avisos or eventos): what is happening now
+     * that its Agents apply while it lasts, such as a service that is not
+     * available, days without appointments at a site, a closed day or a
+     * promotion. Default: those in force (`active`) and those not started yet
+     * (`scheduled`); `status=ended` lists ended ones. `agentId` lists what one
+     * Agent applies (its own and those for every Agent); `q` searches the text.
+     * Use it to find the bulletin a person means before changing or deleting it.
+     */
+    list(request?: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+    /**
+     * Update a bulletin
+     *
+     * Change a bulletin: its text, its Agent (null for every Agent), its start or
+     * its end. Omitted fields stay. To end one now, set `endsAt` to the current
+     * instant; a scheduled one is deleted instead. Agents apply the change from
+     * their next reply or call.
+     */
+    update(request: UpdateRequest, options?: RequestOptions): Promise<UpdateResponse>;
+}
+export declare function createClient(options: ClientOptions): Client;
+export declare function bind(transport: Transport): Client;
+export interface CreateRequest {
+    agentId?: string | null;
+    /**
+     * When Agents stop applying it, later than its start and than now. Omit it or
+     * send null to keep it until it is deleted.
+     */
+    endsAt?: Temporal.Instant | null;
+    /**
+     * When Agents start applying it; default now. No Agent reads it before. For
+     * Agents to know ahead (so they book no appointment on a closed day), start
+     * it now and write the dates in the text.
+     */
+    startsAt?: Temporal.Instant;
+    /**
+     * What is happening and what the Agents should do about it, written as you
+     * would tell them. One situation per bulletin; long reference material
+     * belongs in Knowledge.
+     */
+    text: string;
+}
+export interface CreateResponse {
+    data: RaizBulletin;
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}
+export interface DeleteRequest {
+    /**
+     * Bulletin id.
+     */
+    bulletinId: string;
+}
+export interface DeleteResponse {
+    data: DeletedObject;
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}
+export interface GetRequest {
+    /**
+     * Bulletin id.
+     */
+    bulletinId: string;
+}
+export interface GetResponse {
+    data: RaizBulletin;
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}
+export interface ListRequest {
+    /**
+     * Opaque cursor returned by pageInfo; omit it to request the first page.
+     */
+    cursor?: string;
+    /**
+     * Direction to traverse the stable keyset ordering from the supplied cursor.
+     */
+    direction?: "forward" | "backward";
+    /**
+     * Maximum items returned in one page. Defaults to 25; larger reads require
+     * another cursor.
+     */
+    limit?: number;
+    /**
+     * Only the bulletins this Agent applies: its own and those for every Agent.
+     */
+    agentId?: string;
+    /**
+     * Text in the bulletin, ignoring case.
+     */
+    q?: string;
+    /**
+     * Comma-separated statuses to list. Default `scheduled,active`; ended
+     * bulletins appear only when asked for.
+     */
+    status?: string;
+}
+export interface ListResponse {
+    data: RaizBulletinPage;
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}
+export interface UpdateRequest {
+    agentId?: string | null;
+    /**
+     * Bulletin id.
+     */
+    bulletinId: string;
+    /**
+     * When Agents stop applying it, later than its start; send the current
+     * instant to end it now, or null to keep it until it is deleted.
+     */
+    endsAt?: Temporal.Instant | null;
+    /**
+     * When Agents start applying it.
+     */
+    startsAt?: Temporal.Instant;
+    /**
+     * What is happening and what the Agents should do about it, written as you
+     * would tell them. One situation per bulletin; long reference material
+     * belongs in Knowledge.
+     */
+    text?: string;
+}
+export interface UpdateResponse {
+    data: RaizBulletin;
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}

package/dist/raiz/bulletins/client.js

@@ -0,0 +1,53 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { Transport, instant, object, } from "../../_/index.js";
+import { RaizBulletinCodec, RaizBulletinPageCodec, } from "./models.js";
+export function createClient(options) {
+    return bind(new Transport(options));
+}
+export function bind(transport) {
+    return {
+        create: (request, options) => transport.send(CreateOperation, request, options),
+        delete: (request, options) => transport.send(DeleteOperation, request, options),
+        get: (request, options) => transport.send(GetOperation, request, options),
+        list: (request, options) => transport.send(ListOperation, request, options),
+        update: (request, options) => transport.send(UpdateOperation, request, options),
+    };
+}
+const CreateOperation = {
+    method: "POST",
+    route: "/v1/raiz/bulletins/create",
+    body: "flat",
+    request: object([["endsAt", null, instant], ["startsAt", null, instant]]),
+    response: object([["data", null, () => RaizBulletinCodec]]),
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "422": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+};
+const DeleteOperation = {
+    method: "DELETE",
+    route: "/v1/raiz/bulletins/delete",
+    body: "flat",
+    response: null,
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "413": true, "415": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+};
+const GetOperation = {
+    method: "GET",
+    route: "/v1/raiz/bulletins/get",
+    query: { bulletinId: "bulletinId" },
+    response: object([["data", null, () => RaizBulletinCodec]]),
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "413": true, "415": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+};
+const ListOperation = {
+    method: "GET",
+    route: "/v1/raiz/bulletins",
+    query: { cursor: "cursor", direction: "direction", limit: "limit", agentId: "agentId", q: "q", status: "status" },
+    response: object([["data", null, () => RaizBulletinPageCodec]]),
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "413": true, "415": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+};
+const UpdateOperation = {
+    method: "PATCH",
+    route: "/v1/raiz/bulletins/update",
+    body: "flat",
+    request: object([["endsAt", null, instant], ["startsAt", null, instant]]),
+    response: object([["data", null, () => RaizBulletinCodec]]),
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "422": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+};

package/dist/raiz/bulletins/index.d.ts

@@ -0,0 +1,5 @@
+export { ApiError } from "../../_/index.js";
+export type { RequestOptions } from "../../_/index.js";
+export { createClient } from "./client.js";
+export type { Client, ClientOptions, CreateRequest, CreateResponse, DeleteRequest, DeleteResponse, GetRequest, GetResponse, ListRequest, ListResponse, UpdateRequest, UpdateResponse, } from "./client.js";
+export type { RaizBulletin, RaizBulletinAgent, RaizBulletinPage, } from "./models.js";

package/dist/raiz/bulletins/index.js

@@ -0,0 +1,4 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+export { ApiError } from "../../_/index.js";
+export { createClient } from "./client.js";

package/dist/raiz/bulletins/models.d.ts

@@ -0,0 +1,53 @@
+import type { PageInfo } from "../../models.js";
+export interface RaizBulletin {
+    agent: RaizBulletinAgent | null;
+    /**
+     * An instant in RFC 3339 format, in UTC.
+     */
+    createdAt: Temporal.Instant;
+    endsAt: Temporal.Instant | null;
+    /**
+     * Bulletin id.
+     */
+    id: string;
+    /**
+     * When Agents start applying it.
+     */
+    startsAt: Temporal.Instant;
+    /**
+     * `scheduled`: it has not started and no Agent reads it yet. `active`: Agents
+     * apply it. `ended`: its period is over and no Agent reads it.
+     */
+    status: "scheduled" | "active" | "ended";
+    /**
+     * What is happening, in the words the Agents read.
+     */
+    text: string;
+    /**
+     * An instant in RFC 3339 format, in UTC.
+     */
+    updatedAt: Temporal.Instant;
+}
+export interface RaizBulletinAgent {
+    /**
+     * Agent id.
+     */
+    id: string;
+    name: string;
+}
+export interface RaizBulletinPage {
+    /**
+     * Items admitted by this resource contract within the verified organization.
+     */
+    data: RaizBulletin[];
+    /**
+     * Discriminator for a resource list response.
+     */
+    object: "list";
+    /**
+     * Opaque navigation cursors for this page’s stable keyset order.
+     */
+    pageInfo: PageInfo;
+}
+export declare const RaizBulletinCodec: import("../../_/codec.js").Codec;
+export declare const RaizBulletinPageCodec: import("../../_/codec.js").Codec;

package/dist/raiz/bulletins/models.js

@@ -0,0 +1,12 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { array, instant, object } from "../../_/index.js";
+export const RaizBulletinCodec = object([
+    ["createdAt", null, instant],
+    ["endsAt", null, instant],
+    ["startsAt", null, instant],
+    ["updatedAt", null, instant],
+]);
+export const RaizBulletinPageCodec = object([
+    ["data", null, array(() => RaizBulletinCodec)],
+]);

package/dist/raiz/campaigns/client.js

@@ -26,14 +26,14 @@ const GetOperation = {
     route: "/v1/raiz/campaigns/get",
     query: { campaignId: "campaignId", expand: "expand", recipientsCursor: "recipientsCursor", recipientsDirection: "recipientsDirection", recipientsLimit: "recipientsLimit" },
     response: object([["data", null, () => RaizCampaignCodec]]),
-    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "422": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "413": true, "415": true, "429": true, "500": true, "502": true, "503": true, "504": true },
 };
 const ListOperation = {
     method: "GET",
     route: "/v1/raiz/campaigns",
     query: { cursor: "cursor", direction: "direction", limit: "limit", agentId: "agentId", status: "status" },
     response: object([["data", null, () => RaizCampaignPageCodec]]),
-    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "422": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "413": true, "415": true, "429": true, "500": true, "502": true, "503": true, "504": true },
 };
 const UpdateOperation = {
     method: "PATCH",

package/dist/raiz/campaigns/index.d.ts

@@ -2,4 +2,4 @@ export { ApiError } from "../../_/index.js";
 export type { RequestOptions } from "../../_/index.js";
 export { createClient } from "./client.js";
 export type { Client, ClientOptions, CreateRequest, CreateResponse, GetRequest, GetResponse, ListRequest, ListResponse, UpdateRequest, UpdateResponse, } from "./client.js";
-export type { RaizCampaign, RaizCampaignPage, RaizCampaignProgress, RaizCampaignRecipientInput, RaizCampaignRecipientPage, RaizCampaignSummary, } from "./models.js";
+export type { RaizCampaign, RaizCampaignPage, RaizCampaignProgress, RaizCampaignRecipientInput, RaizCampaignRecipientPage, } from "./models.js";

package/dist/raiz/campaigns/models.d.ts

@@ -1,5 +1,5 @@
 import type { PageInfo } from "../../models.js";
-import type { RaizContactHoursWindow } from "../models.js";
+import type { RaizContactHoursWindow, RaizPhoneNumber } from "../models.js";
 export interface RaizCampaign {
     /**
      * Agent id.
@@ -61,7 +61,7 @@ export interface RaizCampaignPage {
     /**
      * Items admitted by this resource contract within the verified organization.
      */
-    data: RaizCampaignSummary[];
+    data: RaizCampaign[];
     /**
      * Discriminator for a resource list response.
      */
@@ -86,7 +86,7 @@ export interface RaizCampaignRecipientInput {
     /**
      * Phone number in E.164 format.
      */
-    address: string;
+    address: RaizPhoneNumber;
     /**
      * The contact the call is about. Omitted: the contact that owns `address`,
      * created when the organization has none.
@@ -97,7 +97,9 @@ export interface RaizCampaignRecipientInput {
     /**
      * Values for the `{{name}}` variables the Agent's instructions, first message
      * or this campaign's texts reference. Raíz always provides `contact_name`,
-     * `contact_given_name`, `contact_id`, `contact_phone` and `conversation_id`.
+     * `contact_given_name`, `contact_id`, `contact_phone`, `conversation_id` and
+     * `bulletins` (the business bulletins in force), which a recipient's values
+     * never replace.
      */
     variables?: {
         [key: string]: unknown;
@@ -138,59 +140,6 @@ export interface RaizCampaignRecipientPage {
      */
     pageInfo: PageInfo;
 }
-export interface RaizCampaignSummary {
-    /**
-     * Agent id.
-     */
-    agentId: string;
-    channelId: string | null;
-    /**
-     * When calls may start, in the campaign's time zone. Empty: any time.
-     */
-    contactHours: RaizContactHoursWindow[];
-    /**
-     * An instant in RFC 3339 format, in UTC.
-     */
-    createdAt: Temporal.Instant;
-    endedAt: Temporal.Instant | null;
-    firstMessage: string | null;
-    /**
-     * Campaign id.
-     */
-    id: string;
-    instructions: string | null;
-    maxAttempts: number;
-    /**
-     * Your own keys and labels for this resource (up to 50 keys of 40 characters;
-     * values up to 500 characters). Raíz never interprets them.
-     */
-    metadata: {
-        [key: string]: unknown;
-    };
-    name: string;
-    /**
-     * How many recipients are in each state.
-     */
-    progress: RaizCampaignProgress;
-    retryAfterMinutes: number;
-    retryOn: ("no_answer" | "failure")[];
-    scheduledEndAt: Temporal.Instant | null;
-    scheduledStartAt: Temporal.Instant | null;
-    startedAt: Temporal.Instant | null;
-    /**
-     * `queued`: not started yet (or its start is scheduled). `running`: calling
-     * due recipients. `paused`: started, then paused; calls in progress finish.
-     * `completed`: no recipient is left to call.
-     */
-    status: "queued" | "running" | "paused" | "completed" | "cancelled" | "failed";
-    timeZone: string;
-    /**
-     * An instant in RFC 3339 format, in UTC.
-     */
-    updatedAt: Temporal.Instant;
-    version: number;
-}
 export declare const RaizCampaignCodec: import("../../_/codec.js").Codec;
 export declare const RaizCampaignPageCodec: import("../../_/codec.js").Codec;
 export declare const RaizCampaignRecipientPageCodec: import("../../_/codec.js").Codec;
-export declare const RaizCampaignSummaryCodec: import("../../_/codec.js").Codec;

package/dist/raiz/campaigns/models.js

@@ -11,16 +11,8 @@ export const RaizCampaignCodec = object([
     ["updatedAt", null, instant],
 ]);
 export const RaizCampaignPageCodec = object([
-    ["data", null, array(() => RaizCampaignSummaryCodec)],
+    ["data", null, array(() => RaizCampaignCodec)],
 ]);
 export const RaizCampaignRecipientPageCodec = object([
     ["data", null, array(object([["createdAt", null, instant], ["lastAttempt", null, object([["startedAt", null, instant]])], ["nextAttemptAt", null, instant], ["updatedAt", null, instant]]))],
 ]);
-export const RaizCampaignSummaryCodec = object([
-    ["createdAt", null, instant],
-    ["endedAt", null, instant],
-    ["scheduledEndAt", null, instant],
-    ["scheduledStartAt", null, instant],
-    ["startedAt", null, instant],
-    ["updatedAt", null, instant],
-]);