@rulebricks/sdk 2.0.0 → 2.5.1

package/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;
 }

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

@@ -114,7 +114,7 @@ class AssetsClient {
         });
     }
     /**
-     * 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.
@@ -123,7 +123,7 @@ class AssetsClient {
      * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
-     *     await client.assets.import({
+     *     await client.assets.importRbm({
      *         manifest: {
      *             version: "1.0",
      *             rules: [{
@@ -134,22 +134,22 @@ 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, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__import(request, requestOptions));
+    importRbm(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__importRbm(request, requestOptions));
     }
-    __import(request, requestOptions) {
+    __importRbm(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
@@ -189,7 +189,7 @@ class AssetsClient {
         });
     }
     /**
-     * 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.
@@ -198,18 +198,17 @@ 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 = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__export(request, requestOptions));
+    exportRbm(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__exportRbm(request, requestOptions));
     }
-    __export() {
-        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+    __exportRbm(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);

package/api/resources/assets/client/requests/ExportManifestRequest.d.ts

@@ -1,23 +1,32 @@
 /**
  * @example
  *     {
- *         rules: ["pricing-rule", "eligibility-check"],
- *         flows: ["onboarding-flow"],
- *         contexts: ["customer"],
- *         values: ["tax_rate", "discount_threshold"]
+ *         root_type: "rule",
+ *         root_ids: ["pricing-rule", "eligibility-check"],
+ *         include_downstream: false
  *     }
  */
 export interface ExportManifestRequest {
-    /** Rule IDs or slugs to export. */
-    rules?: string[];
-    /** Flow IDs or slugs to export. */
-    flows?: string[];
-    /** Context IDs or slugs to export. */
-    contexts?: string[];
-    /** Value IDs or names to export. */
-    values?: string[];
-    /** Export all assets of specified types. */
-    includeAll?: boolean;
-    /** Return a preview of what would be exported without the full data. */
-    preview?: boolean;
+    /** The type of root asset to export. All dependencies will be included. */
+    root_type: ExportManifestRequest.RootType;
+    /** Array of IDs for the root assets to export. Dependencies are automatically resolved. */
+    root_ids: string[];
+    /** For context exports, whether to include rules and flows bound to the context. */
+    include_downstream?: boolean;
+    /** Optional name for the exported manifest. */
+    manifest_name?: string;
+    /** Optional description for the exported manifest. */
+    manifest_description?: string;
+    /** If true, returns a preview of what would be exported without the full data. */
+    preview_only?: boolean;
+}
+export declare namespace ExportManifestRequest {
+    /** The type of root asset to export. All dependencies will be included. */
+    const RootType: {
+        readonly Rule: "rule";
+        readonly Flow: "flow";
+        readonly Context: "context";
+        readonly Value: "value";
+    };
+    type RootType = (typeof RootType)[keyof typeof RootType];
 }

package/api/resources/assets/client/requests/ExportManifestRequest.js

@@ -1,3 +1,14 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExportManifestRequest = void 0;
+var ExportManifestRequest;
+(function (ExportManifestRequest) {
+    /** The type of root asset to export. All dependencies will be included. */
+    ExportManifestRequest.RootType = {
+        Rule: "rule",
+        Flow: "flow",
+        Context: "context",
+        Value: "value",
+    };
+})(ExportManifestRequest || (exports.ExportManifestRequest = ExportManifestRequest = {}));

package/api/resources/assets/client/requests/ImportManifestRequest.d.ts

@@ -11,23 +11,27 @@
  *                     "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"
  *     }
  */
 export interface ImportManifestRequest {
     /** The RBM manifest object containing assets to import. */
     manifest: ImportManifestRequest.Manifest;
-    /** Whether to overwrite existing assets with the same ID/slug. */
-    overwrite?: boolean;
+    /** How to handle conflicts with existing assets. 'update' overwrites, 'skip' ignores, 'error' fails. */
+    conflict_strategy?: ImportManifestRequest.ConflictStrategy;
+    /** Optional folder name to place imported assets into. Created if it doesn't exist. */
+    target_folder_name?: string;
+    /** Optional mapping for legacy flow imports to reuse existing rules. */
+    legacy_rule_mapping?: Record<string, ImportManifestRequest.LegacyRuleMapping.Value>;
 }
 export declare namespace ImportManifestRequest {
     /**
@@ -40,9 +44,29 @@ export declare namespace ImportManifestRequest {
         rules?: Record<string, unknown>[];
         /** Flows to import. */
         flows?: Record<string, unknown>[];
-        /** Contexts (entities) to import. */
-        contexts?: Record<string, unknown>[];
+        /** Contexts to import. */
+        entities?: Record<string, unknown>[];
         /** Dynamic values to import. */
         values?: Record<string, unknown>[];
     }
+    /** How to handle conflicts with existing assets. 'update' overwrites, 'skip' ignores, 'error' fails. */
+    const ConflictStrategy: {
+        readonly Update: "update";
+        readonly Skip: "skip";
+        readonly Error: "error";
+    };
+    type ConflictStrategy = (typeof ConflictStrategy)[keyof typeof ConflictStrategy];
+    namespace LegacyRuleMapping {
+        interface Value {
+            action?: Value.Action;
+            rule_id?: string;
+        }
+        namespace Value {
+            const Action: {
+                readonly Reuse: "reuse";
+                readonly Create: "create";
+            };
+            type Action = (typeof Action)[keyof typeof Action];
+        }
+    }
 }

package/api/resources/assets/client/requests/ImportManifestRequest.js

@@ -1,3 +1,23 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportManifestRequest = void 0;
+var ImportManifestRequest;
+(function (ImportManifestRequest) {
+    /** How to handle conflicts with existing assets. 'update' overwrites, 'skip' ignores, 'error' fails. */
+    ImportManifestRequest.ConflictStrategy = {
+        Update: "update",
+        Skip: "skip",
+        Error: "error",
+    };
+    let LegacyRuleMapping;
+    (function (LegacyRuleMapping) {
+        let Value;
+        (function (Value) {
+            Value.Action = {
+                Reuse: "reuse",
+                Create: "create",
+            };
+        })(Value = LegacyRuleMapping.Value || (LegacyRuleMapping.Value = {}));
+    })(LegacyRuleMapping = ImportManifestRequest.LegacyRuleMapping || (ImportManifestRequest.LegacyRuleMapping = {}));
+})(ImportManifestRequest || (exports.ImportManifestRequest = ImportManifestRequest = {}));

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"
      *         }
      *     })
      */