@rulebricks/sdk 1.5.0 → 2.0.0

package/dist/api/types/ContextDetail.d.ts

@@ -0,0 +1,58 @@
+import type * as Rulebricks from "../index.js";
+export interface ContextDetail extends Rulebricks.ContextBase {
+    schema?: Rulebricks.ContextSchema;
+    /** The field key used as the unique identifier for instances. */
+    identity_fact?: string | null;
+    /** User groups that can interact with this context. */
+    user_groups?: string[] | null;
+    /** Folder/tag this context belongs to. */
+    folder?: ContextDetail.Folder | null;
+    /** Rules bound to this context. */
+    bound_rules?: ContextDetail.BoundRules.Item[];
+    /** Flows bound to this context (via their origin rule). */
+    bound_flows?: ContextDetail.BoundFlows.Item[];
+    relationships?: ContextDetail.Relationships;
+    /** When the context was created. */
+    created_at?: string;
+    /** When the context was last updated. */
+    updated_at?: string;
+}
+export declare namespace ContextDetail {
+    /**
+     * Folder/tag this context belongs to.
+     */
+    interface Folder {
+        id?: string;
+        name?: string;
+    }
+    type BoundRules = BoundRules.Item[];
+    namespace BoundRules {
+        interface Item {
+            id?: string;
+            name?: string;
+            slug?: string;
+            published?: boolean;
+        }
+    }
+    type BoundFlows = BoundFlows.Item[];
+    namespace BoundFlows {
+        interface Item {
+            id?: string;
+            name?: string;
+            slug?: string;
+            published?: boolean;
+            origin_rule?: Item.OriginRule | null;
+        }
+        namespace Item {
+            interface OriginRule {
+                id?: string;
+                name?: string;
+                slug?: string;
+            }
+        }
+    }
+    interface Relationships {
+        outgoing?: Rulebricks.ContextRelationshipOutgoing[];
+        incoming?: Rulebricks.ContextRelationshipIncoming[];
+    }
+}

package/dist/api/types/ContextDetail.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContextInstanceHistory.d.ts

@@ -0,0 +1,10 @@
+import type * as Rulebricks from "../index.js";
+/**
+ * Historical values for context instance fields.
+ */
+export interface ContextInstanceHistory {
+    /** Combined identifier in format 'contextSlug:instanceId'. */
+    context?: string;
+    /** Map of field keys to arrays of historical values, newest first. */
+    history?: Record<string, Rulebricks.ContextInstanceHistoryEntry[]>;
+}

package/dist/api/types/ContextInstanceHistory.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContextInstanceHistoryEntry.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A single history entry for a field value.
+ */
+export interface ContextInstanceHistoryEntry {
+    /** When this value was recorded. */
+    timestamp?: string;
+    /** The field value at this point in time. */
+    value?: unknown;
+}

package/dist/api/types/ContextInstanceHistoryEntry.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContextInstancePendingEvaluation.d.ts

@@ -0,0 +1,29 @@
+/**
+ * A pending rule or flow evaluation awaiting data.
+ */
+export interface ContextInstancePendingEvaluation {
+    /** Whether this is a rule or flow evaluation. */
+    type?: ContextInstancePendingEvaluation.Type;
+    /** The rule slug (if type is 'rule'). */
+    rule?: string | null;
+    /** The rule ID (if type is 'rule'). */
+    rule_id?: string | null;
+    /** The flow slug (if type is 'flow'). */
+    flow?: string | null;
+    /** The flow ID (if type is 'flow'). */
+    flow_id?: string | null;
+    /** List of field keys this evaluation is waiting for. */
+    waiting_on?: string[];
+    /** When this pending evaluation was registered. */
+    created_at?: string;
+    /** When this pending evaluation will expire. */
+    expires_at?: string;
+}
+export declare namespace ContextInstancePendingEvaluation {
+    /** Whether this is a rule or flow evaluation. */
+    const Type: {
+        readonly Rule: "rule";
+        readonly Flow: "flow";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/api/types/ContextInstancePendingEvaluation.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextInstancePendingEvaluation = void 0;
+var ContextInstancePendingEvaluation;
+(function (ContextInstancePendingEvaluation) {
+    /** Whether this is a rule or flow evaluation. */
+    ContextInstancePendingEvaluation.Type = {
+        Rule: "rule",
+        Flow: "flow",
+    };
+})(ContextInstancePendingEvaluation || (exports.ContextInstancePendingEvaluation = ContextInstancePendingEvaluation = {}));

package/dist/api/types/ContextInstancePendingResponse.d.ts

@@ -0,0 +1,8 @@
+import type * as Rulebricks from "../index.js";
+/**
+ * List of pending evaluations for a context instance.
+ */
+export interface ContextInstancePendingResponse {
+    /** Pending rule and flow evaluations. */
+    pending?: Rulebricks.ContextInstancePendingEvaluation[];
+}

package/dist/api/types/ContextInstancePendingResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContextInstanceState.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The current state of a context instance.
+ */
+export interface ContextInstanceState {
+    /** Combined identifier in format 'contextSlug:instanceId'. */
+    context?: string;
+    /** The current base field values for this instance. */
+    state?: Record<string, unknown>;
+    /** Computed/derived field values from bound rules. */
+    derived?: Record<string, unknown>;
+    /** Whether all required fields are present ('complete') or some are missing ('pending'). */
+    status?: ContextInstanceState.Status;
+    /** List of field keys that are currently populated. */
+    have?: string[];
+    /** List of required field keys that are missing (empty when status is 'complete'). */
+    need?: string[];
+    /** When the instance was first created. */
+    created_at?: string;
+    /** When the instance was last updated. */
+    updated_at?: string;
+    /** When the instance will expire based on context TTL. */
+    expires_at?: string | null;
+}
+export declare namespace ContextInstanceState {
+    /** Whether all required fields are present ('complete') or some are missing ('pending'). */
+    const Status: {
+        readonly Complete: "complete";
+        readonly Pending: "pending";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/api/types/ContextInstanceState.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextInstanceState = void 0;
+var ContextInstanceState;
+(function (ContextInstanceState) {
+    /** Whether all required fields are present ('complete') or some are missing ('pending'). */
+    ContextInstanceState.Status = {
+        Complete: "complete",
+        Pending: "pending",
+    };
+})(ContextInstanceState || (exports.ContextInstanceState = ContextInstanceState = {}));

package/dist/api/types/ContextListResponse.d.ts

@@ -0,0 +1,2 @@
+import type * as Rulebricks from "../index.js";
+export type ContextListResponse = Rulebricks.ContextDetail[];

package/dist/api/types/ContextListResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContextRelationshipBase.d.ts

@@ -0,0 +1,21 @@
+export interface ContextRelationshipBase {
+    /** The unique identifier for the relationship. */
+    id?: string;
+    /** The type of relationship. */
+    type?: ContextRelationshipBase.Type;
+    /** The field key used as the foreign key. */
+    foreignKey?: string;
+    /** Display name for the relationship. */
+    name?: string;
+    /** Description of the relationship. */
+    description?: string;
+}
+export declare namespace ContextRelationshipBase {
+    /** The type of relationship. */
+    const Type: {
+        readonly OneToOne: "one-to-one";
+        readonly OneToMany: "one-to-many";
+        readonly ManyToOne: "many-to-one";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/api/types/ContextRelationshipBase.js

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextRelationshipBase = void 0;
+var ContextRelationshipBase;
+(function (ContextRelationshipBase) {
+    /** The type of relationship. */
+    ContextRelationshipBase.Type = {
+        OneToOne: "one-to-one",
+        OneToMany: "one-to-many",
+        ManyToOne: "many-to-one",
+    };
+})(ContextRelationshipBase || (exports.ContextRelationshipBase = ContextRelationshipBase = {}));

package/dist/api/types/ContextRelationshipIncoming.d.ts

@@ -0,0 +1,11 @@
+import type * as Rulebricks from "../index.js";
+export interface ContextRelationshipIncoming extends Rulebricks.ContextRelationshipBase {
+    sourceContext?: ContextRelationshipIncoming.SourceContext;
+}
+export declare namespace ContextRelationshipIncoming {
+    interface SourceContext {
+        id?: string;
+        name?: string;
+        slug?: string;
+    }
+}

package/dist/api/types/ContextRelationshipIncoming.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContextRelationshipOutgoing.d.ts

@@ -0,0 +1,11 @@
+import type * as Rulebricks from "../index.js";
+export interface ContextRelationshipOutgoing extends Rulebricks.ContextRelationshipBase {
+    targetContext?: ContextRelationshipOutgoing.TargetContext;
+}
+export declare namespace ContextRelationshipOutgoing {
+    interface TargetContext {
+        id?: string;
+        name?: string;
+        slug?: string;
+    }
+}

package/dist/api/types/ContextRelationshipOutgoing.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContextRelationshipsResponse.d.ts

@@ -0,0 +1,5 @@
+import type * as Rulebricks from "../index.js";
+export interface ContextRelationshipsResponse {
+    outgoing?: Rulebricks.ContextRelationshipOutgoing[];
+    incoming?: Rulebricks.ContextRelationshipIncoming[];
+}

package/dist/api/types/ContextRelationshipsResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContextSchema.d.ts

@@ -0,0 +1,10 @@
+import type * as Rulebricks from "../index.js";
+/**
+ * The schema definition for a context.
+ */
+export interface ContextSchema {
+    /** User-defined base fields for the context. */
+    base?: Rulebricks.ContextSchemaField[];
+    /** Fields derived from bound rule/flow outputs. */
+    derived?: Rulebricks.ContextSchemaField[];
+}

package/dist/api/types/ContextSchema.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContextSchemaField.d.ts

@@ -0,0 +1,35 @@
+/**
+ * A field definition within a context schema.
+ */
+export interface ContextSchemaField {
+    /** The unique key for this field. */
+    key?: string;
+    /** Display name for this field. */
+    name?: string;
+    /** Description of this field. */
+    description?: string;
+    /** Data type of this field. 'function' type fields compute values dynamically. */
+    type?: ContextSchemaField.Type;
+    /** Default value for this field. */
+    defaultValue?: unknown | null;
+    /** Whether this field is derived from rule/flow outputs. */
+    derived?: boolean;
+    /** The rule ID that derives this field (if derived). */
+    sourceRule?: string | null;
+    /** The flow ID that derives this field (if derived). */
+    sourceFlow?: string | null;
+    /** The source field key in the rule/flow output. */
+    sourceField?: string | null;
+}
+export declare namespace ContextSchemaField {
+    /** Data type of this field. 'function' type fields compute values dynamically. */
+    const Type: {
+        readonly String: "string";
+        readonly Number: "number";
+        readonly Boolean: "boolean";
+        readonly Date: "date";
+        readonly List: "list";
+        readonly Function: "function";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/api/types/ContextSchemaField.js

@@ -0,0 +1,16 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextSchemaField = void 0;
+var ContextSchemaField;
+(function (ContextSchemaField) {
+    /** Data type of this field. 'function' type fields compute values dynamically. */
+    ContextSchemaField.Type = {
+        String: "string",
+        Number: "number",
+        Boolean: "boolean",
+        Date: "date",
+        List: "list",
+        Function: "function",
+    };
+})(ContextSchemaField || (exports.ContextSchemaField = ContextSchemaField = {}));

package/dist/api/types/CreateContextResponse.d.ts

@@ -0,0 +1,2 @@
+import type * as Rulebricks from "../index.js";
+export type CreateContextResponse = Rulebricks.ContextDetail;

package/dist/api/types/CreateContextResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/CreateRelationshipResponse.d.ts

@@ -0,0 +1,2 @@
+import type * as Rulebricks from "../index.js";
+export type CreateRelationshipResponse = Rulebricks.ContextRelationshipOutgoing;

package/dist/api/types/CreateRelationshipResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/CreateTestRequest.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface CreateTestRequest {
     /** The name of the test. */
     name: string;

package/dist/api/types/CreateTestRequest.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/CreateUserResponse.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Response after successfully creating a user.
+ */
+export interface CreateUserResponse {
+    /** Status of the operation. */
+    status?: string;
+    /** Success message. */
+    message?: string;
+    user?: CreateUserResponse.User;
+}
+export declare namespace CreateUserResponse {
+    interface User {
+        /** Unique identifier for the created user. */
+        id?: string;
+        /** Email address of the created user. */
+        email?: string;
+        /** Display name of the user. */
+        name?: string | null;
+        /** Role assigned to the user. */
+        role?: string;
+        /** User groups assigned to the user. */
+        user_groups?: string[];
+        /** API key generated for the user. */
+        api_key?: string | null;
+    }
+}

package/dist/api/types/CreateUserResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/DecisionLog.d.ts

@@ -1,7 +1,23 @@
 /**
- * This file was auto-generated by Fern from our API Definition.
+ * Rule/flow execution log entry with request, response, and decision details.
  */
-/**
- * Rule/flow execution log entry. Explore this object's schema from your Rulebricks dashboard in the Logs tab.
- */
-export declare type DecisionLog = Record<string, unknown>;
+export interface DecisionLog {
+    /** When the rule/flow was executed. */
+    timestamp?: string | null;
+    /** Name of the rule or flow that was executed. */
+    name?: string | null;
+    /** API endpoint that was called. */
+    endpoint?: string | null;
+    /** HTTP status code of the response. */
+    status?: number | null;
+    /** The request payload sent to the rule/flow. */
+    request?: Record<string, unknown> | null;
+    /** The response payload returned by the rule/flow. */
+    response?: Record<string, unknown> | null;
+    /** Decision details including matched conditions, rows, and evaluation metadata. */
+    decision?: Record<string, unknown> | null;
+    /** Error message if the execution failed. */
+    error?: string | null;
+    /** Whether the request/response data was truncated due to size limits. */
+    abbreviated?: boolean;
+}

package/dist/api/types/DecisionLog.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/DecisionLogResponse.d.ts

@@ -1,9 +1,12 @@
+import type * as Rulebricks from "../index.js";
 /**
- * This file was auto-generated by Fern from our API Definition.
+ * Response containing decision logs or a count.
  */
-import * as Rulebricks from "../index";
 export interface DecisionLogResponse {
+    /** Array of decision log entries (omitted when count=true). */
     data?: Rulebricks.DecisionLog[];
-    /** Pagination cursor for next page */
-    cursor?: string;
+    /** Pagination cursor for fetching the next page. Null if no more results. */
+    cursor?: string | null;
+    /** Total count of matching logs (only present when count=true parameter is used). */
+    count?: number;
 }

package/dist/api/types/DecisionLogResponse.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/DeleteContextInstanceResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Response after deleting a context instance.
+ */
+export interface DeleteContextInstanceResponse {
+    /** Success message. */
+    message?: string;
+    /** Number of pending evaluations that were cancelled when the instance was deleted. */
+    pending_evaluations_cancelled?: number;
+}

package/dist/api/types/DeleteContextInstanceResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/DeleteContextResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Response after deleting a context.
+ */
+export interface DeleteContextResponse {
+    /** Success message. */
+    message?: string;
+    /** Slugs of rules that were unbound from the deleted context. */
+    unbound_rules?: string[];
+    /** Slugs of flows that were unbound from the deleted context. */
+    unbound_flows?: string[];
+    /** Number of pending evaluations that were cancelled when the context was deleted. */
+    pending_evaluations_cancelled?: number;
+}

package/dist/api/types/DeleteContextResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/DeleteRelationshipResponse.d.ts

@@ -0,0 +1,4 @@
+export interface DeleteRelationshipResponse {
+    /** Success message. */
+    message?: string;
+}

package/dist/api/types/DeleteRelationshipResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/DynamicRequestPayload.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Dynamic request payload for rule execution. Structure depends on rule configuration.
  */
-export declare type DynamicRequestPayload = Record<string, unknown>;
+export type DynamicRequestPayload = Record<string, unknown>;

package/dist/api/types/DynamicRequestPayload.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/DynamicResponsePayload.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Dynamic response payload from rule execution. Structure depends on rule configuration.
  */
-export declare type DynamicResponsePayload = Record<string, unknown>;
+export type DynamicResponsePayload = Record<string, unknown>;

package/dist/api/types/DynamicResponsePayload.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/DynamicValue.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Rulebricks from "../index";
+import type * as Rulebricks from "../index.js";
 export interface DynamicValue {
     /** Unique identifier for the dynamic value. */
     id: string;
@@ -9,9 +6,16 @@ export interface DynamicValue {
     name: string;
     /** Type identifier for the value (e.g., 'string', 'number', 'boolean', 'list', 'function', etc.) */
     type: string;
-    value?: unknown;
+    /** The actual value - can be any valid JSON type */
+    value?: DynamicValue.Value;
     /** Rules that use this dynamic value (only included when 'include=usage' parameter is used). */
     usages?: Rulebricks.RuleUsage[];
-    /** Access groups assigned to this value. */
-    accessGroups?: string[];
+    /** User groups assigned to this value. */
+    user_groups?: string[];
+}
+export declare namespace DynamicValue {
+    /**
+     * The actual value - can be any valid JSON type
+     */
+    type Value = string | number | boolean | unknown[] | Record<string, unknown>;
 }

package/dist/api/types/DynamicValue.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/DynamicValueListResponse.d.ts

@@ -1,5 +1,2 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Rulebricks from "../index";
-export declare type DynamicValueListResponse = Rulebricks.DynamicValue[];
+import type * as Rulebricks from "../index.js";
+export type DynamicValueListResponse = Rulebricks.DynamicValue[];

package/dist/api/types/DynamicValueListResponse.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });