@graph8/sdk 0.13.0 → 0.13.1

package/dist/react.d.mts

@@ -1767,6 +1767,10 @@ interface CustomObjectAttribute {
     /** No two ACTIVE records may hold the same value. A collision returns 409. */
     is_unique: boolean;
     is_multiselect: boolean;
+    /** Apply a non-null default to omitted create fields, never PATCH. Absent on older servers. */
+    is_default_value_enabled?: boolean;
+    /** Configured default; validated like an explicit value when enabled. */
+    default_value?: unknown;
     /** Type-specific configuration, e.g. the allowed options for a `select`. */
     config: Record<string, unknown>;
 }
@@ -1782,6 +1786,8 @@ interface CustomObjectRecord {
      */
     values: Record<string, unknown>;
     is_archived: boolean;
+    /** Revision for conditional updates; absent on older servers. */
+    revision?: number;
     created_at: string | null;
     updated_at: string | null;
 }
@@ -1826,10 +1832,7 @@ interface ObjectPagination {
  * Requires an API key (server-side). On the hardened HTTP core: throws a typed
  * `G8Error` on failure and retries transient errors.
  *
- * PREVIEW AND GATED. Every endpoint returns 403 `app_not_enabled` until the
- * custom-objects surface is switched on for the platform. It is off by default,
- * so a call fails fast rather than returning an empty list that reads as "you
- * have no objects".
+ * Access requires an authenticated credential with the applicable object scope.
  *
  * HOW THIS DIFFERS FROM `g8.fields`. A FIELD adds a column to an existing
  * contact or company. A CUSTOM OBJECT is a whole new record type with its own
@@ -1842,10 +1845,16 @@ interface ObjectPagination {
  *      lose your data, and the response lists every problem at once so a payload
  *      with three mistakes takes one round trip to fix.
  *   2. `update` is a PARTIAL write. Attributes you omit are left alone; sending
- *      an explicit `null` CLEARS one. The two are deliberately different.
+ *      an explicit `null` clears an optional attribute. Required attributes
+ *      cannot be cleared with `null` or an empty multivalue list (422).
  *   3. `archive` does not destroy anything. The record leaves listings, stays
  *      readable by id, and keeps its history.
  *
+ * Record references must resolve to an active record of `config.target_object`
+ * within the same organization and app. Unavailable targets return a 422 with
+ * `invalid_reference` in the field error's `reason`, without disclosing whether
+ * a target exists outside the caller's scope.
+ *
  * Backed by:
  *   GET    /api/v1/objects
  *   GET    /api/v1/objects/{slug}
@@ -1889,12 +1898,16 @@ declare const createObjectsClient: (apiKey: string, apiUrl?: string) => {
      * Values are versioned rather than overwritten, so the previous value stays
      * readable through `history`.
      */
-    updateRecord(objectSlug: string, recordId: string, values: Record<string, unknown>): Promise<CustomObjectRecord>;
+    updateRecord(objectSlug: string, recordId: string, values: Record<string, unknown>, options?: {
+        expectedRevision?: number;
+    }): Promise<CustomObjectRecord>;
     /**
      * Archive a record. It leaves listings, stays readable by id, and keeps its
      * history and associations. Nothing is destroyed.
      */
     archiveRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
+    /** Restore archived values under current constraints. Conflicts leave the record archived. */
+    restoreRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
     /**
      * A record's value timeline, newest first. An entry whose `active_until` is
      * null is the value currently in force.
@@ -3773,8 +3786,11 @@ declare const useG8: () => {
             }>;
             createRecord(objectSlug: string, values: Record<string, unknown>): Promise<CustomObjectRecord>;
             getRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
-            updateRecord(objectSlug: string, recordId: string, values: Record<string, unknown>): Promise<CustomObjectRecord>;
+            updateRecord(objectSlug: string, recordId: string, values: Record<string, unknown>, options?: {
+                expectedRevision?: number;
+            }): Promise<CustomObjectRecord>;
             archiveRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
+            restoreRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
             history(objectSlug: string, recordId: string, limit?: number): Promise<CustomObjectHistory>;
         };
         get deals(): {

package/dist/react.d.ts

@@ -1767,6 +1767,10 @@ interface CustomObjectAttribute {
     /** No two ACTIVE records may hold the same value. A collision returns 409. */
     is_unique: boolean;
     is_multiselect: boolean;
+    /** Apply a non-null default to omitted create fields, never PATCH. Absent on older servers. */
+    is_default_value_enabled?: boolean;
+    /** Configured default; validated like an explicit value when enabled. */
+    default_value?: unknown;
     /** Type-specific configuration, e.g. the allowed options for a `select`. */
     config: Record<string, unknown>;
 }
@@ -1782,6 +1786,8 @@ interface CustomObjectRecord {
      */
     values: Record<string, unknown>;
     is_archived: boolean;
+    /** Revision for conditional updates; absent on older servers. */
+    revision?: number;
     created_at: string | null;
     updated_at: string | null;
 }
@@ -1826,10 +1832,7 @@ interface ObjectPagination {
  * Requires an API key (server-side). On the hardened HTTP core: throws a typed
  * `G8Error` on failure and retries transient errors.
  *
- * PREVIEW AND GATED. Every endpoint returns 403 `app_not_enabled` until the
- * custom-objects surface is switched on for the platform. It is off by default,
- * so a call fails fast rather than returning an empty list that reads as "you
- * have no objects".
+ * Access requires an authenticated credential with the applicable object scope.
  *
  * HOW THIS DIFFERS FROM `g8.fields`. A FIELD adds a column to an existing
  * contact or company. A CUSTOM OBJECT is a whole new record type with its own
@@ -1842,10 +1845,16 @@ interface ObjectPagination {
  *      lose your data, and the response lists every problem at once so a payload
  *      with three mistakes takes one round trip to fix.
  *   2. `update` is a PARTIAL write. Attributes you omit are left alone; sending
- *      an explicit `null` CLEARS one. The two are deliberately different.
+ *      an explicit `null` clears an optional attribute. Required attributes
+ *      cannot be cleared with `null` or an empty multivalue list (422).
  *   3. `archive` does not destroy anything. The record leaves listings, stays
  *      readable by id, and keeps its history.
  *
+ * Record references must resolve to an active record of `config.target_object`
+ * within the same organization and app. Unavailable targets return a 422 with
+ * `invalid_reference` in the field error's `reason`, without disclosing whether
+ * a target exists outside the caller's scope.
+ *
  * Backed by:
  *   GET    /api/v1/objects
  *   GET    /api/v1/objects/{slug}
@@ -1889,12 +1898,16 @@ declare const createObjectsClient: (apiKey: string, apiUrl?: string) => {
      * Values are versioned rather than overwritten, so the previous value stays
      * readable through `history`.
      */
-    updateRecord(objectSlug: string, recordId: string, values: Record<string, unknown>): Promise<CustomObjectRecord>;
+    updateRecord(objectSlug: string, recordId: string, values: Record<string, unknown>, options?: {
+        expectedRevision?: number;
+    }): Promise<CustomObjectRecord>;
     /**
      * Archive a record. It leaves listings, stays readable by id, and keeps its
      * history and associations. Nothing is destroyed.
      */
     archiveRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
+    /** Restore archived values under current constraints. Conflicts leave the record archived. */
+    restoreRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
     /**
      * A record's value timeline, newest first. An entry whose `active_until` is
      * null is the value currently in force.
@@ -3773,8 +3786,11 @@ declare const useG8: () => {
             }>;
             createRecord(objectSlug: string, values: Record<string, unknown>): Promise<CustomObjectRecord>;
             getRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
-            updateRecord(objectSlug: string, recordId: string, values: Record<string, unknown>): Promise<CustomObjectRecord>;
+            updateRecord(objectSlug: string, recordId: string, values: Record<string, unknown>, options?: {
+                expectedRevision?: number;
+            }): Promise<CustomObjectRecord>;
             archiveRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
+            restoreRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
             history(objectSlug: string, recordId: string, limit?: number): Promise<CustomObjectHistory>;
         };
         get deals(): {

package/dist/react.js

@@ -1343,12 +1343,12 @@ var createObjectsClient = (apiKey, apiUrl) => {
      * Values are versioned rather than overwritten, so the previous value stays
      * readable through `history`.
      */
-    async updateRecord(objectSlug, recordId, values) {
+    async updateRecord(objectSlug, recordId, values, options) {
       const resp = await request(
         baseUrl,
         `/api/v1/objects/${encode(objectSlug)}/records/${encode(recordId)}`,
         apiKey,
-        { method: "PATCH", body: { values } }
+        { method: "PATCH", body: { values, ...options?.expectedRevision === void 0 ? {} : { expected_revision: options.expectedRevision } } }
       );
       return resp.data ?? resp;
     },
@@ -1365,6 +1365,16 @@ var createObjectsClient = (apiKey, apiUrl) => {
       );
       return resp.data ?? resp;
     },
+    /** Restore archived values under current constraints. Conflicts leave the record archived. */
+    async restoreRecord(objectSlug, recordId) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/objects/${encode(objectSlug)}/records/${encode(recordId)}/restore`,
+        apiKey,
+        { method: "POST" }
+      );
+      return resp.data ?? resp;
+    },
     /**
      * A record's value timeline, newest first. An entry whose `active_until` is
      * null is the value currently in force.