@graph8/sdk 0.12.2 → 0.13.0

package/dist/index.js

@@ -1176,10 +1176,92 @@ var createTasksClient = (apiKey, apiUrl) => {
   };
 };
 
-// src/fields.ts
+// src/apps.ts
 var DEFAULT_API17 = "https://be.graph8.com";
-var createFieldsClient = (apiKey, apiUrl) => {
+var createAppsClient = (apiKey, apiUrl) => {
   const baseUrl = apiUrl || DEFAULT_API17;
+  return {
+    /** List your organization's apps, newest first. */
+    async list() {
+      return request(baseUrl, "/api/v1/apps", apiKey);
+    },
+    /** Fetch one of your apps. Throws `G8Error` (404) if it is not yours. */
+    async get(appId) {
+      const resp = await request(baseUrl, `/api/v1/apps/${appId}`, apiKey);
+      return resp.data ?? resp;
+    },
+    /**
+     * Create an app. It starts in `draft` and serves no traffic until published.
+     * Throws `G8Error` (409) when the slug is already taken in your org.
+     */
+    async create(params) {
+      const resp = await request(baseUrl, "/api/v1/apps", apiKey, {
+        method: "POST",
+        body: {
+          name: params.name,
+          slug: params.slug,
+          registered_origins: params.registered_origins ?? []
+        }
+      });
+      return resp.data ?? resp;
+    },
+    /**
+     * Move an app through its lifecycle: `draft` → `published` → `archived`.
+     *
+     * `suspended` is excluded from the parameter type on purpose: it is the
+     * platform's kill switch for an abusive app, the backend refuses it with a
+     * 403, and a builder who could set it could also unset it.
+     */
+    async setStatus(appId, status) {
+      const resp = await request(baseUrl, `/api/v1/apps/${appId}/status`, apiKey, {
+        method: "POST",
+        body: { status }
+      });
+      return resp.data ?? resp;
+    },
+    /**
+     * The client organizations that installed this app, and their consent state.
+     * Includes `pending` and `revoked` installs — if your app cannot reach a
+     * tenant, this is where you see why.
+     */
+    async listInstalls(appId) {
+      return request(baseUrl, `/api/v1/apps/${appId}/installs`, apiKey);
+    },
+    /**
+     * Credits this app consumed in a calendar month, broken down per client org.
+     * Defaults to the current month. A month with no usage returns zeroes, not a
+     * 404 — "nothing happened" is an answer.
+     */
+    async usage(appId, period) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/apps/${appId}/usage`,
+        apiKey,
+        { query: period ? { period } : void 0 }
+      );
+      return resp.data ?? resp;
+    },
+    /**
+     * This app's hard credit cap, or `null` when it is uncapped.
+     *
+     * `null` is the real answer, not an empty object: there is no "unlimited"
+     * sentinel, so an accidental zero can never read as "no limit".
+     */
+    async getLimit(appId) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/apps/${appId}/limit`,
+        apiKey
+      );
+      return resp.data ?? null;
+    }
+  };
+};
+
+// src/fields.ts
+var DEFAULT_API18 = "https://be.graph8.com";
+var createFieldsClient = (apiKey, apiUrl) => {
+  const baseUrl = apiUrl || DEFAULT_API18;
   return {
     /** List contact fields (base + custom). Pass listId to include list-specific custom fields. */
     async listContactFields(listId) {
@@ -1220,10 +1302,112 @@ var createFieldsClient = (apiKey, apiUrl) => {
   };
 };
 
+// src/objects.ts
+var DEFAULT_API19 = "https://be.graph8.com";
+var createObjectsClient = (apiKey, apiUrl) => {
+  const baseUrl = apiUrl || DEFAULT_API19;
+  const encode = (value) => encodeURIComponent(value);
+  return {
+    /** List the custom object types in your workspace. */
+    async list() {
+      return request(baseUrl, "/api/v1/objects", apiKey);
+    },
+    /** Fetch one object type by slug. */
+    async get(objectSlug) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/objects/${encode(objectSlug)}`,
+        apiKey
+      );
+      return resp.data ?? resp;
+    },
+    /** The object's attributes — the schema its records must satisfy. */
+    async listAttributes(objectSlug) {
+      return request(baseUrl, `/api/v1/objects/${encode(objectSlug)}/attributes`, apiKey);
+    },
+    /** Paginated records with their current values. Archived records are excluded. */
+    async listRecords(objectSlug, params = {}) {
+      const query = {};
+      if (params.page != null) query.page = params.page;
+      if (params.limit != null) query.limit = params.limit;
+      if (params.cursor != null) query.cursor = params.cursor;
+      return request(baseUrl, `/api/v1/objects/${encode(objectSlug)}/records`, apiKey, {
+        query: Object.keys(query).length ? query : void 0
+      });
+    },
+    /**
+     * Create a record. Every field is validated against the object's attributes;
+     * an unknown one is a 422 listing every problem at once, and a collision on a
+     * unique attribute is a 409.
+     */
+    async createRecord(objectSlug, values) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/objects/${encode(objectSlug)}/records`,
+        apiKey,
+        { method: "POST", body: { values } }
+      );
+      return resp.data ?? resp;
+    },
+    /** Fetch one record with its currently active values. */
+    async getRecord(objectSlug, recordId) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/objects/${encode(objectSlug)}/records/${encode(recordId)}`,
+        apiKey
+      );
+      return resp.data ?? resp;
+    },
+    /**
+     * Update a record. PARTIAL: only the attributes you send are touched, so
+     * required attributes you omit are left alone rather than reported missing.
+     * Sending an explicit `null` CLEARS that attribute.
+     *
+     * Values are versioned rather than overwritten, so the previous value stays
+     * readable through `history`.
+     */
+    async updateRecord(objectSlug, recordId, values) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/objects/${encode(objectSlug)}/records/${encode(recordId)}`,
+        apiKey,
+        { method: "PATCH", body: { values } }
+      );
+      return resp.data ?? resp;
+    },
+    /**
+     * Archive a record. It leaves listings, stays readable by id, and keeps its
+     * history and associations. Nothing is destroyed.
+     */
+    async archiveRecord(objectSlug, recordId) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/objects/${encode(objectSlug)}/records/${encode(recordId)}`,
+        apiKey,
+        { method: "DELETE" }
+      );
+      return resp.data ?? resp;
+    },
+    /**
+     * A record's value timeline, newest first. An entry whose `active_until` is
+     * null is the value currently in force.
+     */
+    async history(objectSlug, recordId, limit) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/objects/${encode(objectSlug)}/records/${encode(recordId)}/history`,
+        apiKey,
+        { query: limit != null ? { limit } : void 0 }
+      );
+      return resp.data ?? resp;
+    }
+  };
+};
+
 // src/deals.ts
-var DEFAULT_API18 = "https://be.graph8.com";
+var DEFAULT_API20 = "https://be.graph8.com";
 var createDealsClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API18;
+  const baseUrl = apiUrl || DEFAULT_API20;
   return {
     /** List all deal pipelines and their stages. */
     async pipelines() {
@@ -1267,9 +1451,9 @@ var createDealsClient = (apiKey, apiUrl) => {
 };
 
 // src/inbox.ts
-var DEFAULT_API19 = "https://be.graph8.com";
+var DEFAULT_API21 = "https://be.graph8.com";
 var createInboxClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API19;
+  const baseUrl = apiUrl || DEFAULT_API21;
   return {
     /** List inbox threads across email, SMS, and LinkedIn. */
     async list(params = {}) {
@@ -1322,9 +1506,9 @@ var createInboxClient = (apiKey, apiUrl) => {
 };
 
 // src/quotes.ts
-var DEFAULT_API20 = "https://be.graph8.com";
+var DEFAULT_API22 = "https://be.graph8.com";
 var createQuotesClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API20;
+  const baseUrl = apiUrl || DEFAULT_API22;
   return {
     /** List quotes org-wide with optional filters and pagination. */
     async list(params = {}) {
@@ -1396,9 +1580,9 @@ var createQuotesClient = (apiKey, apiUrl) => {
 };
 
 // src/pipelines.ts
-var DEFAULT_API21 = "https://be.graph8.com";
+var DEFAULT_API23 = "https://be.graph8.com";
 var createPipelinesClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API21;
+  const baseUrl = apiUrl || DEFAULT_API23;
   return {
     /** List all stage-checklist pipelines with stages, evidence, scripts. */
     async list() {
@@ -1480,9 +1664,9 @@ var createPipelinesClient = (apiKey, apiUrl) => {
 };
 
 // src/workflows.ts
-var DEFAULT_API22 = "https://be.graph8.com";
+var DEFAULT_API24 = "https://be.graph8.com";
 var createWorkflowsClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API22;
+  const baseUrl = apiUrl || DEFAULT_API24;
   return {
     /** List workflows org-wide. */
     async list(params = {}) {
@@ -1598,9 +1782,9 @@ var createWorkflowsClient = (apiKey, apiUrl) => {
 };
 
 // src/skills.ts
-var DEFAULT_API23 = "https://be.graph8.com";
+var DEFAULT_API25 = "https://be.graph8.com";
 var createSkillsClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API23;
+  const baseUrl = apiUrl || DEFAULT_API25;
   return {
     /** List skills. */
     async list(params = {}) {
@@ -1687,9 +1871,9 @@ var createSkillsClient = (apiKey, apiUrl) => {
 };
 
 // src/intent.ts
-var DEFAULT_API24 = "https://be.graph8.com";
+var DEFAULT_API26 = "https://be.graph8.com";
 var createIntentClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API24;
+  const baseUrl = apiUrl || DEFAULT_API26;
   const get = (path) => request(baseUrl, `/api/v1${path}`, apiKey);
   const post = (path, body = {}) => request(baseUrl, `/api/v1${path}`, apiKey, { method: "POST", body });
   const del = (path) => request(baseUrl, `/api/v1${path}`, apiKey, { method: "DELETE" });
@@ -1764,9 +1948,9 @@ var createIntentClient = (apiKey, apiUrl) => {
 };
 
 // src/studio.ts
-var DEFAULT_API25 = "https://be.graph8.com";
+var DEFAULT_API27 = "https://be.graph8.com";
 var createStudioClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API25;
+  const baseUrl = apiUrl || DEFAULT_API27;
   const get = (path, params = {}) => request(baseUrl, `/api/v1${path}`, apiKey, { query: params });
   const post = (path, body = {}) => request(baseUrl, `/api/v1${path}`, apiKey, { method: "POST", body });
   const patch = (path, body = {}) => request(baseUrl, `/api/v1${path}`, apiKey, { method: "PATCH", body });
@@ -1821,9 +2005,9 @@ var createStudioClient = (apiKey, apiUrl) => {
 };
 
 // src/meetings.ts
-var DEFAULT_API26 = "https://be.graph8.com";
+var DEFAULT_API28 = "https://be.graph8.com";
 var createMeetingsClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API26;
+  const baseUrl = apiUrl || DEFAULT_API28;
   return {
     /** List meetings with optional filters. Returns summary rows without transcript / analysis. */
     async list(params = {}) {
@@ -1838,9 +2022,9 @@ var createMeetingsClient = (apiKey, apiUrl) => {
 };
 
 // src/audiences.ts
-var DEFAULT_API27 = "https://be.graph8.com";
+var DEFAULT_API29 = "https://be.graph8.com";
 var createAudiencesClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API27;
+  const baseUrl = apiUrl || DEFAULT_API29;
   const base = "/api/v1/audience-syncs";
   return {
     /** List all audience syncs for the organization. */
@@ -1888,9 +2072,9 @@ var createAudiencesClient = (apiKey, apiUrl) => {
 };
 
 // src/search.ts
-var DEFAULT_API28 = "https://be.graph8.com";
+var DEFAULT_API30 = "https://be.graph8.com";
 var createSearchClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API28;
+  const baseUrl = apiUrl || DEFAULT_API30;
   const body = (p) => ({ filters: [], page: 1, limit: 25, ...p });
   return {
     /** Search open-data contacts by filter. */
@@ -1921,9 +2105,9 @@ var createSearchClient = (apiKey, apiUrl) => {
 };
 
 // src/agency.ts
-var DEFAULT_API29 = "https://be.graph8.com";
+var DEFAULT_API31 = "https://be.graph8.com";
 var createAgencyClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API29;
+  const baseUrl = apiUrl || DEFAULT_API31;
   return {
     /** Describe the agency credential: agency org + authorized client count. */
     async me() {
@@ -1938,9 +2122,9 @@ var createAgencyClient = (apiKey, apiUrl) => {
 };
 
 // src/marketplace.ts
-var DEFAULT_API30 = "https://be.graph8.com";
+var DEFAULT_API32 = "https://be.graph8.com";
 var createMarketplaceClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API30;
+  const baseUrl = apiUrl || DEFAULT_API32;
   const base = "/api/v1/marketplace";
   return {
     /** Your own marketplace SDR profile. */
@@ -1990,9 +2174,9 @@ var createMarketplaceClient = (apiKey, apiUrl) => {
 };
 
 // src/snippet.ts
-var DEFAULT_API31 = "https://be.graph8.com";
+var DEFAULT_API33 = "https://be.graph8.com";
 var createSnippetClient = (apiKey, apiUrl) => {
-  const baseUrl = apiUrl || DEFAULT_API31;
+  const baseUrl = apiUrl || DEFAULT_API33;
   return {
     /** Get your org's tracking snippet (write key + React/script-tag embeds + config). */
     async get() {
@@ -2004,7 +2188,7 @@ var createSnippetClient = (apiKey, apiUrl) => {
 
 // src/core.ts
 var DEFAULT_HOST = "https://t.graph8.com";
-var DEFAULT_API32 = "https://be.graph8.com";
+var DEFAULT_API34 = "https://be.graph8.com";
 var G8 = class {
   constructor() {
     /** @internal */
@@ -2046,6 +2230,10 @@ var G8 = class {
     /** @internal */
     this._fields = null;
     /** @internal */
+    this._apps = null;
+    /** @internal */
+    this._objects = null;
+    /** @internal */
     this._deals = null;
     /** @internal */
     this._inbox = null;
@@ -2087,7 +2275,7 @@ var G8 = class {
         debug: config.debug
       });
     }
-    const apiUrl = config.apiUrl || DEFAULT_API32;
+    const apiUrl = config.apiUrl || DEFAULT_API34;
     const writeKey = config.writeKey || "";
     const apiKey = config.apiKey || "";
     if (writeKey) {
@@ -2110,6 +2298,8 @@ var G8 = class {
       this._notes = createNotesClient(apiKey, apiUrl);
       this._tasks = createTasksClient(apiKey, apiUrl);
       this._fields = createFieldsClient(apiKey, apiUrl);
+      this._apps = createAppsClient(apiKey, apiUrl);
+      this._objects = createObjectsClient(apiKey, apiUrl);
       this._deals = createDealsClient(apiKey, apiUrl);
       this._inbox = createInboxClient(apiKey, apiUrl);
       this._quotes = createQuotesClient(apiKey, apiUrl);
@@ -2230,6 +2420,16 @@ var G8 = class {
     this._assertKey("fields");
     return this._fields;
   }
+  /** Apps you build on graph8 — lifecycle, installs, usage, limits (requires API key). PREVIEW. */
+  get apps() {
+    this._assertKey("apps");
+    return this._apps;
+  }
+  /** Custom object types, their schema, and their records (requires API key). PREVIEW. */
+  get objects() {
+    this._assertKey("objects");
+    return this._objects;
+  }
   /** Deals and pipelines (requires API key). */
   get deals() {
     this._assertKey("deals");