@awesomate/sdk 0.65.0 → 0.67.1

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.65.0";
+export declare const VERSION = "0.67.1";
 /** 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
@@ -1350,6 +1363,24 @@ export declare class AwesomateClient {
          */
         setReplay: (id: number, url: string) => Promise<WebinarDetail>;
     };
+    /**
+     * Payments into the business's own Stripe account (never Awesomate's), connected in the hub.
+     * `status()` says where that account stands: connected or not, ready to take payments, live or
+     * test, what Stripe still needs, and the connected account's id and Stripe Dashboard. Connecting,
+     * finishing set-up and disconnecting are done by the account owner in the hub (`settings_url`);
+     * no method here starts them, and nothing here takes a Stripe key. Needs the account owner's own
+     * token with payments:read (never a team member's key, like the Stripe card in the hub) and the
+     * account's payments feature, a part of Contacts.
+     *
+     * @example
+     * const pay = await db.payments.status();
+     * if (!pay.ready) console.log(pay.next, pay.settings_url);
+     * else console.log(`Payments go to ${pay.account?.display_name} (${pay.account?.account_id})`);
+     */
+    readonly payments: {
+        /** Where the business's Stripe account stands, with one sentence (`next`) saying what happens next. */
+        status: () => Promise<PaymentsStatus>;
+    };
     /**
      * The account's own support desk: the help inbox for its customers, under Contacts, Support in
      * the hub. Read only, on purpose: every message here was written by someone outside the
@@ -2967,7 +2998,7 @@ export interface WhoAmI {
     };
     /** The account's plan (Essentials, Support Plus, Pro, Embedded), or null when it could not be read. */
     plan: string | null;
-    /** What the token may do: crm:read, crm:write, files:read, knowledge:read, hosting:read... */
+    /** What the token may do: crm:read, crm:write, files:read, knowledge:read, payments:read, hosting:read... */
     scopes: string[];
     /** When the token stops working, or null for a browser session. */
     tokenExpiresAt: string | null;
@@ -3400,6 +3431,8 @@ export interface ContactErasureCounts {
     sign_in_links: number;
     /** Their rows in past imports. */
     import_rows: number;
+    /** Lines of their conversation with an app's assistant: deleted, with its settings and drafts. Absent on accounts that never switched it on. */
+    assistant_chat?: number;
 }
 /** What contacts.erasurePreview() answers. Nothing has been erased. */
 export interface ContactErasurePreview {
@@ -4000,6 +4033,44 @@ export interface ZoomHost {
     /** How many a Zoom Webinar of theirs holds, when Zoom said. */
     webinar_capacity: number | null;
 }
+/** payments.status(): where the business's own Stripe account stands. */
+export interface PaymentsStatus {
+    /** Payments are open on this hub. */
+    available: boolean;
+    /** 'live' on production, 'test' on staging; null while payments are not open. */
+    mode: 'live' | 'test' | null;
+    /** Where it stands, in one word. */
+    state: 'not_available' | 'not_connected' | 'finish_setting_up' | 'stripe_needs_more' | 'ready';
+    /** A Stripe account is connected. */
+    connected: boolean;
+    /** Stripe can take payments for it. */
+    ready: boolean;
+    /** The connected account, or null when there is none. */
+    account: null | {
+        /** Stripe's id for the account (acct_...); not a secret. */
+        account_id: string;
+        display_name: string | null;
+        /** Two letters, such as AU. */
+        country: string | null;
+        /** Lower case, such as aud. */
+        default_currency: string | null;
+        livemode: boolean;
+        charges_enabled: boolean;
+        payouts_enabled: boolean;
+        details_submitted: boolean;
+        /** How many things Stripe still needs from the business. */
+        requirements_due: number;
+        /** Stripe's own reason the account is paused, when it is. */
+        disabled_reason: string | null;
+        connected_at: string;
+        /** The account's own Stripe Dashboard. */
+        dashboard_url: string;
+    };
+    /** The hub page where the account owner connects or finishes setting up Stripe. */
+    settings_url: string;
+    /** What happens next, in one sentence to pass on. */
+    next: string;
+}
 /** webinars.zoom(): the account's Zoom connection, never a Zoom value. */
 export interface ZoomConnection {
     /** Zoom is connected. */
@@ -4400,6 +4471,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.65.0';
+export const VERSION = '0.67.1';
 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
@@ -1049,6 +1058,24 @@ export class AwesomateClient {
             return this.request('POST', `/api/my-crm/v1/webinars/${id}/replay`, { url }, false);
         },
     };
+    /**
+     * Payments into the business's own Stripe account (never Awesomate's), connected in the hub.
+     * `status()` says where that account stands: connected or not, ready to take payments, live or
+     * test, what Stripe still needs, and the connected account's id and Stripe Dashboard. Connecting,
+     * finishing set-up and disconnecting are done by the account owner in the hub (`settings_url`);
+     * no method here starts them, and nothing here takes a Stripe key. Needs the account owner's own
+     * token with payments:read (never a team member's key, like the Stripe card in the hub) and the
+     * account's payments feature, a part of Contacts.
+     *
+     * @example
+     * const pay = await db.payments.status();
+     * if (!pay.ready) console.log(pay.next, pay.settings_url);
+     * else console.log(`Payments go to ${pay.account?.display_name} (${pay.account?.account_id})`);
+     */
+    payments = {
+        /** Where the business's Stripe account stands, with one sentence (`next`) saying what happens next. */
+        status: () => this.request('GET', '/api/my-crm/v1/payments/status'),
+    };
     /**
      * The account's own support desk: the help inbox for its customers, under Contacts, Support in
      * the hub. Read only, on purpose: every message here was written by someone outside the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesomate/sdk",
-  "version": "0.65.0",
+  "version": "0.67.1",
   "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",