@arbol-ai/sdk 2.3.0 → 2.5.0

package/dist/agenda/appointments/client.d.ts

@@ -123,6 +123,16 @@ export interface ListRequest {
      * channel was never recorded.
      */
     bookingChannel?: string | null;
+    /**
+     * Inclusive creation instant, independent of the appointment date. Pair with
+     * createdBefore; at most 93 days.
+     */
+    createdAfter?: Temporal.Instant;
+    /**
+     * Exclusive creation instant. Use for appointments generated during a period,
+     * including future appointments.
+     */
+    createdBefore?: Temporal.Instant;
     /**
      * Principal reference of whoever booked it.
      */

package/dist/agenda/appointments/client.js

@@ -33,7 +33,7 @@ const ListOperation = {
     method: "POST",
     route: "/v1/agenda/appointments/search",
     body: "flat",
-    request: object([["from", null, instant], ["to", null, instant]]),
+    request: object([["createdAfter", null, instant], ["createdBefore", null, instant], ["from", null, instant], ["to", null, instant]]),
     response: object([["data", null, () => AgendaAppointmentPageCodec]]),
     errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "426": true, "429": true, "500": true, "502": true, "503": true, "504": true },
 };

package/dist/agenda/client.d.ts

@@ -5,6 +5,7 @@ import { type Client as BookingsClient } from "./bookings/client.js";
 import { type Client as LocationsClient } from "./locations/client.js";
 import { type Client as OfferingsClient } from "./offerings/client.js";
 import { type Client as ResourcesClient } from "./resources/client.js";
+import { type Client as ScheduleRulesClient } from "./scheduleRules/client.js";
 import { type Client as ServicesClient } from "./services/client.js";
 import { type Client as WaitlistClient } from "./waitlist/client.js";
 export interface ClientOptions extends BaseClientOptions {
@@ -20,6 +21,7 @@ export interface Client {
     readonly locations: LocationsClient;
     readonly offerings: OfferingsClient;
     readonly resources: ResourcesClient;
+    readonly scheduleRules: ScheduleRulesClient;
     readonly services: ServicesClient;
     readonly waitlist: WaitlistClient;
 }

package/dist/agenda/client.js

@@ -7,6 +7,7 @@ import { bind as bindBookings, } from "./bookings/client.js";
 import { bind as bindLocations, } from "./locations/client.js";
 import { bind as bindOfferings, } from "./offerings/client.js";
 import { bind as bindResources, } from "./resources/client.js";
+import { bind as bindScheduleRules, } from "./scheduleRules/client.js";
 import { bind as bindServices, } from "./services/client.js";
 import { bind as bindWaitlist, } from "./waitlist/client.js";
 export function createClient(options) {
@@ -19,6 +20,7 @@ export function bind(transport) {
     let locationsClient;
     let offeringsClient;
     let resourcesClient;
+    let scheduleRulesClient;
     let servicesClient;
     let waitlistClient;
     return {
@@ -40,6 +42,9 @@ export function bind(transport) {
         get resources() {
             return (resourcesClient ??= bindResources(transport));
         },
+        get scheduleRules() {
+            return (scheduleRulesClient ??= bindScheduleRules(transport));
+        },
         get services() {
             return (servicesClient ??= bindServices(transport));
         },

package/dist/agenda/offerings/client.d.ts

@@ -1,6 +1,6 @@
 import { type BaseClientOptions, type RequestOptions, Transport } from "../../_/index.js";
 import type { ResponseMetadata } from "../../models.js";
-import { type AgendaOfferingPage } from "./models.js";
+import { type AgendaOffering, type AgendaOfferingPage } from "./models.js";
 export interface ClientOptions extends BaseClientOptions {
     /**
      * The URL the paths of the API are relative to.
@@ -8,6 +8,13 @@ export interface ClientOptions extends BaseClientOptions {
     baseUrl: string;
 }
 export interface Client {
+    /**
+     * Create Offering
+     *
+     * Attach a service to an agenda with its scheduling requirements, duration,
+     * eligibility and intake policy.
+     */
+    create(request: CreateRequest, options?: RequestOptions): Promise<CreateResponse>;
     /**
      * List Offerings
      *
@@ -15,9 +22,83 @@ export interface Client {
      * active-state filters.
      */
     list(request?: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+    /**
+     * Update Offering
+     *
+     * Update the offering named in the path using its expected version.
+     */
+    update(request: UpdateRequest, options?: RequestOptions): Promise<UpdateResponse>;
 }
 export declare function createClient(options: ClientOptions): Client;
 export declare function bind(transport: Transport): Client;
+export interface CreateRequest {
+    /**
+     * Farthest number of days ahead that this offering can be booked.
+     */
+    bookingHorizonDays?: number;
+    /**
+     * Resource occupation added after the visible appointment, in minutes.
+     */
+    bufferAfterMinutes?: number;
+    /**
+     * Resource occupation added before the visible appointment, in minutes.
+     */
+    bufferBeforeMinutes?: number;
+    /**
+     * Maximum concurrent units this resource or offering can accept.
+     */
+    capacity?: number;
+    /**
+     * Bounded JSON configuration owned by this catalog record, including
+     * supported domain settings.
+     */
+    details?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Visible appointment duration for this offering, in minutes; resource
+     * buffers apply separately.
+     */
+    durationMinutes: number;
+    /**
+     * Minimum advance notice in minutes before this offering can be booked.
+     */
+    minNoticeMinutes?: number;
+    /**
+     * Display name of this catalog or configuration record.
+     */
+    name: string;
+    /**
+     * Resource kinds, quantities and explicit alternatives needed by this
+     * offering.
+     */
+    resourceRequirements?: {
+        alternatives?: string[];
+        kind: "practitioner" | "assistant" | "room" | "chair" | "equipment" | "location" | "team" | "generic";
+        quantity?: number;
+        required?: boolean;
+    }[];
+    /**
+     * Stable svc-prefixed Scheduling record identifier; ownership is checked in
+     * the authenticated organization.
+     */
+    serviceId: string;
+    /**
+     * Minute spacing between candidate appointment start times.
+     */
+    slotIntervalMinutes?: number;
+    /**
+     * Lifecycle state controlling whether this record remains available to its
+     * domain consumers.
+     */
+    status?: "active" | "inactive";
+}
+export interface CreateResponse {
+    data: AgendaOffering;
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}
 export interface ListRequest {
     /**
      * Opaque cursor returned by pageInfo; omit it to request the first page.
@@ -49,3 +130,66 @@ export interface ListResponse {
     metadata: ResponseMetadata;
     success: true;
 }
+export interface UpdateRequest {
+    /**
+     * Stable off-prefixed Scheduling record identifier; ownership is checked in
+     * the authenticated organization.
+     */
+    id: string;
+    /**
+     * Farthest number of days ahead that this offering can be booked.
+     */
+    bookingHorizonDays?: number;
+    /**
+     * Resource occupation added after the visible appointment, in minutes.
+     */
+    bufferAfterMinutes?: number;
+    /**
+     * Resource occupation added before the visible appointment, in minutes.
+     */
+    bufferBeforeMinutes?: number;
+    /**
+     * Maximum concurrent units this resource or offering can accept.
+     */
+    capacity?: number;
+    /**
+     * Bounded JSON configuration owned by this catalog record, including
+     * supported domain settings.
+     */
+    details?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Visible appointment duration for this offering, in minutes; resource
+     * buffers apply separately.
+     */
+    durationMinutes?: number;
+    /**
+     * Version last read by the caller. The mutation fails if another writer has
+     * changed this record.
+     */
+    expectedVersion: number;
+    /**
+     * Minimum advance notice in minutes before this offering can be booked.
+     */
+    minNoticeMinutes?: number;
+    /**
+     * Display name of this catalog or configuration record.
+     */
+    name?: string;
+    /**
+     * Minute spacing between candidate appointment start times.
+     */
+    slotIntervalMinutes?: number;
+    /**
+     * Lifecycle state controlling whether this record remains available to its
+     * domain consumers.
+     */
+    status?: "active" | "inactive";
+}
+export interface UpdateResponse {
+    data: AgendaOffering;
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}

package/dist/agenda/offerings/client.js

@@ -1,15 +1,24 @@
 // Code generated by forge. DO NOT EDIT.
 /* eslint-disable */
 import { Transport, object, } from "../../_/index.js";
-import { AgendaOfferingPageCodec } from "./models.js";
+import { AgendaOfferingCodec, AgendaOfferingPageCodec, } 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),
         list: (request, options) => transport.send(ListOperation, request, options),
+        update: (request, options) => transport.send(UpdateOperation, request, options),
     };
 }
+const CreateOperation = {
+    method: "POST",
+    route: "/v1/agenda/offerings",
+    body: "flat",
+    response: object([["data", null, () => AgendaOfferingCodec]]),
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "426": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+};
 const ListOperation = {
     method: "GET",
     route: "/v1/agenda/offerings",
@@ -17,3 +26,10 @@ const ListOperation = {
     response: object([["data", null, () => AgendaOfferingPageCodec]]),
     errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "426": true, "429": true, "500": true, "502": true, "503": true, "504": true },
 };
+const UpdateOperation = {
+    method: "PATCH",
+    route: "/v1/agenda/offerings/{id}",
+    body: "flat",
+    response: object([["data", null, () => AgendaOfferingCodec]]),
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "426": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+};

package/dist/agenda/offerings/index.d.ts

@@ -1,5 +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 { Client, ClientOptions, CreateRequest, CreateResponse, ListRequest, ListResponse, UpdateRequest, UpdateResponse, } from "./client.js";
 export type { AgendaOffering, AgendaOfferingPage, } from "./models.js";

package/dist/agenda/resources/client.d.ts

@@ -1,6 +1,6 @@
 import { type BaseClientOptions, type RequestOptions, Transport } from "../../_/index.js";
 import type { ResponseMetadata } from "../../models.js";
-import { type AgendaResourcePage } from "./models.js";
+import { type AgendaResource, type AgendaResourcePage } from "./models.js";
 export interface ClientOptions extends BaseClientOptions {
     /**
      * The URL the paths of the API are relative to.
@@ -8,6 +8,13 @@ export interface ClientOptions extends BaseClientOptions {
     baseUrl: string;
 }
 export interface Client {
+    /**
+     * Create Resource
+     *
+     * Create a professional, room or equipment agenda with its capacity and
+     * booking policy.
+     */
+    create(request: CreateRequest, options?: RequestOptions): Promise<CreateResponse>;
     /**
      * List Resources
      *
@@ -15,9 +22,58 @@ export interface Client {
      * pagination.
      */
     list(request?: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+    /**
+     * Update Resource
+     *
+     * Update the agenda named in the path using its expected version.
+     */
+    update(request: UpdateRequest, options?: RequestOptions): Promise<UpdateResponse>;
 }
 export declare function createClient(options: ClientOptions): Client;
 export declare function bind(transport: Transport): Client;
+export interface CreateRequest {
+    /**
+     * Maximum simultaneous capacity units available on this resource; each
+     * booking consumes its declared share.
+     */
+    capacity?: number;
+    /**
+     * Bounded JSON configuration owned by this catalog record, including
+     * supported domain settings.
+     */
+    details?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Resource category used to match booking requirements, such as practitioner,
+     * room or equipment.
+     */
+    kind: "practitioner" | "assistant" | "room" | "chair" | "equipment" | "location" | "team" | "generic";
+    /**
+     * Clinic site associated with this record; null means it is not tied to a
+     * site.
+     */
+    locationId?: string | null;
+    /**
+     * Display name of this catalog or configuration record.
+     */
+    name: string;
+    /**
+     * Lifecycle state controlling whether this record remains available to its
+     * domain consumers.
+     */
+    status?: "active" | "inactive";
+    /**
+     * IANA timezone used to interpret the record’s local dates and time bands.
+     */
+    timezone: string;
+}
+export interface CreateResponse {
+    data: AgendaResource;
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}
 export interface ListRequest {
     /**
      * Opaque cursor returned by pageInfo; omit it to request the first page.
@@ -48,3 +104,56 @@ export interface ListResponse {
     metadata: ResponseMetadata;
     success: true;
 }
+export interface UpdateRequest {
+    /**
+     * Stable srs-prefixed Scheduling record identifier; ownership is checked in
+     * the authenticated organization.
+     */
+    id: string;
+    /**
+     * Maximum simultaneous capacity units available on this resource; each
+     * booking consumes its declared share.
+     */
+    capacity?: number;
+    /**
+     * Bounded JSON configuration owned by this catalog record, including
+     * supported domain settings.
+     */
+    details?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Version last read by the caller. The mutation fails if another writer has
+     * changed this record.
+     */
+    expectedVersion: number;
+    /**
+     * Resource category used to match booking requirements, such as practitioner,
+     * room or equipment.
+     */
+    kind?: "practitioner" | "assistant" | "room" | "chair" | "equipment" | "location" | "team" | "generic";
+    /**
+     * Clinic site associated with this record; null means it is not tied to a
+     * site.
+     */
+    locationId?: string | null;
+    /**
+     * Display name of this catalog or configuration record.
+     */
+    name?: string;
+    /**
+     * Lifecycle state controlling whether this record remains available to its
+     * domain consumers.
+     */
+    status?: "active" | "inactive";
+    /**
+     * IANA timezone used to interpret the record’s local dates and time bands.
+     */
+    timezone?: string;
+}
+export interface UpdateResponse {
+    data: AgendaResource;
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}

package/dist/agenda/resources/client.js

@@ -1,15 +1,24 @@
 // Code generated by forge. DO NOT EDIT.
 /* eslint-disable */
 import { Transport, object, } from "../../_/index.js";
-import { AgendaResourcePageCodec } from "./models.js";
+import { AgendaResourceCodec, AgendaResourcePageCodec, } 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),
         list: (request, options) => transport.send(ListOperation, request, options),
+        update: (request, options) => transport.send(UpdateOperation, request, options),
     };
 }
+const CreateOperation = {
+    method: "POST",
+    route: "/v1/agenda/resources",
+    body: "flat",
+    response: object([["data", null, () => AgendaResourceCodec]]),
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "426": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+};
 const ListOperation = {
     method: "GET",
     route: "/v1/agenda/resources",
@@ -17,3 +26,10 @@ const ListOperation = {
     response: object([["data", null, () => AgendaResourcePageCodec]]),
     errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "426": true, "429": true, "500": true, "502": true, "503": true, "504": true },
 };
+const UpdateOperation = {
+    method: "PATCH",
+    route: "/v1/agenda/resources/{id}",
+    body: "flat",
+    response: object([["data", null, () => AgendaResourceCodec]]),
+    errors: { "400": true, "401": true, "403": true, "404": true, "405": true, "409": true, "413": true, "415": true, "426": true, "429": true, "500": true, "502": true, "503": true, "504": true },
+};

package/dist/agenda/resources/index.d.ts

@@ -1,5 +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 { Client, ClientOptions, CreateRequest, CreateResponse, ListRequest, ListResponse, UpdateRequest, UpdateResponse, } from "./client.js";
 export type { AgendaResource, AgendaResourcePage, } from "./models.js";

package/dist/agenda/scheduleRules/client.d.ts

@@ -0,0 +1,188 @@
+import { type BaseClientOptions, type RequestOptions, Transport } from "../../_/index.js";
+import type { ResponseMetadata } from "../../models.js";
+export interface ClientOptions extends BaseClientOptions {
+    /**
+     * The URL the paths of the API are relative to.
+     */
+    baseUrl: string;
+}
+export interface Client {
+    /**
+     * List Schedule Rules
+     *
+     * Read the agenda’s weekly bands and dated overrides in its local timezone.
+     */
+    list(request?: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+    /**
+     * Replace Schedule Rules
+     *
+     * Replace the agenda’s complete working-rule set atomically using its
+     * expected resource version.
+     */
+    replace(request: ReplaceRequest, options?: RequestOptions): Promise<ReplaceResponse>;
+    /**
+     * Upsert Schedule Rule
+     *
+     * Write one working rule for the agenda using the expected resource version.
+     */
+    upsert(request: UpsertRequest, options?: RequestOptions): Promise<UpsertResponse>;
+}
+export declare function createClient(options: ClientOptions): Client;
+export declare function bind(transport: Transport): Client;
+export interface ListRequest {
+    /**
+     * Scheduling resource addressed by this request or associated with this
+     * record.
+     */
+    resourceId?: string;
+}
+export interface ListResponse {
+    data: {
+        data: {
+            date: Temporal.PlainDate | null;
+            effectiveFrom: Temporal.PlainDate | null;
+            effectiveTo: Temporal.PlainDate | null;
+            endTime: string;
+            id: string;
+            kind: "weekly" | "date_override" | "time_off" | "block";
+            object: "scheduling.schedule_rule";
+            resourceId: string;
+            schemaVersion: 1;
+            startTime: string;
+            timezone: string;
+            updatedAt: Temporal.Instant;
+            version: number;
+            weekdays: number[];
+        }[];
+        object: "list";
+    };
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}
+export interface ReplaceRequest {
+    /**
+     * Stable srs-prefixed Scheduling record identifier; ownership is checked in
+     * the authenticated organization.
+     */
+    resourceId: string;
+    /**
+     * Identifiers and versions of the complete schedule loaded by the editor;
+     * concurrent changes reject the replacement.
+     */
+    expectedRules: {
+        id: string;
+        version: number;
+    }[];
+    /**
+     * Schedule bands or profile policy rules owned by this configuration.
+     */
+    rules: {
+        date?: Temporal.PlainDate | null;
+        effectiveFrom?: Temporal.PlainDate | null;
+        effectiveTo?: Temporal.PlainDate | null;
+        endTime: string;
+        kind: "weekly" | "date_override" | "time_off" | "block";
+        startTime: string;
+        weekdays?: number[];
+    }[];
+}
+export interface ReplaceResponse {
+    data: {
+        data: {
+            date: Temporal.PlainDate | null;
+            effectiveFrom: Temporal.PlainDate | null;
+            effectiveTo: Temporal.PlainDate | null;
+            endTime: string;
+            id: string;
+            kind: "weekly" | "date_override" | "time_off" | "block";
+            object: "scheduling.schedule_rule";
+            resourceId: string;
+            schemaVersion: 1;
+            startTime: string;
+            timezone: string;
+            updatedAt: Temporal.Instant;
+            version: number;
+            weekdays: number[];
+        }[];
+        object: "list";
+    };
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}
+export interface UpsertRequest {
+    /**
+     * Scheduling resource addressed by this request or associated with this
+     * record.
+     */
+    resourceId: string;
+    /**
+     * Specific local calendar date for a dated band or closure; null for a weekly
+     * band.
+     */
+    date?: Temporal.PlainDate | null;
+    /**
+     * First local date on which this weekly band applies; null means no lower
+     * date bound.
+     */
+    effectiveFrom?: Temporal.PlainDate | null;
+    /**
+     * Last local date on which this weekly band applies; null means no upper date
+     * bound.
+     */
+    effectiveTo?: Temporal.PlainDate | null;
+    /**
+     * End of this local time band in HH:MM, interpreted in its resource’s
+     * timezone.
+     */
+    endTime: string;
+    /**
+     * Version last read by the caller. The mutation fails if another writer has
+     * changed this record.
+     */
+    expectedVersion?: number;
+    /**
+     * Identifier of the record addressed or returned by this schema.
+     */
+    id?: string;
+    /**
+     * Declared domain kind of this record or configuration element.
+     */
+    kind: "weekly" | "date_override" | "time_off" | "block";
+    /**
+     * Start of this local time band in HH:MM, interpreted in its resource’s
+     * timezone.
+     */
+    startTime: string;
+    /**
+     * IANA timezone used to interpret the record’s local dates and time bands.
+     */
+    timezone: string;
+    /**
+     * Local weekdays on which a weekly band applies, numbered Sunday 0 through
+     * Saturday 6.
+     */
+    weekdays?: number[];
+}
+export interface UpsertResponse {
+    data: {
+        date: Temporal.PlainDate | null;
+        effectiveFrom: Temporal.PlainDate | null;
+        effectiveTo: Temporal.PlainDate | null;
+        endTime: string;
+        id: string;
+        kind: "weekly" | "date_override" | "time_off" | "block";
+        object: "scheduling.schedule_rule";
+        resourceId: string;
+        schemaVersion: 1;
+        startTime: string;
+        timezone: string;
+        updatedAt: Temporal.Instant;
+        version: number;
+        weekdays: number[];
+    };
+    error: null;
+    metadata: ResponseMetadata;
+    success: true;
+}