@rulebricks/sdk 1.5.2 → 2.5.0

package/api/types/ContextListItem.d.ts

@@ -0,0 +1,24 @@
+import type * as Rulebricks from "../index.js";
+/**
+ * Summary of a context for listing. Uses counts instead of full arrays.
+ */
+export interface ContextListItem extends Rulebricks.ContextBase {
+    /** The field key used as the unique identifier for instances. */
+    identity_fact?: string | null;
+    schema?: Rulebricks.ContextSchema;
+    folder?: ContextListItem.Folder | null;
+    /** Number of rules bound to this context. */
+    bound_rules_count?: number;
+    /** Number of flows bound to this context. */
+    bound_flows_count?: number;
+    /** Total number of relationships for this context. */
+    relationships_count?: number;
+    created_at?: string;
+    updated_at?: string;
+}
+export declare namespace ContextListItem {
+    interface Folder {
+        id?: string;
+        name?: string;
+    }
+}

package/api/types/ContextListItem.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/api/types/ContextListResponse.d.ts

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

package/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/api/types/ContextRelationshipBase.d.ts

@@ -0,0 +1,23 @@
+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. */
+    foreign_key?: string;
+    /** Display name for the relationship. */
+    name?: string;
+    /** Description of the relationship. */
+    description?: string;
+    /** When the relationship was created. */
+    created_at?: string;
+}
+export declare namespace ContextRelationshipBase {
+    /** The type of relationship. */
+    const Type: {
+        readonly HasMany: "has_many";
+        readonly HasOne: "has_one";
+        readonly BelongsTo: "belongs_to";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/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 = {
+        HasMany: "has_many",
+        HasOne: "has_one",
+        BelongsTo: "belongs_to",
+    };
+})(ContextRelationshipBase || (exports.ContextRelationshipBase = ContextRelationshipBase = {}));

package/api/types/ContextRelationshipIncoming.d.ts

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

package/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/api/types/ContextRelationshipOutgoing.d.ts

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

package/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/api/types/ContextRelationshipsResponse.d.ts

@@ -0,0 +1,17 @@
+import type * as Rulebricks from "../index.js";
+export interface ContextRelationshipsResponse {
+    /** The context these relationships belong to. */
+    context?: ContextRelationshipsResponse.Context;
+    outgoing?: Rulebricks.ContextRelationshipOutgoing[];
+    incoming?: Rulebricks.ContextRelationshipIncoming[];
+}
+export declare namespace ContextRelationshipsResponse {
+    /**
+     * The context these relationships belong to.
+     */
+    interface Context {
+        id?: string;
+        name?: string;
+        slug?: string;
+    }
+}

package/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/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/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/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. */
+    default_value?: unknown | null;
+    /** Whether this field is derived from rule/flow outputs. */
+    derived?: boolean;
+    /** The rule ID that derives this field (if derived). */
+    source_rule?: string | null;
+    /** The flow ID that derives this field (if derived). */
+    source_flow?: string | null;
+    /** The source field key in the rule/flow output. */
+    source_field?: 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/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/api/types/CreateContextResponse.d.ts

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

package/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/api/types/CreateRelationshipResponse.d.ts

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

package/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/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/api/types/DecisionLog.d.ts

@@ -1,3 +1,4 @@
+import type * as Rulebricks from "../index.js";
 /**
  * Rule/flow execution log entry with request, response, and decision details.
  */
@@ -10,14 +11,22 @@ export interface DecisionLog {
     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;
+    /** The request payload sent to the rule/flow. Can be an object for single requests or an array for bulk operations. */
+    request?: DecisionLog.Request | null;
+    /** The response payload returned by the rule/flow. Can be an object for single responses or an array for bulk operations. */
+    response?: Rulebricks.DecisionLogResponse | 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;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}
+export declare namespace DecisionLog {
+    /**
+     * The request payload sent to the rule/flow. Can be an object for single requests or an array for bulk operations.
+     */
+    type Request = Record<string, unknown> | Record<string, unknown>[];
 }

package/api/types/DecisionLogResponse.d.ts

@@ -1,12 +1,12 @@
 import type * as Rulebricks from "../index.js";
 /**
- * Response containing decision logs or a count.
+ * Response containing decision logs or a count. Returns either {data, cursor} for log queries OR {count} for count queries - these are mutually exclusive based on the count parameter.
  */
 export interface DecisionLogResponse {
-    /** Array of decision log entries (omitted when count=true). */
+    /** Array of decision log entries. Only present when count parameter is not 'true'. */
     data?: Rulebricks.DecisionLog[];
-    /** Pagination cursor for fetching the next page. Null if no more results. */
+    /** Pagination cursor for fetching the next page. Null if no more results. Only present when count parameter is not 'true'. */
     cursor?: string | null;
-    /** Total count of matching logs (only present when count=true parameter is used). */
+    /** Total count of matching logs. Only present when count parameter is 'true'. When this is returned, data and cursor are not included. */
     count?: number;
 }

package/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/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/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/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/api/types/DeleteRelationshipResponse.d.ts

@@ -0,0 +1,6 @@
+export interface DeleteRelationshipResponse {
+    /** Success message. */
+    message?: string;
+    /** The ID of the deleted relationship. */
+    id?: string;
+}

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

@@ -0,0 +1,64 @@
+export interface ExportManifestPreviewResponse {
+    /** Whether the preview completed successfully. */
+    success?: boolean;
+    /** Preview of assets that would be exported. */
+    preview?: ExportManifestPreviewResponse.Preview;
+    /** Error message if preview failed. */
+    error?: string;
+}
+export declare namespace ExportManifestPreviewResponse {
+    /**
+     * Preview of assets that would be exported.
+     */
+    interface Preview {
+        counts?: Preview.Counts;
+        items?: Preview.Items;
+    }
+    namespace Preview {
+        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/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/api/types/ExportManifestResponse.d.ts

@@ -0,0 +1,30 @@
+export interface ExportManifestResponse {
+    /** Whether the export completed successfully. */
+    success?: boolean;
+    /** The exported manifest data. */
+    manifest?: ExportManifestResponse.Manifest;
+    /** Error message if export failed. */
+    error?: string;
+}
+export declare namespace ExportManifestResponse {
+    /**
+     * The exported manifest data.
+     */
+    interface Manifest {
+        /** Manifest format version. */
+        version?: string;
+        /** Manifest name. */
+        name?: string;
+        /** Manifest description. */
+        description?: string;
+        exported_at?: string;
+        /** Exported contexts. */
+        contexts?: Record<string, unknown>[];
+        /** Exported dynamic values. */
+        values?: Record<string, unknown>[];
+        /** Exported rules. */
+        rules?: Record<string, unknown>[];
+        /** Exported flows. */
+        flows?: Record<string, unknown>[];
+    }
+}

package/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/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/api/types/Folder.d.ts

@@ -5,6 +5,10 @@ export interface Folder {
     name?: string;
     /** Description of the folder. */
     description?: string;
+    /** Timestamp of when the folder was created. */
+    created_at?: string;
     /** Timestamp of when the folder was last updated. */
-    updatedAt?: string;
+    updated_at?: string;
+    /** User groups that can view this folder. */
+    user_groups?: string[];
 }

package/api/types/ImportManifestResponse.d.ts

@@ -0,0 +1,66 @@
+export interface ImportManifestResponse {
+    /** Whether the import completed successfully. */
+    success?: boolean;
+    /** Assets that were created during import. */
+    created?: ImportManifestResponse.Created.Item[];
+    /** Assets that were updated during import. */
+    updated?: ImportManifestResponse.Updated.Item[];
+    /** Assets that were skipped during import. */
+    skipped?: ImportManifestResponse.Skipped.Item[];
+    /** Any errors encountered during import. */
+    errors?: ImportManifestResponse.Errors.Item[];
+    /** Non-fatal warnings from import validation. */
+    warnings?: string[];
+    /** IDs of any organizational folders created during import. */
+    organization_created?: ImportManifestResponse.OrganizationCreated | null;
+}
+export declare namespace ImportManifestResponse {
+    type Created = Created.Item[];
+    namespace Created {
+        interface Item {
+            /** Asset type (context, value, rule, flow, relationship). */
+            type?: string;
+            /** Stable ID of asset. */
+            stable_id?: string;
+            /** Database ID of asset. */
+            db_id?: string;
+            /** Import status. */
+            status?: string;
+        }
+    }
+    type Updated = Updated.Item[];
+    namespace Updated {
+        interface Item {
+            type?: string;
+            stable_id?: string;
+            db_id?: string;
+            status?: string;
+        }
+    }
+    type Skipped = Skipped.Item[];
+    namespace Skipped {
+        interface Item {
+            type?: string;
+            stable_id?: string;
+            status?: string;
+            reason?: string;
+        }
+    }
+    type Errors = Errors.Item[];
+    namespace Errors {
+        interface Item {
+            type?: string;
+            stable_id?: string;
+            status?: string;
+            reason?: string;
+        }
+    }
+    /**
+     * IDs of any organizational folders created during import.
+     */
+    interface OrganizationCreated {
+        entity_set_id?: string | null;
+        rule_tag_id?: string | null;
+        flow_tag_id?: string | null;
+    }
+}

package/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/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/api/types/SchemaField.d.ts

@@ -10,9 +10,9 @@ export interface SchemaField {
     /** Data type of this field. */
     type?: SchemaField.Type;
     /** Default value for this field. */
-    defaultValue?: SchemaField.DefaultValue | null;
+    default_value?: SchemaField.DefaultValue | null;
     /** Computed default value for this field. */
-    defaultComputedValue?: string | null;
+    default_computed_value?: string | null;
     /** Transformation expression to apply to this field. */
     transform?: string;
 }

package/api/types/SolveContextFlowRequest.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Optional request body for executing a flow against context. The entire body is merged with instance state before flow execution.
+ */
+export type SolveContextFlowRequest = Record<string, unknown>;

package/api/types/SolveContextFlowRequest.js

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