@butlerbot/sdk 0.0.37 → 0.0.38

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { APIPath } from "./config";
 import { Link, LinkOptions } from "./link";
 import { Conversation, ConversationOptions } from "./modules/conversation";
 import { UsagePolicyDataOptions } from "./modules/usage";
-import { type CancelJobOptions, type GetJobJournalOptions, type GetJobOptions, type ListJobsOptions, type UpdateJobOptions, type UpdateJobSettingsOptions } from "./modules/jobs";
+import { type CancelJobOptions, type GetJobJournalOptions, type GetJobOptions, type SetPhaseModelOptions, type ListJobsOptions, type UpdateJobOptions, type UpdateJobSettingsOptions } from "./modules/jobs";
 import { type AnswerDeliveryOptions, type ListDeliveriesOptions } from "./modules/outreach";
 type OptionalApiKey<T> = Omit<T, "apiKey"> & {
     /** Optional API key, defaults to API key specified in client */
@@ -54,6 +54,8 @@ export declare class ButlerBotClient {
     cancelJob(config: OptionalApiKey<CancelJobOptions>): Promise<import("./types/type_registry").JobCancelResponse>;
     /** Changes one job's name, and its autonomy: how far it may act, until when, and what it always asks about */
     updateJob(config: OptionalApiKey<UpdateJobOptions>): Promise<import("./types/type_registry").JobUpdateResponse>;
+    /** Changes the model one phase of a job's plan runs on; only a phase that has not started */
+    setPhaseModel(config: OptionalApiKey<SetPhaseModelOptions>): Promise<import("./types/type_registry").JobPhaseModelResponse>;
     /** Changes this user's job settings: their daily allowance and what new jobs start with */
     updateJobSettings(config?: OptionalApiKey<UpdateJobSettingsOptions>): Promise<import("./types/type_registry").JobSettingsResponse>;
     /** A page of the inbox: what Alfred has told or asked this user outside a chat */

package/dist/index.js

@@ -92,6 +92,10 @@ class ButlerBotClient {
     updateJob(config) {
         return (0, jobs_1.updateJob)(this.forRequest(config));
     }
+    /** Changes the model one phase of a job's plan runs on; only a phase that has not started */
+    setPhaseModel(config) {
+        return (0, jobs_1.setPhaseModel)(this.forRequest(config));
+    }
     /** Changes this user's job settings: their daily allowance and what new jobs start with */
     updateJobSettings(config = {}) {
         return (0, jobs_1.updateJobSettings)(this.forRequest(config));

package/dist/modules/jobs.d.ts

@@ -1,4 +1,4 @@
-import type { JobAutonomy, JobCancelResponse, JobDetailResponse, JobJournalPage, JobListResponse, JobSettingsResponse, JobSettingsUpdate, JobStatus, JobUpdateResponse } from "../types/jobs";
+import type { JobAutonomy, JobCancelResponse, JobDetailResponse, JobJournalPage, JobListResponse, JobPhaseModelResponse, JobSettingsResponse, JobSettingsUpdate, JobStatus, JobUpdateResponse } from "../types/jobs";
 /** What every jobs call needs: where the server is, and who is asking. */
 export type JobsRequestOptions = {
     serverURL?: string;
@@ -38,6 +38,15 @@ export type UpdateJobOptions = JobsRequestOptions & {
     autonomyUntil?: string | number | null;
     /** Things this job asks about however free it otherwise is. */
     alwaysAsk?: string[];
+    /** A ceiling on what the job may spend in all, in dollars. Null clears it. */
+    capUsd?: number | null;
+};
+export type SetPhaseModelOptions = JobsRequestOptions & {
+    jobId: string;
+    /** The phase's id as the plan names it. */
+    phaseId: string;
+    /** One of the detail's `phaseModels`. */
+    model: string;
 };
 export type UpdateJobSettingsOptions = JobsRequestOptions & JobSettingsUpdate;
 /** A page of the caller's jobs, newest first, with what their jobs may spend today. */
@@ -55,5 +64,12 @@ export declare function getJobJournal(options: GetJobJournalOptions): Promise<Jo
 export declare function cancelJob(options: CancelJobOptions): Promise<JobCancelResponse>;
 /** Changes one job's name, and its autonomy: how far it may act, until when, and what it always asks about. */
 export declare function updateJob(options: UpdateJobOptions): Promise<JobUpdateResponse>;
+/**
+ * Changes the model one phase of a job's plan runs on.
+ *
+ * Only a phase that has not started or is blocked: a running or done phase's model is what its
+ * work ran on. A model the owner's plan cannot run is a 400 whose body names the ones it can.
+ */
+export declare function setPhaseModel(options: SetPhaseModelOptions): Promise<JobPhaseModelResponse>;
 /** Changes the owner's job settings: their daily allowance and the autonomy new jobs start with. */
 export declare function updateJobSettings(options: UpdateJobSettingsOptions): Promise<JobSettingsResponse>;

package/dist/modules/jobs.js

@@ -5,6 +5,7 @@ exports.getJob = getJob;
 exports.getJobJournal = getJobJournal;
 exports.cancelJob = cancelJob;
 exports.updateJob = updateJob;
+exports.setPhaseModel = setPhaseModel;
 exports.updateJobSettings = updateJobSettings;
 const config_1 = require("../config");
 const url_formatter_1 = require("../util/url_formatter");
@@ -56,10 +57,25 @@ async function updateJob(options) {
     return (0, api_request_1.requestAPI)({
         url,
         method: "PATCH",
-        body: body({ title: options.title, autonomy: options.autonomy, autonomyUntil: options.autonomyUntil, alwaysAsk: options.alwaysAsk }),
+        body: body({ title: options.title, autonomy: options.autonomy, autonomyUntil: options.autonomyUntil, alwaysAsk: options.alwaysAsk, capUsd: options.capUsd }),
         action: `update job ${options.jobId}`,
     });
 }
+/**
+ * Changes the model one phase of a job's plan runs on.
+ *
+ * Only a phase that has not started or is blocked: a running or done phase's model is what its
+ * work ran on. A model the owner's plan cannot run is a 400 whose body names the ones it can.
+ */
+async function setPhaseModel(options) {
+    const url = (0, url_formatter_1.formatURL)(`${jobsBase(options)}/${encodeURIComponent(options.jobId)}/plan/${encodeURIComponent(options.phaseId)}`, {}, { apiKey: options.apiKey, debug: options.debug });
+    return (0, api_request_1.requestAPI)({
+        url,
+        method: "PATCH",
+        body: { model: options.model },
+        action: `set the model of phase ${options.phaseId} of job ${options.jobId}`,
+    });
+}
 /** Changes the owner's job settings: their daily allowance and the autonomy new jobs start with. */
 async function updateJobSettings(options) {
     const endpoint = (options.serverURL || config_1.CONFIG.server) + (options.path || config_1.CONFIG.paths.jobs.settings);

package/dist/types/jobs/job.d.ts

@@ -31,6 +31,13 @@ export type JobView = {
     reviewRounds: number;
     /** What the job has spent in total, in USD. */
     spentUsd: number;
+    /**
+     * A ceiling on what this job may spend over its whole life, in dollars, or null for none.
+     *
+     * Measured against everything the job and its sub-jobs have spent. A job that reaches it
+     * with work left parks blocked and asks; raising it starts the job again.
+     */
+    capUsd: number | null;
     /** What the job has spent today, in USD. */
     spendTodayUsd: number;
     /** How many questions of this job's are waiting on the user. */
@@ -73,7 +80,7 @@ export type JobAllowanceRefused = {
 export type JobAllowance = JobAllowanceGranted | JobAllowanceRefused;
 /** Whether an allowance is a refusal rather than a grant. */
 export declare function isJobAllowanceRefused(allowance: JobAllowance): allowance is JobAllowanceRefused;
-export type JobPlanPhaseKind = "plan" | "work" | "review";
+export type JobPlanPhaseKind = "plan" | "work" | "map" | "review";
 export type JobPlanPhaseStatus = "pending" | "running" | "blocked" | "done";
 /** One phase of a job's plan, as the plan card spells it out. */
 export type JobPlanPhase = {
@@ -182,6 +189,13 @@ export type JobDetailResponse = {
     journalTotal: number;
     /** Questions of this job's nobody has answered yet. */
     openDeliveries: Delivery[];
+    /** The model names a phase of this job may be set to: the aliases first, then the tier's models. */
+    phaseModels: string[];
+};
+/** A phase after its model was changed. */
+export type JobPhaseModelResponse = {
+    success: true;
+    phase: JobPlanPhase;
 };
 /** One page of a job's journal. Page 1 is the newest; within a page the entries are in written order. */
 export type JobJournalPage = {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@butlerbot/sdk",
-	"version": "0.0.37",
+	"version": "0.0.38",
 	"description": "The official ButlerBot SDK",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/readme.md

@@ -332,14 +332,17 @@ const { jobs, allowance, spentTodayUsd } = await client.listJobs({ status: "runn
 const { job, plan, journal, journalTotal, openDeliveries, autonomyLine } = await client.getJob({ jobId });
 const { entries, hasMore } = await client.getJobJournal({ jobId, page: 2 });
 
-await client.updateJob({ jobId, title: "Flat hunt", autonomy: "free", autonomyUntil: Date.now() + 86_400_000 });
+await client.updateJob({ jobId, title: "Flat hunt", autonomy: "free", autonomyUntil: Date.now() + 86_400_000, capUsd: 5 });
+await client.setPhaseModel({ jobId, phaseId: "search", model: "Butler-Auto-Smart" });
 await client.cancelJob({ jobId });
 ```
 
 `getJob` carries the newest page of the journal and `journalTotal`; `getJobJournal` pages the rest,
 newest page first, with each page in the order its entries were written and `hasMore` saying whether
 an older page exists. Each entry says which shift wrote it (`shiftIndex`, `shiftKind`) and on which
-model. A job's `title` is a few words of its own, set at start or renamed with `updateJob`.
+model. A job's `title` is a few words of its own, set at start or renamed with `updateJob`, which
+also takes `capUsd`, a ceiling on what the job may spend in all (null clears it). `setPhaseModel`
+changes the model a phase that has not started runs on, to one of the detail's `phaseModels`.
 
 Paging is 1-based, and every listing answers with `page`, `limit` and `total`. A listing also
 carries `allowance` — what this user's jobs may spend today and what is left of it, or