@rulebricks/sdk 1.3.0 → 1.5.0

package/README.md

@@ -23,12 +23,12 @@ yarn add @rulebricks/sdk
 ## Usage
 
 ```typescript
-import { RulebricksApiClient } from "@rulebricks/sdk";
+import { RulebricksClient } from "@rulebricks/sdk";
 import "dotenv/config";
 
 // Initialize the Rulebricks client
-const rb = new RulebricksApiClient({
-  environment: process.env.RULEBRICKS_ENVIRONMENT || "https://rulebricks.com",
+const rb = new RulebricksClient({
+  environment: process.env.RULEBRICKS_ENVIRONMENT || "https://rulebricks.com/api/v1",
   apiKey:
     process.env.RULEBRICKS_API_KEY || "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
 });

package/api/errors/ForbiddenError.d.ts

@@ -2,7 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index";
-import * as Rulebricks from "../index";
 export declare class ForbiddenError extends errors.RulebricksError {
-    constructor(body: Rulebricks.Error_);
+    constructor(body?: unknown);
 }

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

@@ -230,12 +230,7 @@ class Rules {
                     case 400:
                         throw new Rulebricks.BadRequestError(_response.error.body);
                     case 403:
-                        throw new Rulebricks.ForbiddenError(serializers.Error_.parseOrThrow(_response.error.body, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            breadcrumbsPrefix: ["response"],
-                        }));
+                        throw new Rulebricks.ForbiddenError(_response.error.body);
                     case 500:
                         throw new Rulebricks.InternalServerError(_response.error.body);
                     default:

package/api/resources/index.d.ts

@@ -1,11 +1,10 @@
 export * as users from "./users";
 export * from "./users/types";
-export * as values from "./values";
-export * from "./values/types";
 export * as rules from "./rules";
 export * as flows from "./flows";
 export * as decisions from "./decisions";
 export * as assets from "./assets";
+export * as values from "./values";
 export * as tests from "./tests";
 export * from "./decisions/client/requests";
 export * from "./users/client/requests";

package/api/resources/index.js

@@ -26,15 +26,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tests = exports.assets = exports.decisions = exports.flows = exports.rules = exports.values = exports.users = void 0;
+exports.tests = exports.values = exports.assets = exports.decisions = exports.flows = exports.rules = exports.users = void 0;
 exports.users = __importStar(require("./users"));
 __exportStar(require("./users/types"), exports);
-exports.values = __importStar(require("./values"));
-__exportStar(require("./values/types"), exports);
 exports.rules = __importStar(require("./rules"));
 exports.flows = __importStar(require("./flows"));
 exports.decisions = __importStar(require("./decisions"));
 exports.assets = __importStar(require("./assets"));
+exports.values = __importStar(require("./values"));
 exports.tests = __importStar(require("./tests"));
 __exportStar(require("./decisions/client/requests"), exports);
 __exportStar(require("./users/client/requests"), exports);

package/api/resources/values/client/Client.d.ts

@@ -29,24 +29,28 @@ export declare class Values {
     protected readonly _options: Values.Options;
     constructor(_options: Values.Options);
     /**
-     * Retrieve all dynamic values for the authenticated user.
+     * Retrieve all dynamic values for the authenticated user. Use the 'include' parameter to control whether usage information is returned.
      *
      * @param {Rulebricks.ValuesListRequest} request
      * @param {Values.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Rulebricks.NotFoundError}
      * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
-     *     await client.values.list()
+     *     await client.values.list({
+     *         include: "usage"
+     *     })
      */
     list(request?: Rulebricks.ValuesListRequest, requestOptions?: Values.RequestOptions): Promise<Rulebricks.DynamicValueListResponse>;
     /**
-     * Update existing dynamic values or add new ones for the authenticated user.
+     * Update existing dynamic values or add new ones for the authenticated user. Supports both flat and nested object structures. Nested objects are automatically flattened using dot notation and keys are converted to readable format (e.g., 'user_name' becomes 'User Name', nested 'user.contact_info.email' becomes 'User.Contact Info.Email').
      *
      * @param {Rulebricks.UpdateValuesRequest} request
      * @param {Values.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.ForbiddenError}
      * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
@@ -55,10 +59,60 @@ export declare class Values {
      *             "Favorite Color": "blue",
      *             "Age": 30,
      *             "Is Student": false,
-     *             "Hobbies": ["reading", "cycling"]
+     *             "Hobbies": [
+     *                 "reading",
+     *                 "cycling"
+     *             ]
      *         },
      *         accessGroups: ["marketing", "developers"]
      *     })
+     *
+     * @example
+     *     await client.values.update({
+     *         values: {
+     *             "user_profile": {
+     *                 "first_name": "Alice",
+     *                 "last_name": "Johnson",
+     *                 "contact_info": {
+     *                     "email_address": "alice@example.com",
+     *                     "phone_number": "555-0123"
+     *                 }
+     *             },
+     *             "account_settings": {
+     *                 "is_premium_user": true,
+     *                 "subscription_tier": "gold",
+     *                 "preferences": [
+     *                     "email_notifications",
+     *                     "sms_alerts"
+     *                 ]
+     *             },
+     *             "account_balance": 1250.75
+     *         },
+     *         accessGroups: ["marketing", "developers"]
+     *     })
+     *
+     * @example
+     *     await client.values.update({
+     *         values: {
+     *             "Company Name": "Acme Corp",
+     *             "company_details": {
+     *                 "founded_year": 2020,
+     *                 "employee_count": 150,
+     *                 "headquarters": {
+     *                     "city": "San Francisco",
+     *                     "state": "CA",
+     *                     "country": "USA"
+     *                 }
+     *             },
+     *             "Is Public": false,
+     *             "tags": [
+     *                 "tech",
+     *                 "startup",
+     *                 "saas"
+     *             ]
+     *         },
+     *         accessGroups: ["marketing"]
+     *     })
      */
     update(request: Rulebricks.UpdateValuesRequest, requestOptions?: Values.RequestOptions): Promise<Rulebricks.DynamicValueListResponse>;
     /**

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

@@ -53,24 +53,30 @@ class Values {
         this._options = _options;
     }
     /**
-     * Retrieve all dynamic values for the authenticated user.
+     * Retrieve all dynamic values for the authenticated user. Use the 'include' parameter to control whether usage information is returned.
      *
      * @param {Rulebricks.ValuesListRequest} request
      * @param {Values.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Rulebricks.NotFoundError}
      * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
-     *     await client.values.list()
+     *     await client.values.list({
+     *         include: "usage"
+     *     })
      */
     list(request = {}, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const { name } = request;
+            const { name, include } = request;
             const _queryParams = {};
             if (name != null) {
                 _queryParams["name"] = name;
             }
+            if (include != null) {
+                _queryParams["include"] = include;
+            }
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.RulebricksEnvironment.Default, "values"),
                 method: "GET",
@@ -92,6 +98,8 @@ class Values {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 404:
+                        throw new Rulebricks.NotFoundError(_response.error.body);
                     case 500:
                         throw new Rulebricks.InternalServerError(_response.error.body);
                     default:
@@ -117,12 +125,13 @@ class Values {
         });
     }
     /**
-     * Update existing dynamic values or add new ones for the authenticated user.
+     * Update existing dynamic values or add new ones for the authenticated user. Supports both flat and nested object structures. Nested objects are automatically flattened using dot notation and keys are converted to readable format (e.g., 'user_name' becomes 'User Name', nested 'user.contact_info.email' becomes 'User.Contact Info.Email').
      *
      * @param {Rulebricks.UpdateValuesRequest} request
      * @param {Values.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.ForbiddenError}
      * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
@@ -131,10 +140,60 @@ class Values {
      *             "Favorite Color": "blue",
      *             "Age": 30,
      *             "Is Student": false,
-     *             "Hobbies": ["reading", "cycling"]
+     *             "Hobbies": [
+     *                 "reading",
+     *                 "cycling"
+     *             ]
+     *         },
+     *         accessGroups: ["marketing", "developers"]
+     *     })
+     *
+     * @example
+     *     await client.values.update({
+     *         values: {
+     *             "user_profile": {
+     *                 "first_name": "Alice",
+     *                 "last_name": "Johnson",
+     *                 "contact_info": {
+     *                     "email_address": "alice@example.com",
+     *                     "phone_number": "555-0123"
+     *                 }
+     *             },
+     *             "account_settings": {
+     *                 "is_premium_user": true,
+     *                 "subscription_tier": "gold",
+     *                 "preferences": [
+     *                     "email_notifications",
+     *                     "sms_alerts"
+     *                 ]
+     *             },
+     *             "account_balance": 1250.75
      *         },
      *         accessGroups: ["marketing", "developers"]
      *     })
+     *
+     * @example
+     *     await client.values.update({
+     *         values: {
+     *             "Company Name": "Acme Corp",
+     *             "company_details": {
+     *                 "founded_year": 2020,
+     *                 "employee_count": 150,
+     *                 "headquarters": {
+     *                     "city": "San Francisco",
+     *                     "state": "CA",
+     *                     "country": "USA"
+     *                 }
+     *             },
+     *             "Is Public": false,
+     *             "tags": [
+     *                 "tech",
+     *                 "startup",
+     *                 "saas"
+     *             ]
+     *         },
+     *         accessGroups: ["marketing"]
+     *     })
      */
     update(request, requestOptions) {
         var _a, _b;
@@ -162,6 +221,8 @@ class Values {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new Rulebricks.BadRequestError(_response.error.body);
+                    case 403:
+                        throw new Rulebricks.ForbiddenError(_response.error.body);
                     case 500:
                         throw new Rulebricks.InternalServerError(_response.error.body);
                     default:

package/api/resources/values/client/requests/UpdateValuesRequest.d.ts

@@ -1,7 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Rulebricks from "../../../../index";
 /**
  * @example
  *     {
@@ -9,14 +8,92 @@ import * as Rulebricks from "../../../../index";
  *             "Favorite Color": "blue",
  *             "Age": 30,
  *             "Is Student": false,
- *             "Hobbies": ["reading", "cycling"]
+ *             "Hobbies": [
+ *                 "reading",
+ *                 "cycling"
+ *             ]
+ *         },
+ *         accessGroups: ["marketing", "developers"]
+ *     }
+ *
+ * @example
+ *     {
+ *         values: {
+ *             "user_profile": {
+ *                 "first_name": "Alice",
+ *                 "last_name": "Johnson",
+ *                 "contact_info": {
+ *                     "email_address": "alice@example.com",
+ *                     "phone_number": "555-0123"
+ *                 }
+ *             },
+ *             "account_settings": {
+ *                 "is_premium_user": true,
+ *                 "subscription_tier": "gold",
+ *                 "preferences": [
+ *                     "email_notifications",
+ *                     "sms_alerts"
+ *                 ]
+ *             },
+ *             "account_balance": 1250.75
+ *         },
+ *         accessGroups: ["marketing", "developers"]
+ *     }
+ *
+ * @example
+ *     {
+ *         values: {
+ *             "Company Name": "Acme Corp",
+ *             "company_details": {
+ *                 "founded_year": 2020,
+ *                 "employee_count": 150,
+ *                 "headquarters": {
+ *                     "city": "San Francisco",
+ *                     "state": "CA",
+ *                     "country": "USA"
+ *                 }
+ *             },
+ *             "Is Public": false,
+ *             "tags": [
+ *                 "tech",
+ *                 "startup",
+ *                 "saas"
+ *             ]
+ *         },
+ *         accessGroups: ["marketing"]
+ *     }
+ *
+ * @example
+ *     {
+ *         values: {
+ *             "Favorite Color": "blue",
+ *             "Age": 30,
+ *             "Is Student": false,
+ *             "Hobbies": [
+ *                 "reading",
+ *                 "cycling"
+ *             ]
+ *         },
+ *         accessGroups: ["marketing", "developers"]
+ *     }
+ *
+ * @example
+ *     {
+ *         values: {
+ *             "Favorite Color": "blue",
+ *             "Age": 30,
+ *             "Is Student": false,
+ *             "Hobbies": [
+ *                 "reading",
+ *                 "cycling"
+ *             ]
  *         },
  *         accessGroups: ["marketing", "developers"]
  *     }
  */
 export interface UpdateValuesRequest {
-    /** A flat dictionary of keys and values to update or add. */
-    values: Record<string, Rulebricks.UpdateValuesRequestValuesValue>;
+    /** A dictionary of keys and values to update or add. Supports both flat key-value pairs and nested objects. Nested objects will be automatically flattened using dot notation with readable key names (e.g., 'user.contact_info.email' becomes 'User.Contact Info.Email'). */
+    values: Record<string, unknown>;
     /** Optional array of access group names or IDs. If omitted and user belongs to access groups, values will be assigned to all user's access groups. Required if values should be restricted to specific access groups. */
     accessGroups?: string[];
 }

package/api/resources/values/client/requests/ValuesListRequest.d.ts

@@ -3,11 +3,22 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         include: "usage"
+ *     }
+ *
+ * @example
+ *     {
+ *         include: "usage"
+ *     }
  */
 export interface ValuesListRequest {
     /**
      * Query all dynamic values containing a specific name
      */
     name?: string;
+    /**
+     * Comma-separated list of additional data to include. Use 'usage' to include which rules reference each value.
+     */
+    include?: string;
 }

package/api/resources/values/index.d.ts

@@ -1,2 +1 @@
-export * from "./types";
 export * from "./client";

package/api/resources/values/index.js

@@ -14,5 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
 __exportStar(require("./client"), exports);

package/api/types/DecisionLog.d.ts

@@ -1,9 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Rulebricks from "../index";
-export interface DecisionLog {
-    request?: Rulebricks.DecisionLogRequest;
-    response?: Rulebricks.DecisionLogResponse;
-    decision?: Rulebricks.DecisionLogDecision;
-}
+/**
+ * Rule/flow execution log entry. Explore this object's schema from your Rulebricks dashboard in the Logs tab.
+ */
+export declare type DecisionLog = Record<string, unknown>;

package/api/types/DynamicValue.d.ts

@@ -2,18 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Rulebricks from "../index";
-export declare type DynamicValue = Rulebricks.DynamicValue.String | Rulebricks.DynamicValue.Number | Rulebricks.DynamicValue.Boolean | Rulebricks.DynamicValue.List;
-export declare namespace DynamicValue {
-    interface String extends Rulebricks.StringValue {
-        type: "string";
-    }
-    interface Number extends Rulebricks.NumberValue {
-        type: "number";
-    }
-    interface Boolean extends Rulebricks.BooleanValue {
-        type: "boolean";
-    }
-    interface List extends Rulebricks.ListValue {
-        type: "list";
-    }
+export interface DynamicValue {
+    /** Unique identifier for the dynamic value. */
+    id: string;
+    /** Name of the dynamic value (may include dot notation for nested properties). */
+    name: string;
+    /** Type identifier for the value (e.g., 'string', 'number', 'boolean', 'list', 'function', etc.) */
+    type: string;
+    value?: unknown;
+    /** Rules that use this dynamic value (only included when 'include=usage' parameter is used). */
+    usages?: Rulebricks.RuleUsage[];
+    /** Access groups assigned to this value. */
+    accessGroups?: string[];
 }

package/api/types/index.d.ts

@@ -23,18 +23,9 @@ export * from "./UserInviteResponseUser";
 export * from "./UserInviteResponse";
 export * from "./UserGroup";
 export * from "./UserGroupListResponse";
-export * from "./DecisionLogRequest";
-export * from "./DecisionLogResponse";
-export * from "./DecisionLogDecisionConditionsItemValue";
-export * from "./DecisionLogDecision";
 export * from "./DecisionLog";
+export * from "./DecisionLogResponse";
 export * from "./UsageStatistics";
-export * from "./DynamicValueBase";
-export * from "./StringValue";
-export * from "./NumberValue";
-export * from "./BooleanValue";
-export * from "./ListValueValueItem";
-export * from "./ListValue";
 export * from "./DynamicValue";
 export * from "./DynamicValueListResponse";
 export * from "./RuleUsage";

package/api/types/index.js

@@ -39,18 +39,9 @@ __exportStar(require("./UserInviteResponseUser"), exports);
 __exportStar(require("./UserInviteResponse"), exports);
 __exportStar(require("./UserGroup"), exports);
 __exportStar(require("./UserGroupListResponse"), exports);
-__exportStar(require("./DecisionLogRequest"), exports);
-__exportStar(require("./DecisionLogResponse"), exports);
-__exportStar(require("./DecisionLogDecisionConditionsItemValue"), exports);
-__exportStar(require("./DecisionLogDecision"), exports);
 __exportStar(require("./DecisionLog"), exports);
+__exportStar(require("./DecisionLogResponse"), exports);
 __exportStar(require("./UsageStatistics"), exports);
-__exportStar(require("./DynamicValueBase"), exports);
-__exportStar(require("./StringValue"), exports);
-__exportStar(require("./NumberValue"), exports);
-__exportStar(require("./BooleanValue"), exports);
-__exportStar(require("./ListValueValueItem"), exports);
-__exportStar(require("./ListValue"), exports);
 __exportStar(require("./DynamicValue"), exports);
 __exportStar(require("./DynamicValueListResponse"), exports);
 __exportStar(require("./RuleUsage"), exports);

package/dist/api/errors/ForbiddenError.d.ts

@@ -2,7 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index";
-import * as Rulebricks from "../index";
 export declare class ForbiddenError extends errors.RulebricksError {
-    constructor(body: Rulebricks.Error_);
+    constructor(body?: unknown);
 }

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

@@ -230,12 +230,7 @@ class Rules {
                     case 400:
                         throw new Rulebricks.BadRequestError(_response.error.body);
                     case 403:
-                        throw new Rulebricks.ForbiddenError(serializers.Error_.parseOrThrow(_response.error.body, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            breadcrumbsPrefix: ["response"],
-                        }));
+                        throw new Rulebricks.ForbiddenError(_response.error.body);
                     case 500:
                         throw new Rulebricks.InternalServerError(_response.error.body);
                     default:

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

@@ -1,11 +1,10 @@
 export * as users from "./users";
 export * from "./users/types";
-export * as values from "./values";
-export * from "./values/types";
 export * as rules from "./rules";
 export * as flows from "./flows";
 export * as decisions from "./decisions";
 export * as assets from "./assets";
+export * as values from "./values";
 export * as tests from "./tests";
 export * from "./decisions/client/requests";
 export * from "./users/client/requests";

package/dist/api/resources/index.js

@@ -26,15 +26,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tests = exports.assets = exports.decisions = exports.flows = exports.rules = exports.values = exports.users = void 0;
+exports.tests = exports.values = exports.assets = exports.decisions = exports.flows = exports.rules = exports.users = void 0;
 exports.users = __importStar(require("./users"));
 __exportStar(require("./users/types"), exports);
-exports.values = __importStar(require("./values"));
-__exportStar(require("./values/types"), exports);
 exports.rules = __importStar(require("./rules"));
 exports.flows = __importStar(require("./flows"));
 exports.decisions = __importStar(require("./decisions"));
 exports.assets = __importStar(require("./assets"));
+exports.values = __importStar(require("./values"));
 exports.tests = __importStar(require("./tests"));
 __exportStar(require("./decisions/client/requests"), exports);
 __exportStar(require("./users/client/requests"), exports);