@rulebricks/sdk 1.5.2 → 2.0.0

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/CreateUserResponse.d.ts

@@ -18,9 +18,9 @@ export declare namespace CreateUserResponse {
         name?: string | null;
         /** Role assigned to the user. */
         role?: string;
-        /** Access groups assigned to the user. */
-        accessGroups?: string[];
+        /** User groups assigned to the user. */
+        user_groups?: string[];
         /** API key generated for the user. */
-        apiKey?: string | null;
+        api_key?: string | null;
     }
 }

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/DynamicValue.d.ts

@@ -7,9 +7,15 @@ export interface DynamicValue {
     /** Type identifier for the value (e.g., 'string', 'number', 'boolean', 'list', 'function', etc.) */
     type: string;
     /** The actual value - can be any valid JSON type */
-    value?: unknown;
+    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/ExportManifestPreviewResponse.d.ts

@@ -0,0 +1,51 @@
+export interface ExportManifestPreviewResponse {
+    counts?: ExportManifestPreviewResponse.Counts;
+    items?: ExportManifestPreviewResponse.Items;
+}
+export declare namespace ExportManifestPreviewResponse {
+    interface Counts {
+        rules?: number;
+        flows?: number;
+        contexts?: number;
+        values?: number;
+    }
+    interface Items {
+        rules?: Items.Rules.Item[];
+        flows?: Items.Flows.Item[];
+        contexts?: Items.Contexts.Item[];
+        values?: Items.Values.Item[];
+    }
+    namespace Items {
+        type Rules = Rules.Item[];
+        namespace Rules {
+            interface Item {
+                id?: string;
+                name?: string;
+                slug?: string;
+            }
+        }
+        type Flows = Flows.Item[];
+        namespace Flows {
+            interface Item {
+                id?: string;
+                name?: string;
+                slug?: string;
+            }
+        }
+        type Contexts = Contexts.Item[];
+        namespace Contexts {
+            interface Item {
+                id?: string;
+                name?: string;
+                slug?: string;
+            }
+        }
+        type Values = Values.Item[];
+        namespace Values {
+            interface Item {
+                id?: string;
+                name?: string;
+            }
+        }
+    }
+}

package/dist/api/types/ExportManifestPreviewResponse.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/ExportManifestResponse.d.ts

@@ -0,0 +1,9 @@
+export interface ExportManifestResponse {
+    /** Manifest format version. */
+    version?: string;
+    exported_at?: string;
+    rules?: Record<string, unknown>[];
+    flows?: Record<string, unknown>[];
+    contexts?: Record<string, unknown>[];
+    values?: Record<string, unknown>[];
+}

package/dist/api/types/ExportManifestResponse.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/FlowDetail.d.ts

@@ -4,4 +4,32 @@ export interface FlowDetail extends Rulebricks.FlowBase {
     published?: boolean;
     /** The date this flow was last updated. */
     updated_at?: string;
+    /** The origin rule that this flow starts from. Flows execute starting from this rule's outputs. */
+    origin_rule?: FlowDetail.OriginRule | null;
+    /** The context this flow is bound to (via its origin rule). Flows inherit context binding from their origin rule. */
+    context?: FlowDetail.Context | null;
+}
+export declare namespace FlowDetail {
+    /**
+     * The origin rule that this flow starts from. Flows execute starting from this rule's outputs.
+     */
+    interface OriginRule {
+        /** The origin rule ID. */
+        id?: string;
+        /** The origin rule name. */
+        name?: string;
+        /** The origin rule slug. */
+        slug?: string;
+    }
+    /**
+     * The context this flow is bound to (via its origin rule). Flows inherit context binding from their origin rule.
+     */
+    interface Context {
+        /** The context ID. */
+        id?: string;
+        /** The context name. */
+        name?: string;
+        /** The context slug. */
+        slug?: string;
+    }
 }

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

@@ -6,5 +6,5 @@ export interface Folder {
     /** Description of the folder. */
     description?: string;
     /** Timestamp of when the folder was last updated. */
-    updatedAt?: string;
+    updated_at?: string;
 }

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

@@ -0,0 +1,38 @@
+export interface ImportManifestResponse {
+    /** Success message. */
+    message?: string;
+    /** Count of imported assets by type. */
+    imported?: ImportManifestResponse.Imported;
+    /** Count of skipped assets by type (already exist and overwrite=false). */
+    skipped?: ImportManifestResponse.Skipped;
+    /** Any errors encountered during import. */
+    errors?: ImportManifestResponse.Errors.Item[];
+}
+export declare namespace ImportManifestResponse {
+    /**
+     * Count of imported assets by type.
+     */
+    interface Imported {
+        rules?: number;
+        flows?: number;
+        contexts?: number;
+        values?: number;
+    }
+    /**
+     * Count of skipped assets by type (already exist and overwrite=false).
+     */
+    interface Skipped {
+        rules?: number;
+        flows?: number;
+        contexts?: number;
+        values?: number;
+    }
+    type Errors = Errors.Item[];
+    namespace Errors {
+        interface Item {
+            type?: string;
+            id?: string;
+            error?: string;
+        }
+    }
+}

package/dist/api/types/ImportManifestResponse.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/RuleDetail.d.ts

@@ -2,9 +2,26 @@ import type * as Rulebricks from "../index.js";
 export interface RuleDetail extends Rulebricks.RuleBase {
     /** The date this rule was created. */
     created_at?: string;
+    /** The date this rule was last updated. */
+    updated_at?: string;
     folder?: Rulebricks.Folder;
+    /** The context this rule is bound to (if any). Rules bound to a context have their inputs/outputs mapped to context fields. */
+    context?: RuleDetail.Context | null;
     /** The published request schema for the rule. */
     request_schema?: Rulebricks.SchemaField[];
     /** The published response schema for the rule. */
     response_schema?: Rulebricks.SchemaField[];
 }
+export declare namespace RuleDetail {
+    /**
+     * The context this rule is bound to (if any). Rules bound to a context have their inputs/outputs mapped to context fields.
+     */
+    interface Context {
+        /** The context ID. */
+        id?: string;
+        /** The context name. */
+        name?: string;
+        /** The context slug. */
+        slug?: string;
+    }
+}

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

@@ -0,0 +1,23 @@
+/**
+ * Response after executing a flow against a context instance.
+ */
+export interface SolveContextFlowResponse {
+    /** Whether the flow executed successfully. */
+    status?: SolveContextFlowResponse.Status;
+    /** Combined identifier in format 'contextSlug:instanceId'. */
+    context?: string;
+    /** The slug of the flow that was executed. */
+    flow?: string;
+    /** The flow execution output. */
+    result?: Record<string, unknown>;
+    /** Resource usage information for the flow execution. */
+    usage?: Record<string, unknown>;
+}
+export declare namespace SolveContextFlowResponse {
+    /** Whether the flow executed successfully. */
+    const Status: {
+        readonly Solved: "solved";
+        readonly Error: "error";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/api/types/SolveContextFlowResponse.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.SolveContextFlowResponse = void 0;
+var SolveContextFlowResponse;
+(function (SolveContextFlowResponse) {
+    /** Whether the flow executed successfully. */
+    SolveContextFlowResponse.Status = {
+        Solved: "solved",
+        Error: "error",
+    };
+})(SolveContextFlowResponse || (exports.SolveContextFlowResponse = SolveContextFlowResponse = {}));

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

@@ -0,0 +1,26 @@
+import type * as Rulebricks from "../index.js";
+/**
+ * Response after solving a rule against a context instance.
+ */
+export interface SolveContextRuleResponse {
+    /** Whether the rule executed successfully. */
+    status?: SolveContextRuleResponse.Status;
+    /** Combined identifier in format 'contextSlug:instanceId'. */
+    context?: string;
+    /** The slug of the rule that was executed. */
+    rule?: string;
+    /** The rule evaluation result (output values). */
+    result?: Record<string, unknown>;
+    /** List of field keys that were written back to the context instance. */
+    written_to_context?: string[];
+    /** Results from any cascaded evaluations triggered by the rule outputs. */
+    cascaded?: Rulebricks.CascadeResult[];
+}
+export declare namespace SolveContextRuleResponse {
+    /** Whether the rule executed successfully. */
+    const Status: {
+        readonly Solved: "solved";
+        readonly Error: "error";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/api/types/SolveContextRuleResponse.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.SolveContextRuleResponse = void 0;
+var SolveContextRuleResponse;
+(function (SolveContextRuleResponse) {
+    /** Whether the rule executed successfully. */
+    SolveContextRuleResponse.Status = {
+        Solved: "solved",
+        Error: "error",
+    };
+})(SolveContextRuleResponse || (exports.SolveContextRuleResponse = SolveContextRuleResponse = {}));

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

@@ -0,0 +1,4 @@
+/**
+ * Data to submit to a context instance. Keys should match the context schema fields.
+ */
+export type SubmitContextDataRequest = Record<string, unknown>;

package/dist/api/types/SubmitContextDataRequest.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/SubmitContextDataResponse.d.ts

@@ -0,0 +1,30 @@
+import type * as Rulebricks from "../index.js";
+/**
+ * Response after submitting data, including any auto-executed evaluations.
+ */
+export interface SubmitContextDataResponse {
+    /** Combined identifier in format 'contextSlug:instanceId'. */
+    context?: string;
+    /** The merged state after submitting data and any auto-executed rules/flows. */
+    state?: Record<string, unknown>;
+    /** Whether all required fields are present ('complete') or some are missing ('pending'). */
+    status?: SubmitContextDataResponse.Status;
+    /** List of field keys that are currently populated. */
+    have?: string[];
+    /** List of required field keys that are still missing. */
+    need?: string[];
+    /** Whether this submission created a new instance (true) or updated an existing one (false). */
+    is_new?: boolean;
+    /** When the instance will expire based on context TTL. */
+    expires_at?: string | null;
+    /** Results from auto-executed rules/flows and pending evaluation cascades. */
+    cascaded?: Rulebricks.CascadeResult[];
+}
+export declare namespace SubmitContextDataResponse {
+    /** 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/SubmitContextDataResponse.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.SubmitContextDataResponse = void 0;
+var SubmitContextDataResponse;
+(function (SubmitContextDataResponse) {
+    /** Whether all required fields are present ('complete') or some are missing ('pending'). */
+    SubmitContextDataResponse.Status = {
+        Complete: "complete",
+        Pending: "pending",
+    };
+})(SubmitContextDataResponse || (exports.SubmitContextDataResponse = SubmitContextDataResponse = {}));

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

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

package/dist/api/types/UpdateContextResponse.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/UserDetail.d.ts

@@ -9,11 +9,11 @@ export interface UserDetail {
     /** Display name of the user (if set). */
     name?: string | null;
     /** API key assigned to the user. */
-    apiKey?: string | null;
+    api_key?: string | null;
     /** Role assigned to the user (e.g., 'administrator', 'developer', 'editor', or custom role ID). */
     role?: string;
-    /** List of access group names the user belongs to. */
-    accessGroups?: string[];
+    /** List of user group names the user belongs to. */
+    user_groups?: string[];
     /** Date and time when the user joined the organization. */
-    joinedAt?: string | null;
+    joined_at?: string | null;
 }

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

@@ -9,7 +9,7 @@ export declare namespace UserInviteResponse {
         email?: string;
         /** Role assigned to the user. */
         role?: string;
-        /** Access groups assigned to the user. */
-        accessGroups?: string[];
+        /** User groups assigned to the user. */
+        user_groups?: string[];
     }
 }