@rulebricks/sdk 1.5.2 → 2.5.0

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

@@ -0,0 +1,4 @@
+/**
+ * Optional request body for solving a rule against context. The entire body is merged with the instance state before rule evaluation.
+ */
+export type SolveContextRuleRequest = Record<string, unknown>;

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

@@ -9,14 +9,14 @@ export interface Test {
     response: Record<string, unknown>;
     /** Indicates whether the test is critical. */
     critical: boolean;
-    /** Indicates if the test resulted in an error. */
-    error: boolean;
-    /** Indicates if the test was successful. */
-    success: boolean;
+    /** Indicates if the test resulted in an error. Null if test has not been executed. */
+    error?: boolean | null;
+    /** Indicates if the test was successful. Null if test has not been executed. */
+    success?: boolean | null;
     /** The state of the test after execution. */
-    testState?: Test.TestState | null;
+    test_state?: Test.TestState | null;
     /** The timestamp when the test was last executed. */
-    lastExecuted?: string | null;
+    last_executed?: string | null;
 }
 export declare namespace Test {
     /**
@@ -29,10 +29,10 @@ export declare namespace Test {
         response?: Record<string, unknown> | null;
         conditions?: Record<string, unknown>[];
         /** HTTP status code returned */
-        httpStatus?: number;
-        successIdxs?: number[];
+        http_status?: number;
+        success_idxs?: number[];
         /** Error message or flag indicating if evaluation error occurred */
-        evaluationError?: TestState.EvaluationError;
+        evaluation_error?: TestState.EvaluationError;
     }
     namespace TestState {
         /**

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

@@ -0,0 +1,13 @@
+/**
+ * Response after updating a context.
+ */
+export interface UpdateContextResponse {
+    /** The unique identifier of the updated context. */
+    id?: string;
+    /** The slug of the updated context. */
+    slug?: string;
+    /** The name of the updated context. */
+    name?: string;
+    /** Timestamp of when the context was updated. */
+    updated_at?: string;
+}

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

@@ -1,14 +1,20 @@
 export interface UsageStatistics {
     /** The current plan of the organization. */
     plan?: string;
-    /** The start date of the current monthly period. */
+    /** The start date of the current monthly period (MM-DD-YYYY). */
     monthly_period_start?: string;
-    /** The end date of the current monthly period. */
+    /** The end date of the current monthly period (MM-DD-YYYY). */
     monthly_period_end?: string;
     /** The number of rule executions used this month. */
     monthly_executions_usage?: number;
-    /** The total number of rule executions allowed this month. */
+    /** The total number of rule executions allowed this month. -1 indicates unlimited. */
     monthly_executions_limit?: number;
-    /** The number of rule executions remaining this month. */
+    /** The number of rule executions remaining this month. -1 indicates unlimited. */
     monthly_executions_remaining?: number;
+    /** Whether the plan has unlimited executions (true when monthly_executions_limit is -1). */
+    unlimited_plan?: boolean;
+    /** Number of days remaining in the current billing period. */
+    days_remaining_in_period?: number;
+    /** Average number of executions per day in the current period. */
+    daily_average_usage?: number;
 }

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

@@ -7,4 +7,6 @@ export interface UserGroup {
     description?: string;
     /** List of member emails in the user group. */
     members?: string[];
+    /** When the user group was created. */
+    created_at?: string;
 }

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[];
     }
 }

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

@@ -1,19 +1,45 @@
 export * from "./BulkRuleResponseItem.js";
+export * from "./CascadeContextRequest.js";
+export * from "./CascadeContextResponse.js";
+export * from "./CascadeResult.js";
+export * from "./ContextBase.js";
+export * from "./ContextDetail.js";
+export * from "./ContextInstanceHistory.js";
+export * from "./ContextInstanceHistoryEntry.js";
+export * from "./ContextInstancePendingEvaluation.js";
+export * from "./ContextInstancePendingResponse.js";
+export * from "./ContextInstanceState.js";
+export * from "./ContextListItem.js";
+export * from "./ContextListResponse.js";
+export * from "./ContextRelationshipBase.js";
+export * from "./ContextRelationshipIncoming.js";
+export * from "./ContextRelationshipOutgoing.js";
+export * from "./ContextRelationshipsResponse.js";
+export * from "./ContextSchema.js";
+export * from "./ContextSchemaField.js";
+export * from "./CreateContextResponse.js";
+export * from "./CreateRelationshipResponse.js";
 export * from "./CreateTestRequest.js";
 export * from "./CreateUserResponse.js";
 export * from "./DecisionLog.js";
 export * from "./DecisionLogResponse.js";
+export * from "./DeleteContextInstanceResponse.js";
+export * from "./DeleteContextResponse.js";
+export * from "./DeleteRelationshipResponse.js";
 export * from "./DynamicRequestPayload.js";
 export * from "./DynamicResponsePayload.js";
 export * from "./DynamicValue.js";
 export * from "./DynamicValueListResponse.js";
 export * from "./Error_.js";
+export * from "./ExportManifestPreviewResponse.js";
+export * from "./ExportManifestResponse.js";
 export * from "./FlowBase.js";
 export * from "./FlowDetail.js";
 export * from "./FlowExecutionError.js";
 export * from "./FlowListResponse.js";
 export * from "./Folder.js";
 export * from "./FolderListResponse.js";
+export * from "./ImportManifestResponse.js";
 export * from "./ParallelSolveRequest.js";
 export * from "./ParallelSolveResponse.js";
 export * from "./RuleBase.js";
@@ -22,9 +48,16 @@ export * from "./RuleExport.js";
 export * from "./RuleListResponse.js";
 export * from "./RuleUsage.js";
 export * from "./SchemaField.js";
+export * from "./SolveContextFlowRequest.js";
+export * from "./SolveContextFlowResponse.js";
+export * from "./SolveContextRuleRequest.js";
+export * from "./SolveContextRuleResponse.js";
+export * from "./SubmitContextDataRequest.js";
+export * from "./SubmitContextDataResponse.js";
 export * from "./SuccessMessage.js";
 export * from "./Test.js";
 export * from "./TestListResponse.js";
+export * from "./UpdateContextResponse.js";
 export * from "./UsageStatistics.js";
 export * from "./UserDetail.js";
 export * from "./UserGroup.js";

package/dist/api/types/index.js

@@ -15,21 +15,47 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BulkRuleResponseItem.js"), exports);
+__exportStar(require("./CascadeContextRequest.js"), exports);
+__exportStar(require("./CascadeContextResponse.js"), exports);
+__exportStar(require("./CascadeResult.js"), exports);
+__exportStar(require("./ContextBase.js"), exports);
+__exportStar(require("./ContextDetail.js"), exports);
+__exportStar(require("./ContextInstanceHistory.js"), exports);
+__exportStar(require("./ContextInstanceHistoryEntry.js"), exports);
+__exportStar(require("./ContextInstancePendingEvaluation.js"), exports);
+__exportStar(require("./ContextInstancePendingResponse.js"), exports);
+__exportStar(require("./ContextInstanceState.js"), exports);
+__exportStar(require("./ContextListItem.js"), exports);
+__exportStar(require("./ContextListResponse.js"), exports);
+__exportStar(require("./ContextRelationshipBase.js"), exports);
+__exportStar(require("./ContextRelationshipIncoming.js"), exports);
+__exportStar(require("./ContextRelationshipOutgoing.js"), exports);
+__exportStar(require("./ContextRelationshipsResponse.js"), exports);
+__exportStar(require("./ContextSchema.js"), exports);
+__exportStar(require("./ContextSchemaField.js"), exports);
+__exportStar(require("./CreateContextResponse.js"), exports);
+__exportStar(require("./CreateRelationshipResponse.js"), exports);
 __exportStar(require("./CreateTestRequest.js"), exports);
 __exportStar(require("./CreateUserResponse.js"), exports);
 __exportStar(require("./DecisionLog.js"), exports);
 __exportStar(require("./DecisionLogResponse.js"), exports);
+__exportStar(require("./DeleteContextInstanceResponse.js"), exports);
+__exportStar(require("./DeleteContextResponse.js"), exports);
+__exportStar(require("./DeleteRelationshipResponse.js"), exports);
 __exportStar(require("./DynamicRequestPayload.js"), exports);
 __exportStar(require("./DynamicResponsePayload.js"), exports);
 __exportStar(require("./DynamicValue.js"), exports);
 __exportStar(require("./DynamicValueListResponse.js"), exports);
 __exportStar(require("./Error_.js"), exports);
+__exportStar(require("./ExportManifestPreviewResponse.js"), exports);
+__exportStar(require("./ExportManifestResponse.js"), exports);
 __exportStar(require("./FlowBase.js"), exports);
 __exportStar(require("./FlowDetail.js"), exports);
 __exportStar(require("./FlowExecutionError.js"), exports);
 __exportStar(require("./FlowListResponse.js"), exports);
 __exportStar(require("./Folder.js"), exports);
 __exportStar(require("./FolderListResponse.js"), exports);
+__exportStar(require("./ImportManifestResponse.js"), exports);
 __exportStar(require("./ParallelSolveRequest.js"), exports);
 __exportStar(require("./ParallelSolveResponse.js"), exports);
 __exportStar(require("./RuleBase.js"), exports);
@@ -38,9 +64,16 @@ __exportStar(require("./RuleExport.js"), exports);
 __exportStar(require("./RuleListResponse.js"), exports);
 __exportStar(require("./RuleUsage.js"), exports);
 __exportStar(require("./SchemaField.js"), exports);
+__exportStar(require("./SolveContextFlowRequest.js"), exports);
+__exportStar(require("./SolveContextFlowResponse.js"), exports);
+__exportStar(require("./SolveContextRuleRequest.js"), exports);
+__exportStar(require("./SolveContextRuleResponse.js"), exports);
+__exportStar(require("./SubmitContextDataRequest.js"), exports);
+__exportStar(require("./SubmitContextDataResponse.js"), exports);
 __exportStar(require("./SuccessMessage.js"), exports);
 __exportStar(require("./Test.js"), exports);
 __exportStar(require("./TestListResponse.js"), exports);
+__exportStar(require("./UpdateContextResponse.js"), exports);
 __exportStar(require("./UsageStatistics.js"), exports);
 __exportStar(require("./UserDetail.js"), exports);
 __exportStar(require("./UserGroup.js"), exports);

package/dist/forge/values.d.ts

@@ -15,6 +15,6 @@ export declare class DynamicValues {
     private static cache;
     static configure(client: RulebricksClient): void;
     static get(name: string): Promise<DynamicValue>;
-    static set(dynamicValues: Record<string, any>, accessGroups?: string[]): Promise<void>;
+    static set(dynamicValues: Record<string, any>, user_groups?: string[]): Promise<void>;
     static clearCache(): void;
 }

package/dist/forge/values.js

@@ -73,11 +73,11 @@ class DynamicValues {
         });
     }
     static set(dynamicValues_1) {
-        return __awaiter(this, arguments, void 0, function* (dynamicValues, accessGroups = []) {
+        return __awaiter(this, arguments, void 0, function* (dynamicValues, user_groups = []) {
             if (!this.workspace) {
                 throw new Error("Workspace not configured. Call configure() first.");
             }
-            yield this.workspace.values.update({ values: dynamicValues, accessGroups });
+            yield this.workspace.values.update({ values: dynamicValues, user_groups });
             this.cache.clear();
         });
     }

package/forge/values.d.ts

@@ -15,6 +15,6 @@ export declare class DynamicValues {
     private static cache;
     static configure(client: RulebricksClient): void;
     static get(name: string): Promise<DynamicValue>;
-    static set(dynamicValues: Record<string, any>, accessGroups?: string[]): Promise<void>;
+    static set(dynamicValues: Record<string, any>, user_groups?: string[]): Promise<void>;
     static clearCache(): void;
 }

package/forge/values.js

@@ -73,11 +73,11 @@ class DynamicValues {
         });
     }
     static set(dynamicValues_1) {
-        return __awaiter(this, arguments, void 0, function* (dynamicValues, accessGroups = []) {
+        return __awaiter(this, arguments, void 0, function* (dynamicValues, user_groups = []) {
             if (!this.workspace) {
                 throw new Error("Workspace not configured. Call configure() first.");
             }
-            yield this.workspace.values.update({ values: dynamicValues, accessGroups });
+            yield this.workspace.values.update({ values: dynamicValues, user_groups });
             this.cache.clear();
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rulebricks/sdk",
-    "version": "1.5.2",
+    "version": "2.5.0",
     "private": false,
     "repository": "https://github.com/rulebricks/node-sdk",
     "main": "./index.js",
@@ -21,7 +21,6 @@
         "test": "jest"
     },
     "dependencies": {
-        "@rulebricks/sdk": "^1.2.0",
         "@types/pako": "2.0.1",
         "form-data": "4.0.0",
         "js-base64": "3.7.2",