@rulebricks/sdk 2.5.0 → 2.5.2

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

@@ -45,7 +45,7 @@ export declare class RulesClient {
     pull(request: Rulebricks.assets.PullRulesRequest, requestOptions?: RulesClient.RequestOptions): core.HttpResponsePromise<Rulebricks.RuleExport>;
     private __pull;
     /**
-     * Import a rule into the user's account.
+     * Import or update a rule. Existing rule IDs support partial updates; new rule IDs require a full rule payload.
      *
      * @param {Rulebricks.assets.ImportRuleRequest} request
      * @param {RulesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -57,8 +57,123 @@ export declare class RulesClient {
      * @example
      *     await client.assets.rules.push({
      *         rule: {
-     *             "name": "Imported Rule",
-     *             "description": "A rule imported via API"
+     *             id: "11111111-2222-4333-8444-555555555555",
+     *             slug: "basic-pricing-rule",
+     *             name: "Basic Pricing Rule",
+     *             description: "",
+     *             createdAt: "2026-02-12T01:29:23.000Z",
+     *             updatedAt: "2026-02-12T01:29:23.000Z",
+     *             published: false,
+     *             _publish: true,
+     *             testRequest: {
+     *                 "customer_tier": "STANDARD",
+     *                 "order_total": 250,
+     *                 "expedited": false
+     *             },
+     *             sampleRequest: {
+     *                 "customer_tier": "STANDARD",
+     *                 "order_total": 250,
+     *                 "expedited": false
+     *             },
+     *             sampleResponse: {
+     *                 "discount_rate": 0,
+     *                 "approval_status": "standard"
+     *             },
+     *             requestSchema: [{
+     *                     key: "customer_tier",
+     *                     show: true,
+     *                     name: "Customer Tier",
+     *                     type: "string"
+     *                 }, {
+     *                     key: "order_total",
+     *                     show: true,
+     *                     name: "Order Total",
+     *                     type: "number"
+     *                 }, {
+     *                     key: "expedited",
+     *                     show: true,
+     *                     name: "Expedited",
+     *                     type: "boolean"
+     *                 }],
+     *             responseSchema: [{
+     *                     key: "discount_rate",
+     *                     show: true,
+     *                     name: "Discount Rate",
+     *                     type: "number"
+     *                 }, {
+     *                     key: "approval_status",
+     *                     show: true,
+     *                     name: "Approval Status",
+     *                     type: "string"
+     *                 }],
+     *             conditions: [{
+     *                     request: {
+     *                         "customer_tier": {
+     *                             op: "equals",
+     *                             args: ["VIP"]
+     *                         }
+     *                     },
+     *                     response: {
+     *                         "discount_rate": {
+     *                             value: 0.2
+     *                         },
+     *                         "approval_status": {
+     *                             value: "priority"
+     *                         }
+     *                     },
+     *                     settings: {
+     *                         enabled: true,
+     *                         groupId: null,
+     *                         priority: 0,
+     *                         schedule: []
+     *                     }
+     *                 }, {
+     *                     request: {
+     *                         "expedited": {
+     *                             op: "equals",
+     *                             args: [true]
+     *                         }
+     *                     },
+     *                     response: {
+     *                         "discount_rate": {
+     *                             value: 0.05
+     *                         },
+     *                         "approval_status": {
+     *                             value: "expedited"
+     *                         }
+     *                     },
+     *                     settings: {
+     *                         enabled: true,
+     *                         groupId: null,
+     *                         priority: 1,
+     *                         schedule: []
+     *                     }
+     *                 }, {
+     *                     request: {},
+     *                     response: {
+     *                         "discount_rate": {
+     *                             value: 0
+     *                         },
+     *                         "approval_status": {
+     *                             value: "standard"
+     *                         }
+     *                     },
+     *                     settings: {
+     *                         enabled: true,
+     *                         groupId: null,
+     *                         priority: 2,
+     *                         schedule: []
+     *                     }
+     *                 }],
+     *             history: []
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.assets.rules.push({
+     *         rule: {
+     *             id: "11111111-2222-4333-8444-555555555555",
+     *             name: "Updated Rule Name"
      *         }
      *     })
      */

package/api/resources/assets/resources/rules/client/Client.js

@@ -174,7 +174,7 @@ class RulesClient {
         });
     }
     /**
-     * Import a rule into the user's account.
+     * Import or update a rule. Existing rule IDs support partial updates; new rule IDs require a full rule payload.
      *
      * @param {Rulebricks.assets.ImportRuleRequest} request
      * @param {RulesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -186,8 +186,123 @@ class RulesClient {
      * @example
      *     await client.assets.rules.push({
      *         rule: {
-     *             "name": "Imported Rule",
-     *             "description": "A rule imported via API"
+     *             id: "11111111-2222-4333-8444-555555555555",
+     *             slug: "basic-pricing-rule",
+     *             name: "Basic Pricing Rule",
+     *             description: "",
+     *             createdAt: "2026-02-12T01:29:23.000Z",
+     *             updatedAt: "2026-02-12T01:29:23.000Z",
+     *             published: false,
+     *             _publish: true,
+     *             testRequest: {
+     *                 "customer_tier": "STANDARD",
+     *                 "order_total": 250,
+     *                 "expedited": false
+     *             },
+     *             sampleRequest: {
+     *                 "customer_tier": "STANDARD",
+     *                 "order_total": 250,
+     *                 "expedited": false
+     *             },
+     *             sampleResponse: {
+     *                 "discount_rate": 0,
+     *                 "approval_status": "standard"
+     *             },
+     *             requestSchema: [{
+     *                     key: "customer_tier",
+     *                     show: true,
+     *                     name: "Customer Tier",
+     *                     type: "string"
+     *                 }, {
+     *                     key: "order_total",
+     *                     show: true,
+     *                     name: "Order Total",
+     *                     type: "number"
+     *                 }, {
+     *                     key: "expedited",
+     *                     show: true,
+     *                     name: "Expedited",
+     *                     type: "boolean"
+     *                 }],
+     *             responseSchema: [{
+     *                     key: "discount_rate",
+     *                     show: true,
+     *                     name: "Discount Rate",
+     *                     type: "number"
+     *                 }, {
+     *                     key: "approval_status",
+     *                     show: true,
+     *                     name: "Approval Status",
+     *                     type: "string"
+     *                 }],
+     *             conditions: [{
+     *                     request: {
+     *                         "customer_tier": {
+     *                             op: "equals",
+     *                             args: ["VIP"]
+     *                         }
+     *                     },
+     *                     response: {
+     *                         "discount_rate": {
+     *                             value: 0.2
+     *                         },
+     *                         "approval_status": {
+     *                             value: "priority"
+     *                         }
+     *                     },
+     *                     settings: {
+     *                         enabled: true,
+     *                         groupId: null,
+     *                         priority: 0,
+     *                         schedule: []
+     *                     }
+     *                 }, {
+     *                     request: {
+     *                         "expedited": {
+     *                             op: "equals",
+     *                             args: [true]
+     *                         }
+     *                     },
+     *                     response: {
+     *                         "discount_rate": {
+     *                             value: 0.05
+     *                         },
+     *                         "approval_status": {
+     *                             value: "expedited"
+     *                         }
+     *                     },
+     *                     settings: {
+     *                         enabled: true,
+     *                         groupId: null,
+     *                         priority: 1,
+     *                         schedule: []
+     *                     }
+     *                 }, {
+     *                     request: {},
+     *                     response: {
+     *                         "discount_rate": {
+     *                             value: 0
+     *                         },
+     *                         "approval_status": {
+     *                             value: "standard"
+     *                         }
+     *                     },
+     *                     settings: {
+     *                         enabled: true,
+     *                         groupId: null,
+     *                         priority: 2,
+     *                         schedule: []
+     *                     }
+     *                 }],
+     *             history: []
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.assets.rules.push({
+     *         rule: {
+     *             id: "11111111-2222-4333-8444-555555555555",
+     *             name: "Updated Rule Name"
      *         }
      *     })
      */

package/api/resources/assets/resources/rules/client/requests/ImportRuleRequest.d.ts

@@ -1,13 +1,128 @@
+import type * as Rulebricks from "../../../../../../index.js";
 /**
  * @example
  *     {
  *         rule: {
- *             "name": "Imported Rule",
- *             "description": "A rule imported via API"
+ *             id: "11111111-2222-4333-8444-555555555555",
+ *             slug: "basic-pricing-rule",
+ *             name: "Basic Pricing Rule",
+ *             description: "",
+ *             createdAt: "2026-02-12T01:29:23.000Z",
+ *             updatedAt: "2026-02-12T01:29:23.000Z",
+ *             published: false,
+ *             _publish: true,
+ *             testRequest: {
+ *                 "customer_tier": "STANDARD",
+ *                 "order_total": 250,
+ *                 "expedited": false
+ *             },
+ *             sampleRequest: {
+ *                 "customer_tier": "STANDARD",
+ *                 "order_total": 250,
+ *                 "expedited": false
+ *             },
+ *             sampleResponse: {
+ *                 "discount_rate": 0,
+ *                 "approval_status": "standard"
+ *             },
+ *             requestSchema: [{
+ *                     key: "customer_tier",
+ *                     show: true,
+ *                     name: "Customer Tier",
+ *                     type: "string"
+ *                 }, {
+ *                     key: "order_total",
+ *                     show: true,
+ *                     name: "Order Total",
+ *                     type: "number"
+ *                 }, {
+ *                     key: "expedited",
+ *                     show: true,
+ *                     name: "Expedited",
+ *                     type: "boolean"
+ *                 }],
+ *             responseSchema: [{
+ *                     key: "discount_rate",
+ *                     show: true,
+ *                     name: "Discount Rate",
+ *                     type: "number"
+ *                 }, {
+ *                     key: "approval_status",
+ *                     show: true,
+ *                     name: "Approval Status",
+ *                     type: "string"
+ *                 }],
+ *             conditions: [{
+ *                     request: {
+ *                         "customer_tier": {
+ *                             op: "equals",
+ *                             args: ["VIP"]
+ *                         }
+ *                     },
+ *                     response: {
+ *                         "discount_rate": {
+ *                             value: 0.2
+ *                         },
+ *                         "approval_status": {
+ *                             value: "priority"
+ *                         }
+ *                     },
+ *                     settings: {
+ *                         enabled: true,
+ *                         groupId: null,
+ *                         priority: 0,
+ *                         schedule: []
+ *                     }
+ *                 }, {
+ *                     request: {
+ *                         "expedited": {
+ *                             op: "equals",
+ *                             args: [true]
+ *                         }
+ *                     },
+ *                     response: {
+ *                         "discount_rate": {
+ *                             value: 0.05
+ *                         },
+ *                         "approval_status": {
+ *                             value: "expedited"
+ *                         }
+ *                     },
+ *                     settings: {
+ *                         enabled: true,
+ *                         groupId: null,
+ *                         priority: 1,
+ *                         schedule: []
+ *                     }
+ *                 }, {
+ *                     request: {},
+ *                     response: {
+ *                         "discount_rate": {
+ *                             value: 0
+ *                         },
+ *                         "approval_status": {
+ *                             value: "standard"
+ *                         }
+ *                     },
+ *                     settings: {
+ *                         enabled: true,
+ *                         groupId: null,
+ *                         priority: 2,
+ *                         schedule: []
+ *                     }
+ *                 }],
+ *             history: []
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         rule: {
+ *             id: "11111111-2222-4333-8444-555555555555",
+ *             name: "Updated Rule Name"
  *         }
  *     }
  */
 export interface ImportRuleRequest {
-    /** The rule data to import. */
-    rule: Record<string, unknown>;
+    rule: Rulebricks.RuleImportPayload;
 }

package/api/types/RuleDetail.d.ts

@@ -4,12 +4,16 @@ export interface RuleDetail extends Rulebricks.RuleBase {
     created_at?: string;
     /** The date this rule was last updated. */
     updated_at?: string;
+    /** Whether the rule is currently published. */
+    published?: boolean;
+    /** Optional user-defined metadata for API-first integrations. */
+    metadata?: Record<string, unknown>;
     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. */
+    /** The request schema for the rule. Uses published schema when published, otherwise draft schema. */
     request_schema?: Rulebricks.SchemaField[];
-    /** The published response schema for the rule. */
+    /** The response schema for the rule. Uses published schema when published, otherwise draft schema. */
     response_schema?: Rulebricks.SchemaField[];
 }
 export declare namespace RuleDetail {

package/api/types/RuleImportConditionRow.d.ts

@@ -0,0 +1,11 @@
+import type * as Rulebricks from "../index.js";
+/**
+ * A single rule row containing request conditions and response output.
+ */
+export interface RuleImportConditionRow {
+    /** Request-side cells keyed by request schema field key. */
+    request: Record<string, Rulebricks.RuleImportRequestCell>;
+    /** Response-side cells keyed by response schema field key. */
+    response: Record<string, Rulebricks.RuleImportResponseCell>;
+    settings: Rulebricks.RuleImportRowSettings;
+}

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

@@ -0,0 +1,60 @@
+import type * as Rulebricks from "../index.js";
+/**
+ * Rule object accepted by /admin/rules/import. Existing rule IDs allow partial updates; creating a new rule ID requires the full legacy import shape.
+ */
+export interface RuleImportPayload {
+    /** Rule ID to create or update. */
+    id: string;
+    /** Optional stable ID for cross-workspace import/export identity. */
+    stable_id?: string;
+    /** Rule slug. */
+    slug?: string;
+    /** Rule name. */
+    name?: string;
+    /** Rule description. */
+    description?: string;
+    /** Creation timestamp. */
+    createdAt?: string;
+    /** Last update timestamp. */
+    updatedAt?: string;
+    /** Current publish state. Set with `_publish`/`_unpublish` to control publish transitions on import. */
+    published?: boolean;
+    /** Optional user-defined metadata for external IDs or implementation mappings. */
+    metadata?: Record<string, unknown>;
+    /** If true, backend publishes this rule and snapshots published_* fields from draft fields. */
+    _publish?: boolean;
+    /** If true, backend unpublishes this rule. */
+    _unpublish?: boolean;
+    /** Draft request schema. */
+    requestSchema?: Rulebricks.RuleImportSchemaField[];
+    /** Draft response schema. */
+    responseSchema?: Rulebricks.RuleImportSchemaField[];
+    /** Sample request JSON. */
+    sampleRequest?: Record<string, unknown>;
+    /** Request payload used by editor test tab. */
+    testRequest?: Record<string, unknown>;
+    /** Sample response JSON. */
+    sampleResponse?: Record<string, unknown>;
+    /** Draft condition rows. */
+    conditions?: Rulebricks.RuleImportConditionRow[];
+    /** Optional row grouping definitions. */
+    groups?: Record<string, Record<string, unknown>>;
+    /** Optional rule-level settings. */
+    settings?: Record<string, unknown>;
+    /** Optional rule test suite. */
+    testSuite?: Record<string, unknown>[];
+    /** Rule history entries. */
+    history?: Record<string, unknown>[];
+    /** Publish timestamp. */
+    publishedAt?: string | null;
+    /** Optional published request schema override. */
+    published_requestSchema?: Rulebricks.RuleImportSchemaField[] | null;
+    /** Optional published response schema override. */
+    published_responseSchema?: Rulebricks.RuleImportSchemaField[] | null;
+    /** Optional published conditions override. */
+    published_conditions?: Rulebricks.RuleImportConditionRow[] | null;
+    /** Optional published groups override. */
+    published_groups?: Record<string, Record<string, unknown> | null> | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * A request cell in a condition row.
+ */
+export interface RuleImportRequestCell {
+    /** Operator name for this request comparison. */
+    op: string;
+    /** Operator arguments. */
+    args: unknown[];
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * A response cell in a condition row.
+ */
+export interface RuleImportResponseCell {
+    value?: unknown;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * Execution settings for a condition row.
+ */
+export interface RuleImportRowSettings {
+    /** Whether this row is active. */
+    enabled: boolean;
+    /** Optional group ID for grouped aggregation. */
+    groupId: string | null;
+    /** Row priority when multiple rows match. */
+    priority: number;
+    /** Optional schedule constraints for this row. */
+    schedule: Record<string, unknown>[];
+    /** When true, request cells in this row are evaluated with OR semantics. */
+    or?: boolean;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

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

@@ -0,0 +1,36 @@
+/**
+ * A request or response schema field used when importing a rule.
+ */
+export interface RuleImportSchemaField {
+    /** Unique key for this field. */
+    key: string;
+    /** Whether this field is shown in the editor table. */
+    show: boolean;
+    /** Display name for this field. */
+    name: string;
+    /** Optional field description. */
+    description?: string;
+    /** Data type for this field. */
+    type: RuleImportSchemaField.Type;
+    /** Optional default value for this field. */
+    defaultValue?: unknown | null;
+    /** When true, this field should only accept values from a value collection. */
+    valuesOnly?: boolean;
+    /** Prefix used to scope available dynamic values for this field. */
+    valuesPrefix?: string;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}
+export declare namespace RuleImportSchemaField {
+    /** Data type for this field. */
+    const Type: {
+        readonly String: "string";
+        readonly Number: "number";
+        readonly Boolean: "boolean";
+        readonly Date: "date";
+        readonly List: "list";
+        readonly Object: "object";
+        readonly Function: "function";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/api/types/RuleImportSchemaField.js

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

package/api/types/index.d.ts

@@ -45,6 +45,12 @@ export * from "./ParallelSolveResponse.js";
 export * from "./RuleBase.js";
 export * from "./RuleDetail.js";
 export * from "./RuleExport.js";
+export * from "./RuleImportConditionRow.js";
+export * from "./RuleImportPayload.js";
+export * from "./RuleImportRequestCell.js";
+export * from "./RuleImportResponseCell.js";
+export * from "./RuleImportRowSettings.js";
+export * from "./RuleImportSchemaField.js";
 export * from "./RuleListResponse.js";
 export * from "./RuleUsage.js";
 export * from "./SchemaField.js";

package/api/types/index.js

@@ -61,6 +61,12 @@ __exportStar(require("./ParallelSolveResponse.js"), exports);
 __exportStar(require("./RuleBase.js"), exports);
 __exportStar(require("./RuleDetail.js"), exports);
 __exportStar(require("./RuleExport.js"), exports);
+__exportStar(require("./RuleImportConditionRow.js"), exports);
+__exportStar(require("./RuleImportPayload.js"), exports);
+__exportStar(require("./RuleImportRequestCell.js"), exports);
+__exportStar(require("./RuleImportResponseCell.js"), exports);
+__exportStar(require("./RuleImportRowSettings.js"), exports);
+__exportStar(require("./RuleImportSchemaField.js"), exports);
 __exportStar(require("./RuleListResponse.js"), exports);
 __exportStar(require("./RuleUsage.js"), exports);
 __exportStar(require("./SchemaField.js"), exports);