@rulebricks/sdk 2.0.0 → 2.5.0

package/api/types/ContextRelationshipBase.d.ts

@@ -4,18 +4,20 @@ export interface ContextRelationshipBase {
     /** The type of relationship. */
     type?: ContextRelationshipBase.Type;
     /** The field key used as the foreign key. */
-    foreignKey?: string;
+    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 OneToOne: "one-to-one";
-        readonly OneToMany: "one-to-many";
-        readonly ManyToOne: "many-to-one";
+        readonly HasMany: "has_many";
+        readonly HasOne: "has_one";
+        readonly BelongsTo: "belongs_to";
     };
     type Type = (typeof Type)[keyof typeof Type];
 }

package/api/types/ContextRelationshipBase.js

@@ -6,8 +6,8 @@ var ContextRelationshipBase;
 (function (ContextRelationshipBase) {
     /** The type of relationship. */
     ContextRelationshipBase.Type = {
-        OneToOne: "one-to-one",
-        OneToMany: "one-to-many",
-        ManyToOne: "many-to-one",
+        HasMany: "has_many",
+        HasOne: "has_one",
+        BelongsTo: "belongs_to",
     };
 })(ContextRelationshipBase || (exports.ContextRelationshipBase = ContextRelationshipBase = {}));

package/api/types/ContextRelationshipIncoming.d.ts

@@ -1,6 +1,6 @@
 import type * as Rulebricks from "../index.js";
 export interface ContextRelationshipIncoming extends Rulebricks.ContextRelationshipBase {
-    sourceContext?: ContextRelationshipIncoming.SourceContext;
+    source_context?: ContextRelationshipIncoming.SourceContext;
 }
 export declare namespace ContextRelationshipIncoming {
     interface SourceContext {

package/api/types/ContextRelationshipOutgoing.d.ts

@@ -1,6 +1,6 @@
 import type * as Rulebricks from "../index.js";
 export interface ContextRelationshipOutgoing extends Rulebricks.ContextRelationshipBase {
-    targetContext?: ContextRelationshipOutgoing.TargetContext;
+    target_context?: ContextRelationshipOutgoing.TargetContext;
 }
 export declare namespace ContextRelationshipOutgoing {
     interface TargetContext {

package/api/types/ContextRelationshipsResponse.d.ts

@@ -1,5 +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/ContextSchemaField.d.ts

@@ -11,15 +11,15 @@ export interface ContextSchemaField {
     /** Data type of this field. 'function' type fields compute values dynamically. */
     type?: ContextSchemaField.Type;
     /** Default value for this field. */
-    defaultValue?: unknown | null;
+    default_value?: 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;
+    source_rule?: string | null;
     /** The flow ID that derives this field (if derived). */
-    sourceFlow?: string | null;
+    source_flow?: string | null;
     /** The source field key in the rule/flow output. */
-    sourceField?: string | null;
+    source_field?: string | null;
 }
 export declare namespace ContextSchemaField {
     /** Data type of this field. 'function' type fields compute values dynamically. */

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

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

package/api/types/ExportManifestPreviewResponse.d.ts

@@ -1,50 +1,63 @@
 export interface ExportManifestPreviewResponse {
-    counts?: ExportManifestPreviewResponse.Counts;
-    items?: ExportManifestPreviewResponse.Items;
+    /** 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 {
-    interface Counts {
-        rules?: number;
-        flows?: number;
-        contexts?: number;
-        values?: number;
+    /**
+     * Preview of assets that would be exported.
+     */
+    interface Preview {
+        counts?: Preview.Counts;
+        items?: Preview.Items;
     }
-    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;
-            }
+    namespace Preview {
+        interface Counts {
+            rules?: number;
+            flows?: number;
+            contexts?: number;
+            values?: number;
         }
-        type Flows = Flows.Item[];
-        namespace Flows {
-            interface Item {
-                id?: string;
-                name?: string;
-                slug?: string;
-            }
+        interface Items {
+            rules?: Items.Rules.Item[];
+            flows?: Items.Flows.Item[];
+            contexts?: Items.Contexts.Item[];
+            values?: Items.Values.Item[];
         }
-        type Contexts = Contexts.Item[];
-        namespace Contexts {
-            interface Item {
-                id?: string;
-                name?: string;
-                slug?: string;
+        namespace Items {
+            type Rules = Rules.Item[];
+            namespace Rules {
+                interface Item {
+                    id?: string;
+                    name?: string;
+                    slug?: string;
+                }
             }
-        }
-        type Values = Values.Item[];
-        namespace Values {
-            interface Item {
-                id?: string;
-                name?: 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/ExportManifestResponse.d.ts

@@ -1,9 +1,30 @@
 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>[];
+    /** 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/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. */
     updated_at?: string;
+    /** User groups that can view this folder. */
+    user_groups?: string[];
 }

package/api/types/ImportManifestResponse.d.ts

@@ -1,38 +1,66 @@
 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;
+    /** 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 {
-    /**
-     * Count of imported assets by type.
-     */
-    interface Imported {
-        rules?: number;
-        flows?: number;
-        contexts?: number;
-        values?: number;
+    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;
+        }
     }
-    /**
-     * Count of skipped assets by type (already exist and overwrite=false).
-     */
-    interface Skipped {
-        rules?: number;
-        flows?: number;
-        contexts?: number;
-        values?: number;
+    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;
-            id?: string;
-            error?: 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/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/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/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/api/types/UpdateContextResponse.d.ts

@@ -1,2 +1,13 @@
-import type * as Rulebricks from "../index.js";
-export type UpdateContextResponse = Rulebricks.ContextDetail;
+/**
+ * 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/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/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/api/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./BulkRuleResponseItem.js";
+export * from "./CascadeContextRequest.js";
 export * from "./CascadeContextResponse.js";
 export * from "./CascadeResult.js";
 export * from "./ContextBase.js";
@@ -8,6 +9,7 @@ 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";
@@ -46,7 +48,9 @@ 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";

package/api/types/index.js

@@ -15,6 +15,7 @@ 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);
@@ -24,6 +25,7 @@ __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);
@@ -62,7 +64,9 @@ __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);

package/dist/api/resources/assets/client/Client.d.ts

@@ -33,7 +33,7 @@ export declare class AssetsClient {
     getUsage(requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.UsageStatistics>;
     private __getUsage;
     /**
-     * Import rules, flows, contexts, and values from an RBM manifest file.
+     * Import rules, flows, contexts, and values from an Rulebricks manifest file (*.rbm).
      *
      * @param {Rulebricks.ImportManifestRequest} request
      * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -42,7 +42,7 @@ export declare class AssetsClient {
      * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
-     *     await client.assets.import({
+     *     await client.assets.importRbm({
      *         manifest: {
      *             version: "1.0",
      *             rules: [{
@@ -53,22 +53,22 @@ export declare class AssetsClient {
      *                     "name": "Onboarding Flow",
      *                     "slug": "onboarding-flow"
      *                 }],
-     *             contexts: [{
+     *             entities: [{
      *                     "name": "Customer",
      *                     "slug": "customer"
      *                 }],
      *             values: [{
-     *                     "key": "tax_rate",
+     *                     "name": "tax_rate",
      *                     "value": 0.08
      *                 }]
      *         },
-     *         overwrite: false
+     *         conflict_strategy: "update"
      *     })
      */
-    import(request: Rulebricks.ImportManifestRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.ImportManifestResponse>;
-    private __import;
+    importRbm(request: Rulebricks.ImportManifestRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.ImportManifestResponse>;
+    private __importRbm;
     /**
-     * Export selected rules, flows, contexts, and values to an RBM manifest file.
+     * Export selected rules, flows, contexts, and values to an Rulebricks manifest file (*.rbm).
      *
      * @param {Rulebricks.ExportManifestRequest} request
      * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -77,13 +77,12 @@ export declare class AssetsClient {
      * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
-     *     await client.assets.export({
-     *         rules: ["pricing-rule", "eligibility-check"],
-     *         flows: ["onboarding-flow"],
-     *         contexts: ["customer"],
-     *         values: ["tax_rate", "discount_threshold"]
+     *     await client.assets.exportRbm({
+     *         root_type: "rule",
+     *         root_ids: ["pricing-rule", "eligibility-check"],
+     *         include_downstream: false
      *     })
      */
-    export(request?: Rulebricks.ExportManifestRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.ExportAssetsResponse>;
-    private __export;
+    exportRbm(request: Rulebricks.ExportManifestRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.ExportRbmAssetsResponse>;
+    private __exportRbm;
 }