@awesomate/sdk 0.11.0 → 0.12.0

package/README.md

@@ -30,6 +30,18 @@ const one = await db.get('contact', rows[0].id); // null if there is none
 const byPlan = await db.aggregate({ measures: [{ column: 'people', agg: 'count' }], dimensions: ['plan'] });
 ```
 
+## The business itself
+
+```js
+const biz = await db.business();
+biz.name;                                  // 'Acme Plumbing'
+for (const g of biz.groups) for (const f of g.facts) console.log(g.title, f.label, f.value, f.status, f.source);
+biz.completeness;                          // { core_set: 7, core_total: 8, missing_core: ['logo'] }
+const waiting = await db.businessSuggestions(); // details waiting for the owner's yes
+```
+
+The details Awesomate keeps about the business: name, what it does, voice, colours, how customers reach it. Each one says where it came from. `confirmed` details are the ones agents and automations use. A `suggestion` waits for the owner, who confirms it on Knowledge, Your business in the hub. This needs the account's token, on every plan, never an app key.
+
 ## Writing app data (Support Plus and above)
 
 Define the tables an app keeps, then write to them. There's no migration and no SQL; every value is

package/dist/index.d.ts

@@ -224,6 +224,15 @@ export declare class AwesomateClient {
      * Never retried: a write that may have landed is not safe to send twice.
      */
     call<R extends RecipeName>(recipe: R, args?: ArgsOf<R>): Promise<RecipeResult>;
+    /**
+     * The business itself: the details Awesomate keeps about it (name, what it does, voice, colours,
+     * how customers reach it), grouped, each with where it came from. `confirmed` details are the
+     * ones agents and automations use; `suggestion` ones wait for the owner. Needs the account's
+     * token (hosting:read, every plan), never an app key.
+     */
+    business(): Promise<BusinessIdentity>;
+    /** Details waiting for the owner's yes on Your business: from the website, the account, a team member or a file. */
+    businessSuggestions(): Promise<BusinessSuggestion[]>;
     /** Grouped numbers (counts, sums) in the Business Data API's shape. */
     aggregate(request: {
         measures: Array<{
@@ -251,6 +260,43 @@ export declare class AwesomateClient {
         limit?: number;
     }): Promise<Record<string, unknown>>;
 }
+/** One detail about the business. */
+export interface BusinessFact {
+    key: string;
+    label: string;
+    value: string;
+    /** confirmed: in use by agents and automations. suggestion: waiting for the owner. */
+    status: 'confirmed' | 'suggestion';
+    /** Where it came from, in words: "confirmed by the owner", "added by a team member", "website research"... */
+    source: string;
+}
+export interface BusinessIdentity {
+    account: string;
+    name: string | null;
+    groups: Array<{
+        id: string;
+        title: string;
+        facts: BusinessFact[];
+    }>;
+    /** The eight core details every business should have, and which are missing. */
+    completeness: {
+        core_set: number;
+        core_total: number;
+        missing_core: string[];
+    };
+    /** Whether each source could be read: 'read', 'empty' or 'unavailable'. */
+    sources: Record<'confirmed_details' | 'saved_details' | 'account_details' | 'website_research', string>;
+    how_to_change: string;
+}
+export interface BusinessSuggestion {
+    id: number;
+    key: string;
+    value: string;
+    /** website, research, import, team_member, staff, upload, legacy_variables... */
+    sourceKind: string;
+    sourceRef: string | null;
+    recordedAt: string;
+}
 export interface AttributeSpec {
     key: string;
     label?: string;

package/dist/index.js

@@ -215,6 +215,19 @@ export class AwesomateClient {
     async call(recipe, args = {}) {
         return (await this.request('POST', '/api/my-crm/v1/call', { fn: recipe, args }, false)).result;
     }
+    /**
+     * The business itself: the details Awesomate keeps about it (name, what it does, voice, colours,
+     * how customers reach it), grouped, each with where it came from. `confirmed` details are the
+     * ones agents and automations use; `suggestion` ones wait for the owner. Needs the account's
+     * token (hosting:read, every plan), never an app key.
+     */
+    business() {
+        return this.request('GET', '/api/my-business/v1/identity?format=json');
+    }
+    /** Details waiting for the owner's yes on Your business: from the website, the account, a team member or a file. */
+    async businessSuggestions() {
+        return (await this.request('GET', '/api/my-business/v1/proposals')).proposals;
+    }
     /** Grouped numbers (counts, sums) in the Business Data API's shape. */
     aggregate(request) {
         return this.request('POST', '/api/my-crm/v1/data/query', request);

package/package.json

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