@awesomate/sdk 0.64.0 → 0.66.0

package/dist/index.d.ts

@@ -26,7 +26,7 @@
  * Docs: https://hub.awesomate.ai/docs/sdk/
  */
 /** This package's version, sent to the hub with every server call. */
-export declare const VERSION = "0.64.0";
+export declare const VERSION = "0.66.0";
 /** Augmented by the generated awesomate.d.ts, so each kind's rows are typed. */
 export interface Kinds {
 }
@@ -1036,6 +1036,19 @@ export declare class AwesomateClient {
          * `abn`); `abn: null` clears it.
          */
         upsert: (spec: CompanySpec) => Promise<CompanyUpsertResult>;
+        /**
+         * Hide a company from every list, search and picker. Nothing is deleted: the people at it keep
+         * their company link, and `restore` brings it back. Answers how many people are still linked.
+         */
+        archive: (id: string) => Promise<CompanyArchiveResult>;
+        /** Bring an archived company back, under its current name, for the people still linked to it. */
+        restore: (id: string) => Promise<CompanyArchiveResult>;
+        /** The archived companies, newest first (up to 200; `more` says there are older ones), with how many people are still linked to each. */
+        archived: () => Promise<{
+            companies: ArchivedCompany[];
+            more: boolean;
+            note?: string;
+        }>;
     };
     /**
      * Calls: the calls the account's phone agents took, read by person. Needs the account's token
@@ -1111,16 +1124,13 @@ export declare class AwesomateClient {
          * Null when there is none (an id that is not one never reaches the hub).
          */
         get: (id: string) => Promise<EmailDetail | null>;
-        /** A new draft to list `topic` (a key from `lists()`). `checks.blockers` must be empty before a person can approve it. */
-        draft: (input: {
-            topic: string;
-            doc: EmailDoc;
-        }) => Promise<EmailDraft>;
+        /**
+         * A new draft to list `topic` (a key from `lists()`). `checks.blockers` must be empty before a
+         * person can approve it. `send_at` proposes when it goes (see `EmailDraftInput`).
+         */
+        draft: (input: EmailDraftInput) => Promise<EmailDraft>;
         /** Replace a draft. Once someone approved it, it is refused: a person changes it in the hub. */
-        update: (id: string, input: {
-            topic: string;
-            doc: EmailDoc;
-        }) => Promise<EmailDraft>;
+        update: (id: string, input: EmailDraftInput) => Promise<EmailDraft>;
         /**
          * Throw a draft away. A draft only: an approved, sending or sent email throws `unavailable`
          * (server code `not_a_draft`, the case in `reason`). Nothing is deleted: the draft is stopped
@@ -3637,6 +3647,19 @@ export interface EmailSeriesWrite {
     pending?: true;
     job_id?: string;
 }
+/** What `emails.draft()` and `emails.update()` take. */
+export interface EmailDraftInput {
+    /** The list's key, from `emails.lists()`. */
+    topic: string;
+    doc: EmailDoc;
+    /**
+     * A proposed time it goes: a date and time on the business's own clock (`'2026-10-21T09:00'`) or an
+     * instant with its offset, a few minutes to 60 days ahead; `null` clears it. Only a proposal: the
+     * person who approves it in the hub confirms or changes the time. Needs scheduled emails on the
+     * account (`unavailable`, server code `feature_unavailable`, otherwise). A bad time saves nothing.
+     */
+    send_at?: string | null;
+}
 /** A draft, from `emails.draft()` or `emails.update()`. */
 export interface EmailDraft {
     id: string;
@@ -3655,6 +3678,13 @@ export interface EmailDraft {
     reviewUrl: string;
     /** What happens next, to tell the owner. */
     next: string;
+    /** The proposed time, when one was given and kept. */
+    send_at?: string | null;
+    send_tz?: string | null;
+    /** "Wed 21 Oct, 9:00 am (Sydney time)". */
+    send_when?: string | null;
+    /** Set when the draft was saved but the time given with it was not: why, in a sentence to pass on. */
+    send_at_refused?: string;
 }
 /** One email, from `emails.get()`. */
 export interface EmailDetail {
@@ -3676,6 +3706,12 @@ export interface EmailDetail {
     reviewUrl: string;
     /** Opens, clicks, bounces and replies over time, once sent; null when it could not be read. */
     timeline: unknown;
+    /** When it goes: a draft's proposed time, or the approved one. Null to go when approved. */
+    send_at?: string | null;
+    /** The same time in words, in the zone it was chosen in. */
+    send_when?: string | null;
+    /** Approved and waiting for its time. */
+    scheduled?: boolean;
 }
 /** `emails.discard()`: the draft is stopped and left out of the lists. */
 export interface EmailDiscarded {
@@ -4377,6 +4413,21 @@ export interface CompanySpec {
     /** Other fields by key: website, phone, email, address, or the owner's own. */
     data?: Record<string, unknown>;
 }
+/** What companies.archive() and companies.restore() did. */
+export interface CompanyArchiveResult {
+    id: string;
+    /** True after archive(), false after restore(). */
+    archived: boolean;
+    /** How many people are still linked to the company. */
+    people: number;
+}
+/** An archived company, from companies.archived(). */
+export interface ArchivedCompany {
+    id: string;
+    name: string | null;
+    archived_at: string;
+    people: number;
+}
 /** What companies.upsert() did. */
 export interface CompanyUpsertResult {
     id: string;

package/dist/index.js

@@ -26,7 +26,7 @@
  * Docs: https://hub.awesomate.ai/docs/sdk/
  */
 /** This package's version, sent to the hub with every server call. */
-export const VERSION = '0.64.0';
+export const VERSION = '0.66.0';
 const DEFAULT_BASE = 'https://hub.awesomate.ai';
 /** The one check for a platform `watch_url` (mirrored in the hub's awesomate-knowledge.ts and its MCP). */
 const WATCH_URL = /^https:\/\/[^\s"'<>]+$/i;
@@ -720,6 +720,15 @@ export class AwesomateClient {
          * `abn`); `abn: null` clears it.
          */
         upsert: (spec) => this.request('POST', '/api/my-crm/v1/companies', spec, false),
+        /**
+         * Hide a company from every list, search and picker. Nothing is deleted: the people at it keep
+         * their company link, and `restore` brings it back. Answers how many people are still linked.
+         */
+        archive: (id) => this.request('POST', `/api/my-crm/v1/companies/${encodeURIComponent(String(id))}/archive`, {}, false),
+        /** Bring an archived company back, under its current name, for the people still linked to it. */
+        restore: (id) => this.request('POST', `/api/my-crm/v1/companies/${encodeURIComponent(String(id))}/restore`, {}, false),
+        /** The archived companies, newest first (up to 200; `more` says there are older ones), with how many people are still linked to each. */
+        archived: () => this.request('GET', '/api/my-crm/v1/companies/archived'),
     };
     /**
      * Calls: the calls the account's phone agents took, read by person. Needs the account's token
@@ -801,7 +810,10 @@ export class AwesomateClient {
                 return null;
             return nullIfMissing(this.request('GET', `/api/my-crm/v1/emails/${encodeURIComponent(String(id))}`));
         },
-        /** A new draft to list `topic` (a key from `lists()`). `checks.blockers` must be empty before a person can approve it. */
+        /**
+         * A new draft to list `topic` (a key from `lists()`). `checks.blockers` must be empty before a
+         * person can approve it. `send_at` proposes when it goes (see `EmailDraftInput`).
+         */
         draft: (input) => this.request('POST', '/api/my-crm/v1/emails', input, false),
         /** Replace a draft. Once someone approved it, it is refused: a person changes it in the hub. */
         update: async (id, input) => this.request('PATCH', `/api/my-crm/v1/emails/${emailId(id)}`, input, false),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesomate/sdk",
-  "version": "0.64.0",
+  "version": "0.66.0",
   "description": "Your own Awesomate data from Node and the browser: query contacts and app data with generated types, and sign your app's own users in",
   "license": "MIT",
   "type": "module",