@arbol-ai/sdk 2.6.0 → 2.8.0

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

@@ -138,6 +138,7 @@ export interface RaizAgentPage {
 }
 export interface RaizAgentSettings {
     attachmentReader: "vision" | "ocr" | null;
+    automaticKnowledge: boolean | null;
     budgetExhaustedMessage: string | null;
     closingMessage: string | null;
     evalGate: boolean | null;
@@ -160,6 +161,7 @@ export interface RaizAgentSettings {
 }
 export interface RaizAgentSettingsInput {
     attachmentReader?: "vision" | "ocr" | null;
+    automaticKnowledge?: boolean | null;
     budgetExhaustedMessage?: string | null;
     businessHours?: RaizBusinessHours | null;
     closingMessage?: string | null;

package/dist/raiz/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, } from "./client.js";
-export type { RaizAgentIntegrationSkillInput, RaizAgentSkill, RaizBusinessHours, RaizBusinessHoursWindow, RaizContactHoursWindow, RaizCount, RaizEmailAddress, RaizFact, RaizFailureResponse, RaizHttpsUrl, RaizPhoneNumber, RaizTask, } from "./models.js";
+export type { RaizAgentIntegrationSkillInput, RaizAgentSkill, RaizBusinessHours, RaizBusinessHoursWindow, RaizContactHoursWindow, RaizCount, RaizEmailAddress, RaizFact, RaizFailureResponse, RaizHttpsUrl, RaizOutsideHoursTemplate, RaizPhoneNumber, RaizTask, } from "./models.js";

package/dist/raiz/models.d.ts

@@ -35,10 +35,22 @@ export interface RaizBusinessHours {
     /**
      * What whoever writes outside the hours receives, once per number and closed
      * period (until the hours open again), whether the conversation's AI is on,
-     * off or paused. It is never taken as an answer: the AI answers what the
-     * contact wrote when a person turns it on or resumes it in business hours.
+     * off or paused. With `outsideHoursTemplate`, the template goes instead, and
+     * this text only when WhatsApp refuses the template. The notice is never
+     * taken as an answer: the AI answers what the contact wrote when a person
+     * turns it on or resumes it in business hours.
      */
     outsideHoursMessage: string;
+    /**
+     * Send the notice as this approved WhatsApp template instead of
+     * `outsideHoursMessage`: a template of the number's account with no variables
+     * and no document, image or video header (in `list_templates`: `sendable`,
+     * with `parameterCount` 0). WhatsApp's approval is checked when the hours are
+     * saved. If WhatsApp refuses the template when a notice goes (deleted, paused
+     * or disabled since), `outsideHoursMessage` goes instead. Null or absent: the
+     * notice is `outsideHoursMessage`.
+     */
+    outsideHoursTemplate?: RaizOutsideHoursTemplate | null;
     timeZone: string | null;
     /**
      * Several windows may share a day, for a break at midday or an afternoon
@@ -895,6 +907,16 @@ export interface RaizFailureResponse {
     success: false;
 }
 export type RaizHttpsUrl = string;
+export interface RaizOutsideHoursTemplate {
+    /**
+     * The template's language in WhatsApp's code, for example `es` or `es_MX`.
+     */
+    language: string;
+    /**
+     * The template's name.
+     */
+    name: string;
+}
 export type RaizPhoneNumber = string;
 export interface RaizTask {
     /**

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

@@ -20,8 +20,11 @@ export interface Client {
      * reschedules, cancellations, failures, pending and unverified results
      * separately), `tool_calls_daily` (Agent tool calls per day), `tool_calls`
      * (each call, newest first), `assessment_results_daily` (assessment results
-     * per day), each over days in the organization's time zone (`from`, `to`; the
-     * last 30 days by default), or `campaign_progress`. Narrow with `agentId`,
+     * per day), `pqrsf_daily` (PQRSF classification, confirmed informational
+     * resolution and correct referrals from current pqrsf_* facts; unknown and
+     * pending analysis remain visible; excludes tests/imports/deleted records),
+     * each over days in the organization's time zone (`from`, `to`; the last 30
+     * days by default), or `campaign_progress`. Narrow with `agentId`,
      * `channelType`, `campaignId` or `definitionId`; unsupported filters fail. At
      * most 1000 rows: `hasMore` means split the range or filter. Booking outcomes
      * return no partial totals when their evidence scan exceeds its bound.
@@ -64,10 +67,14 @@ export interface CurrentRequest {
      * `tool_calls_daily`: tool calls per day, Agent and tool with
      * failures/durations (filter `agentId`). `tool_calls`: individual calls,
      * never inputs/outputs (filter `agentId`). `assessment_results_daily`:
-     * assessments per day/definition (filter `definitionId`).
-     * `campaign_progress`: recipients by status (filter `campaignId`; no dates).
+     * assessments per day/definition (filter `definitionId`). `pqrsf_daily`:
+     * classification, confirmed resolution and referral-link counts from the
+     * pqrsf_* definitions, including pending/unclassified conversations,
+     * excluding tests/imports/deleted records (filters `agentId`, `channelType`);
+     * no measured filing reduction is inferred. `campaign_progress`: recipients
+     * by status (filter `campaignId`; no dates).
      */
-    name: "conversations_daily" | "tool_calls_daily" | "tool_calls" | "booking_outcomes" | "assessment_results_daily" | "campaign_progress";
+    name: "conversations_daily" | "pqrsf_daily" | "tool_calls_daily" | "tool_calls" | "booking_outcomes" | "assessment_results_daily" | "campaign_progress";
     /**
      * Last day (`YYYY-MM-DD`), inclusive, of a daily report. Default: today in
      * the organization's time zone.

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

@@ -17,6 +17,25 @@ export type RaizReport = {
         toReviewCount: number;
     }[];
     to: Temporal.PlainDate;
+} | {
+    from: Temporal.PlainDate;
+    hasMore: boolean;
+    name: "pqrsf_daily";
+    rows: {
+        analyzedCount: number;
+        confirmedResolutionCount: number;
+        conversationCount: number;
+        day: Temporal.PlainDate;
+        formalPqrsfCount: number;
+        informativeResolvedCount: number;
+        informativeUnresolvedCount: number;
+        referralCorrectCount: number;
+        referralIncorrectCount: number;
+        referralPendingCount: number;
+        referralRequiredCount: number;
+        unclassifiedCount: number;
+    }[];
+    to: Temporal.PlainDate;
 } | {
     from: Temporal.PlainDate;
     hasMore: boolean;

package/dist/raiz/reports/models.js

@@ -1,4 +1,4 @@
 // Code generated by forge. DO NOT EDIT.
 /* eslint-disable */
 import { array, date, instant, object, union } from "../../_/index.js";
-export const RaizReportCodec = union([object([["from", null, date], ["rows", null, array(object([["day", null, date]]))], ["to", null, date]]), object([["from", null, date], ["rows", null, array(object([["day", null, date]]))], ["to", null, date]]), object([["from", null, date], ["rows", null, array(object([["occurredAt", null, instant]]))], ["to", null, date]]), object([["from", null, date], ["rows", null, array(object([["day", null, date]]))], ["to", null, date]]), object([["from", null, date], ["rows", null, array(object([["day", null, date]]))], ["to", null, date]])]);
+export const RaizReportCodec = union([object([["from", null, date], ["rows", null, array(object([["day", null, date]]))], ["to", null, date]]), object([["from", null, date], ["rows", null, array(object([["day", null, date]]))], ["to", null, date]]), object([["from", null, date], ["rows", null, array(object([["day", null, date]]))], ["to", null, date]]), object([["from", null, date], ["rows", null, array(object([["occurredAt", null, instant]]))], ["to", null, date]]), object([["from", null, date], ["rows", null, array(object([["day", null, date]]))], ["to", null, date]]), object([["from", null, date], ["rows", null, array(object([["day", null, date]]))], ["to", null, date]])]);

package/dist/sura/affiliations/client.d.ts

@@ -28,6 +28,13 @@ export interface LookupRequest {
      * Document type. Defaults to CC.
      */
     documentType?: "CC" | null;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * Which of the organization's SURA connections to run on, by its id. Optional
      * while the organization has one; required when it has several.

package/dist/sura/affiliations/client.js

@@ -13,7 +13,7 @@ export function bind(transport) {
 const LookupOperation = {
     method: "GET",
     route: "/v1/sura/affiliations/lookup",
-    query: { documentNumber: "documentNumber", documentType: "documentType", connectionId: "connectionId", channel: "channel" },
+    query: { documentNumber: "documentNumber", documentType: "documentType", agentMode: "agentMode", connectionId: "connectionId", channel: "channel" },
     response: object([["data", null, union([() => SuraPendingResultCodec, () => SuraRefusalCodec, () => SuraAffiliationCodec, () => SuraNoContractCodec])]]),
     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/sura/appointments/client.d.ts

@@ -70,6 +70,13 @@ export interface Client {
 export declare function createClient(options: ClientOptions): Client;
 export declare function bind(transport: Transport): Client;
 export interface CancelRequest {
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * The channel the caller is waiting on, which sets how long it waits before
      * an answer comes back pending, and puts a phone call's reads ahead of
@@ -121,6 +128,13 @@ export interface CancelResponse {
     success: true;
 }
 export interface CreateRequest {
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * The areaId list_services returned beside that service. Pass it with an
      * exact serviceId to skip a catalog lookup; omit it whenever you are naming
@@ -212,6 +226,13 @@ export interface ListRequest {
      * another cursor.
      */
     limit?: number;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * Which of the organization's SURA connections to run on, by its id. Optional
      * while the organization has one; required when it has several.
@@ -238,9 +259,11 @@ export interface PrepareRequest {
      */
     areaId?: string | null;
     /**
-     * A day to look at, as YYYY-MM-DD. Omit it for the soonest day with room.
-     * Resolve relative dates like "mañana" against the clinic's own timezone
-     * before calling.
+     * A day the person asked for, as YYYY-MM-DD. Its openings come first; when it
+     * has none, the openings nearest to it on either side are offered instead and
+     * requestedDateAvailable is false. Omit it for the soonest openings. Resolve
+     * relative dates like "mañana" against the clinic's own timezone before
+     * calling.
      */
     date?: string | null;
     /**
@@ -257,14 +280,17 @@ export interface PrepareRequest {
      */
     documentType: "ASI" | "CC" | "CD" | "CE" | "CN" | "DE" | "IFE" | "MS" | "NIT" | "NUIP" | "PA" | "PC" | "PD" | "PE" | "PF" | "PT" | "RC" | "RCP" | "RES" | "SC" | "TE" | "TI";
     /**
-     * When true, a requested doctor with no openings falls back automatically to
-     * other doctors of the same service. Present their names and obtain consent
-     * before booking.
+     * Whether other doctors of this service may be offered when the named doctor
+     * has no opening in the searched window. Defaults to true: the named doctor's
+     * openings come first, and only when that doctor has none are the other
+     * doctors' nearest openings returned, with requestedProfessionalAvailable
+     * false. Name the actual doctor of each option and obtain consent before
+     * booking. False keeps the named doctor as a strict filter.
      */
     allowOtherProfessionals?: "true" | "false" | null;
     /**
      * Search from this day onward (YYYY-MM-DD), using the live calendar. Omit for
-     * today. Use date only for an exact day.
+     * today. Use date for a specific day.
      */
     fromDate?: string | null;
     /**
@@ -293,7 +319,10 @@ export interface PrepareRequest {
     mode?: "schedule" | "reschedule" | null;
     /**
      * Doctor's name, or part of it, when the caller asked for someone specific.
-     * Omit it to see whoever has room soonest.
+     * Use list_professionals to check the service's registered doctors
+     * independently of available slots; absence from an open-agenda selector does
+     * not mean the doctor does not exist. Omit it to see whoever has room
+     * soonest.
      */
     professional?: string | null;
     /**
@@ -303,6 +332,13 @@ export interface PrepareRequest {
      * qualifiers.
      */
     serviceId: string;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * Which of the organization's SURA connections to run on, by its id. Optional
      * while the organization has one; required when it has several.

package/dist/sura/appointments/client.js

@@ -30,14 +30,14 @@ const CreateOperation = {
 const ListOperation = {
     method: "GET",
     route: "/v1/sura/appointments",
-    query: { documentNumber: "documentNumber", documentType: "documentType", cursor: "cursor", direction: "direction", limit: "limit", connectionId: "connectionId", channel: "channel" },
+    query: { documentNumber: "documentNumber", documentType: "documentType", cursor: "cursor", direction: "direction", limit: "limit", agentMode: "agentMode", connectionId: "connectionId", channel: "channel" },
     response: object([["data", null, union([() => SuraPendingResultCodec, () => SuraRefusalCodec, () => SuraPatientNotFoundCodec])]]),
     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 PrepareOperation = {
     method: "GET",
     route: "/v1/sura/appointments/prepare",
-    query: { areaId: "areaId", date: "date", documentNumber: "documentNumber", documentType: "documentType", allowOtherProfessionals: "allowOtherProfessionals", fromDate: "fromDate", timeFrom: "timeFrom", timeUntil: "timeUntil", limit: "limit", latestDate: "latestDate", mode: "mode", professional: "professional", serviceId: "serviceId", connectionId: "connectionId", channel: "channel" },
+    query: { areaId: "areaId", date: "date", documentNumber: "documentNumber", documentType: "documentType", allowOtherProfessionals: "allowOtherProfessionals", fromDate: "fromDate", timeFrom: "timeFrom", timeUntil: "timeUntil", limit: "limit", latestDate: "latestDate", mode: "mode", professional: "professional", serviceId: "serviceId", agentMode: "agentMode", connectionId: "connectionId", channel: "channel" },
     response: object([["data", null, union([() => SuraPendingResultCodec, () => SuraRefusalCodec, () => SuraPreparationPatientNotFoundCodec, () => SuraPatientNotFoundCodec, () => SuraPreparationExistingAppointmentCodec, () => SuraPreparationAvailableCodec, () => SuraPreparationNoSlotsCodec])]]),
     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/sura/authorizations/client.d.ts

@@ -38,6 +38,13 @@ export interface LookupRequest {
      * Issuer code before the hyphen in the authorization identifier.
      */
     issuerCode: string;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * Which of the organization's SURA connections to run on, by its id. Optional
      * while the organization has one; required when it has several.

package/dist/sura/authorizations/client.js

@@ -13,7 +13,7 @@ export function bind(transport) {
 const LookupOperation = {
     method: "GET",
     route: "/v1/sura/authorizations/lookup",
-    query: { authorizationNumber: "authorizationNumber", documentNumber: "documentNumber", documentType: "documentType", issuerCode: "issuerCode", connectionId: "connectionId", channel: "channel" },
+    query: { authorizationNumber: "authorizationNumber", documentNumber: "documentNumber", documentType: "documentType", issuerCode: "issuerCode", agentMode: "agentMode", connectionId: "connectionId", channel: "channel" },
     response: object([["data", null, union([() => SuraPendingResultCodec, () => SuraRefusalCodec, () => SuraAuthorizationCodec])]]),
     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/sura/availability/client.d.ts

@@ -49,7 +49,10 @@ export interface ListRequest {
     documentType: "ASI" | "CC" | "CD" | "CE" | "CN" | "DE" | "IFE" | "MS" | "NIT" | "NUIP" | "PA" | "PC" | "PD" | "PE" | "PF" | "PT" | "RC" | "RCP" | "RES" | "SC" | "TE" | "TI";
     /**
      * Doctor's name, or part of it, when the caller asked for someone specific.
-     * Omit it to see whoever has room soonest.
+     * Use list_professionals to check the service's registered doctors
+     * independently of available slots; absence from an open-agenda selector does
+     * not mean the doctor does not exist. Omit it to see whoever has room
+     * soonest.
      */
     professional?: string | null;
     /**
@@ -59,6 +62,13 @@ export interface ListRequest {
      * ask which one instead of guessing.
      */
     serviceId: string;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * Which of the organization's SURA connections to run on, by its id. Optional
      * while the organization has one; required when it has several.

package/dist/sura/availability/client.js

@@ -13,7 +13,7 @@ export function bind(transport) {
 const ListOperation = {
     method: "GET",
     route: "/v1/sura/availability",
-    query: { areaId: "areaId", date: "date", documentNumber: "documentNumber", documentType: "documentType", professional: "professional", serviceId: "serviceId", connectionId: "connectionId", channel: "channel" },
+    query: { areaId: "areaId", date: "date", documentNumber: "documentNumber", documentType: "documentType", professional: "professional", serviceId: "serviceId", agentMode: "agentMode", connectionId: "connectionId", channel: "channel" },
     response: object([["data", null, union([() => SuraPendingResultCodec, () => SuraRefusalCodec, () => SuraPatientNotFoundCodec, () => SuraAvailabilityCodec])]]),
     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/sura/client.d.ts

@@ -7,6 +7,7 @@ import { type Client as ConnectionsClient } from "./connections/client.js";
 import { type Client as CopaysClient } from "./copays/client.js";
 import { type Client as OperationsClient } from "./operations/client.js";
 import { type Client as PatientsClient } from "./patients/client.js";
+import { type Client as ProfessionalsClient } from "./professionals/client.js";
 import { type Client as ServicesClient } from "./services/client.js";
 export interface ClientOptions extends BaseClientOptions {
     /**
@@ -23,6 +24,7 @@ export interface Client {
     readonly copays: CopaysClient;
     readonly operations: OperationsClient;
     readonly patients: PatientsClient;
+    readonly professionals: ProfessionalsClient;
     readonly services: ServicesClient;
 }
 export declare function createClient(options: ClientOptions): Client;

package/dist/sura/client.js

@@ -9,6 +9,7 @@ import { bind as bindConnections, } from "./connections/client.js";
 import { bind as bindCopays, } from "./copays/client.js";
 import { bind as bindOperations, } from "./operations/client.js";
 import { bind as bindPatients, } from "./patients/client.js";
+import { bind as bindProfessionals, } from "./professionals/client.js";
 import { bind as bindServices, } from "./services/client.js";
 export function createClient(options) {
     return bind(new Transport(options));
@@ -22,6 +23,7 @@ export function bind(transport) {
     let copaysClient;
     let operationsClient;
     let patientsClient;
+    let professionalsClient;
     let servicesClient;
     return {
         get affiliations() {
@@ -48,6 +50,9 @@ export function bind(transport) {
         get patients() {
             return (patientsClient ??= bindPatients(transport));
         },
+        get professionals() {
+            return (professionalsClient ??= bindProfessionals(transport));
+        },
         get services() {
             return (servicesClient ??= bindServices(transport));
         },

package/dist/sura/connections/client.d.ts

@@ -54,9 +54,13 @@ export interface DeleteRequest {
      * own organization's.
      */
     id: string;
-    body: {
-        [key: string]: unknown;
-    };
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
 }
 export interface DeleteResponse {
     data: DeletedObject;
@@ -70,6 +74,13 @@ export interface GetRequest {
      * own organization's.
      */
     id: string;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
 }
 export interface GetResponse {
     /**
@@ -94,6 +105,13 @@ export interface ListRequest {
      * another cursor.
      */
     limit?: number;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
 }
 export interface ListResponse {
     data: SuraConnectionPage;
@@ -107,6 +125,13 @@ export interface VerifyRequest {
      * own organization's.
      */
     connectionId: string;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * Agenda only: the institution (IPS) the connection schedules in, which every
      * login must see. Without it, the connection keeps its own, or takes the one

package/dist/sura/connections/client.js

@@ -16,20 +16,21 @@ export function bind(transport) {
 const DeleteOperation = {
     method: "DELETE",
     route: "/v1/sura/connections/{id}",
-    body: "nested",
+    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/sura/connections/{id}",
+    query: { agentMode: "agentMode" },
     response: object([["data", null, () => SuraConnectionCodec]]),
     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/sura/connections",
-    query: { cursor: "cursor", direction: "direction", limit: "limit" },
+    query: { cursor: "cursor", direction: "direction", limit: "limit", agentMode: "agentMode" },
     response: object([["data", null, () => SuraConnectionPageCodec]]),
     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 },
 };

package/dist/sura/copays/client.d.ts

@@ -33,6 +33,13 @@ export interface ListRequest {
      * Explicit four-digit year for copay history, from 2000 to 2099.
      */
     year: string;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * Which of the organization's SURA connections to run on, by its id. Optional
      * while the organization has one; required when it has several.

package/dist/sura/copays/client.js

@@ -13,7 +13,7 @@ export function bind(transport) {
 const ListOperation = {
     method: "GET",
     route: "/v1/sura/copays",
-    query: { documentNumber: "documentNumber", documentType: "documentType", year: "year", connectionId: "connectionId", channel: "channel" },
+    query: { documentNumber: "documentNumber", documentType: "documentType", year: "year", agentMode: "agentMode", connectionId: "connectionId", channel: "channel" },
     response: object([["data", null, union([() => SuraPendingResultCodec, () => SuraRefusalCodec, () => SuraCopayHistoryCodec, () => SuraNoCopayHistoryCodec])]]),
     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/sura/models.d.ts

@@ -449,6 +449,17 @@ export interface SuraPreparationAvailable {
     patient: SuraAvailabilityPatient;
     plan: string | null;
     professional: string | null;
+    /**
+     * Present when a date was given: true when an option falls on that day, false
+     * when it had none and any options are the nearest days to it.
+     */
+    requestedDateAvailable?: boolean;
+    /**
+     * Present when a professional was named: true when the options are that
+     * doctor's, false when that doctor had no opening in the searched window and
+     * any options are other doctors' of the same service.
+     */
+    requestedProfessionalAvailable?: boolean;
     /**
      * False when the bounded search stopped before establishing the requested
      * nearest options.
@@ -501,6 +512,17 @@ export interface SuraPreparationNoSlots {
     patient: SuraAvailabilityPatient;
     plan: string | null;
     professional: string | null;
+    /**
+     * Present when a date was given: true when an option falls on that day, false
+     * when it had none and any options are the nearest days to it.
+     */
+    requestedDateAvailable?: boolean;
+    /**
+     * Present when a professional was named: true when the options are that
+     * doctor's, false when that doctor had no opening in the searched window and
+     * any options are other doctors' of the same service.
+     */
+    requestedProfessionalAvailable?: boolean;
     /**
      * False when the bounded search stopped before establishing the requested
      * nearest options.

package/dist/sura/operations/client.d.ts

@@ -27,6 +27,13 @@ export interface GetRequest {
      * The operationId of the pending answer, exactly as it was returned.
      */
     operationId: string;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * Which of the organization's SURA connections to run on, by its id. Optional
      * while the organization has one; required when it has several.

package/dist/sura/operations/client.js

@@ -13,7 +13,7 @@ export function bind(transport) {
 const GetOperation = {
     method: "GET",
     route: "/v1/sura/operations/{operationId}",
-    query: { connectionId: "connectionId", channel: "channel" },
+    query: { agentMode: "agentMode", connectionId: "connectionId", channel: "channel" },
     response: object([["data", null, union([() => SuraPendingResultCodec, () => SuraRefusalCodec, () => SuraPatientNotFoundCodec, () => SuraPreparationPatientNotFoundCodec, () => SuraPatientFoundCodec, () => SuraAvailabilityCodec, () => SuraPreparationExistingAppointmentCodec, () => SuraPreparationAvailableCodec, () => SuraPreparationNoSlotsCodec, () => SuraBookedAppointmentCodec, () => SuraCancelledAppointmentCodec, () => SuraAffiliationCodec, () => SuraNoContractCodec, () => SuraAuthorizationCodec, () => SuraCopayHistoryCodec, () => SuraNoCopayHistoryCodec])]]),
     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/sura/patients/client.d.ts

@@ -39,6 +39,13 @@ export interface LookupRequest {
      * age or number length.
      */
     documentType: "ASI" | "CC" | "CD" | "CE" | "CN" | "DE" | "IFE" | "MS" | "NIT" | "NUIP" | "PA" | "PC" | "PD" | "PE" | "PF" | "PT" | "RC" | "RCP" | "RES" | "SC" | "TE" | "TI";
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * Which of the organization's SURA connections to run on, by its id. Optional
      * while the organization has one; required when it has several.

package/dist/sura/patients/client.js

@@ -13,7 +13,7 @@ export function bind(transport) {
 const LookupOperation = {
     method: "GET",
     route: "/v1/sura/patients/lookup",
-    query: { documentNumber: "documentNumber", documentType: "documentType", connectionId: "connectionId", channel: "channel" },
+    query: { documentNumber: "documentNumber", documentType: "documentType", agentMode: "agentMode", connectionId: "connectionId", channel: "channel" },
     response: object([["data", null, union([() => SuraPendingResultCodec, () => SuraRefusalCodec, () => SuraPatientNotFoundCodec, () => SuraPatientFoundCodec])]]),
     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/sura/professionals/client.d.ts

@@ -0,0 +1,80 @@
+import { type BaseClientOptions, type RequestOptions, Transport } from "../../_/index.js";
+import type { ResponseMetadata } from "../../models.js";
+import { type SuraPendingResult, type SuraRefusal } from "../models.js";
+import type { SuraProfessionalPage } from "./models.js";
+export interface ClientOptions extends BaseClientOptions {
+    /**
+     * The URL the paths of the API are relative to.
+     */
+    baseUrl: string;
+}
+export interface Client {
+    /**
+     * List registered professionals
+     *
+     * List SURA's registered professionals for a service at this connection's
+     * institution, including doctors without published or free appointments.
+     * First obtain serviceId and optionally areaId from list_services. No patient
+     * identity is needed. Follow pageInfo.nextCursor while hasNextPage is true
+     * before concluding a name is absent from this scoped directory. Absence does
+     * not establish that a doctor does not exist or works nowhere else.
+     * Registration does not establish coverage, authorization, or availability:
+     * use prepare_appointment with the patient's evidence and the requested
+     * professional name to find actual slots. Never substitute another doctor
+     * without the patient's agreement. An unreadable or incomplete provider
+     * directory is a technical failure, not an empty list.
+     */
+    list(request: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+}
+export declare function createClient(options: ClientOptions): Client;
+export declare function bind(transport: Transport): Client;
+export interface ListRequest {
+    /**
+     * The areaId list_services returned beside that service. Pass it with an
+     * exact serviceId to skip a catalog lookup; omit it whenever you are naming
+     * the service in words.
+     */
+    areaId?: string | null;
+    /**
+     * Exact numeric service id returned by list_services. This directory is not
+     * filtered by patient coverage or available appointments.
+     */
+    serviceId: string;
+    /**
+     * 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;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
+    /**
+     * Which of the organization's SURA connections to run on, by its id. Optional
+     * while the organization has one; required when it has several.
+     */
+    connectionId?: string;
+    /**
+     * The channel the caller is waiting on, which sets how long it waits before
+     * an answer comes back pending, and puts a phone call's reads ahead of
+     * others. Defaults to web.
+     */
+    channel?: "voice" | "whatsapp" | "web";
+}
+export interface ListResponse {
+    data: SuraPendingResult | SuraRefusal | SuraProfessionalPage;
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}

package/dist/sura/professionals/client.js

@@ -0,0 +1,19 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { Transport, object, union, } from "../../_/index.js";
+import { SuraPendingResultCodec, SuraRefusalCodec, } from "../models.js";
+export function createClient(options) {
+    return bind(new Transport(options));
+}
+export function bind(transport) {
+    return {
+        list: (request, options) => transport.send(ListOperation, request, options),
+    };
+}
+const ListOperation = {
+    method: "GET",
+    route: "/v1/sura/professionals",
+    query: { areaId: "areaId", serviceId: "serviceId", cursor: "cursor", direction: "direction", limit: "limit", agentMode: "agentMode", connectionId: "connectionId", channel: "channel" },
+    response: object([["data", null, union([() => SuraPendingResultCodec, () => SuraRefusalCodec])]]),
+    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/sura/professionals/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, ListRequest, ListResponse, } from "./client.js";
+export type { SuraProfessional, SuraProfessionalPage, } from "./models.js";

package/dist/sura/professionals/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/sura/professionals/models.d.ts

@@ -0,0 +1,28 @@
+import type { PageInfo } from "../../models.js";
+export interface SuraProfessional {
+    areaId: string;
+    availabilityChecked: false;
+    /**
+     * Opaque directory identity. Use name, not this id, when requesting
+     * availability.
+     */
+    id: string;
+    name: string;
+    registered: true;
+    serviceId: string;
+    serviceName: string;
+}
+export interface SuraProfessionalPage {
+    /**
+     * Items admitted by this resource contract within the verified organization.
+     */
+    data: SuraProfessional[];
+    /**
+     * Discriminator for a resource list response.
+     */
+    object: "list";
+    /**
+     * Opaque navigation cursors for this page’s stable keyset order.
+     */
+    pageInfo: PageInfo;
+}

package/dist/sura/professionals/models.js

@@ -0,0 +1,3 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+export {};

package/dist/sura/services/client.d.ts

@@ -47,6 +47,13 @@ export interface ListRequest {
      * another cursor.
      */
     limit?: number;
+    /**
+     * Set agentMode=true when calling this tool for an AI agent. The answer is
+     * concise Spanish text instead of JSON. Omit it for structured machine data.
+     * This changes presentation only, never authorization, consent or
+     * idempotency.
+     */
+    agentMode?: boolean;
     /**
      * Which of the organization's SURA connections to run on, by its id. Optional
      * while the organization has one; required when it has several.

package/dist/sura/services/client.js

@@ -13,7 +13,7 @@ export function bind(transport) {
 const ListOperation = {
     method: "GET",
     route: "/v1/sura/services",
-    query: { areaId: "areaId", cursor: "cursor", direction: "direction", limit: "limit", connectionId: "connectionId", channel: "channel" },
+    query: { areaId: "areaId", cursor: "cursor", direction: "direction", limit: "limit", agentMode: "agentMode", connectionId: "connectionId", channel: "channel" },
     response: object([["data", null, union([() => SuraPendingResultCodec, () => SuraRefusalCodec])]]),
     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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbol-ai/sdk",
-  "version": "2.6.0",
+  "version": "2.8.0",
   "description": "The Arbol API for TypeScript and JavaScript, generated by Cloudflare Forge from the platform's public OpenAPI.",
   "keywords": [
     "arbol",
@@ -50,8 +50,8 @@
   "packageManager": "bun@1.4.3",
   "arbol": {
     "openapi": {
-      "release": "1.20261021.142621",
-      "sha256": "38b2a1f8990668b3b55c4da7ee4ecc6b906464cb5fd58e3dd448889b6145fd36"
+      "release": "1.20261023.13947",
+      "sha256": "1c5faf8f909599f3c67cb00c9370946d6ffd505ee2885a7d62170f253b3c736d"
     }
   }
 }