@rulebricks/sdk 1.0.0 → 1.1.0

package/dist/api/resources/decisions/client/Client.js

@@ -20,17 +20,29 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function (o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule)
-        return mod;
-    var result = {};
-    if (mod != null)
-        for (var k in mod)
-            if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
-                __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function (o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o)
+                if (Object.prototype.hasOwnProperty.call(o, k))
+                    ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule)
+            return mod;
+        var result = {};
+        if (mod != null)
+            for (var k = ownKeys(mod), i = 0; i < k.length; i++)
+                if (k[i] !== "default")
+                    __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -56,10 +68,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Decisions = void 0;
 const core = __importStar(require("../../../../core"));
-const RulebricksApi = __importStar(require("../../.."));
+const RulebricksApi = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
-const serializers = __importStar(require("../../../../serialization"));
-const errors = __importStar(require("../../../../errors"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const errors = __importStar(require("../../../../errors/index"));
 /**
  * Query highly detailed logs of prior rule executions within the last 15 days
  */
@@ -69,16 +81,21 @@ class Decisions {
     }
     /**
      * Retrieve logs for a specific user and rule, with optional date range and pagination.
+     *
+     * @param {RulebricksApi.QueryDecisionsRequest} request
+     * @param {Decisions.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.decisions.query({
+     *     await client.decisions.queryDecisions({
      *         slug: "slug"
      *     })
      */
-    query(request, requestOptions) {
+    queryDecisions(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const { slug, from: from_, to, cursor, limit } = request;
             const _queryParams = {};
             _queryParams["slug"] = slug;
@@ -95,19 +112,18 @@ class Decisions {
                 _queryParams["limit"] = limit.toString();
             }
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), "api/v1/decisions/query"),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)), "api/v1/decisions/query"),
                 method: "GET",
-                headers: {
-                    "x-api-key": yield core.Supplier.get(this._options.apiKey),
-                    "X-Fern-Language": "JavaScript",
-                },
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
+                requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.QueryResponse.parseOrThrow(_response.body, {
+                return serializers.DecisionLogResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -134,7 +150,7 @@ class Decisions {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.RulebricksApiTimeoutError();
+                    throw new errors.RulebricksApiTimeoutError("Timeout exceeded when calling GET /api/v1/decisions/query.");
                 case "unknown":
                     throw new errors.RulebricksApiError({
                         message: _response.error.errorMessage,
@@ -142,5 +158,11 @@ class Decisions {
             }
         });
     }
+    _getCustomAuthorizationHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { "x-api-key": apiKeyValue };
+        });
+    }
 }
 exports.Decisions = Decisions;

package/dist/api/resources/decisions/index.js

@@ -18,5 +18,4 @@ var __exportStar = (this && this.__exportStar) || function (m, exports) {
             __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
 __exportStar(require("./client"), exports);

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

@@ -7,15 +7,21 @@ export class Flows {
     _options: any;
     /**
      * Execute a flow by its slug.
+     *
+     * @param {string} slug - The unique identifier for the resource.
+     * @param {RulebricksApi.DynamicRequestPayload} request
+     * @param {Flows.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.flows.execute("slug", {
+     *     await client.flows.executeFlow("slug", {
      *         "name": "John Doe",
      *         "age": 30,
      *         "email": "jdoe@acme.co"
      *     })
      */
-    execute(slug: any, request: any, requestOptions: any): any;
+    executeFlow(slug: string, request: RulebricksApi.DynamicRequestPayload, requestOptions: Flows.RequestOptions): any;
+    _getCustomAuthorizationHeaders(): any;
 }

package/dist/api/resources/flows/client/Client.js

@@ -20,17 +20,29 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function (o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule)
-        return mod;
-    var result = {};
-    if (mod != null)
-        for (var k in mod)
-            if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
-                __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function (o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o)
+                if (Object.prototype.hasOwnProperty.call(o, k))
+                    ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule)
+            return mod;
+        var result = {};
+        if (mod != null)
+            for (var k = ownKeys(mod), i = 0; i < k.length; i++)
+                if (k[i] !== "default")
+                    __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -56,10 +68,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Flows = void 0;
 const core = __importStar(require("../../../../core"));
-const RulebricksApi = __importStar(require("../../.."));
-const serializers = __importStar(require("../../../../serialization"));
+const RulebricksApi = __importStar(require("../../../index"));
+const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 /**
  * Operations for executing flows, which are sequences of rules and external actions
  */
@@ -69,32 +81,37 @@ class Flows {
     }
     /**
      * Execute a flow by its slug.
+     *
+     * @param {string} slug - The unique identifier for the resource.
+     * @param {RulebricksApi.DynamicRequestPayload} request
+     * @param {Flows.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.flows.execute("slug", {
+     *     await client.flows.executeFlow("slug", {
      *         "name": "John Doe",
      *         "age": 30,
      *         "email": "jdoe@acme.co"
      *     })
      */
-    execute(slug, request, requestOptions) {
+    executeFlow(slug, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), `api/v1/flows/${slug}`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)), `api/v1/flows/${encodeURIComponent(slug)}`),
                 method: "POST",
-                headers: {
-                    "x-api-key": yield core.Supplier.get(this._options.apiKey),
-                    "X-Fern-Language": "JavaScript",
-                },
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
-                body: yield serializers.flows.execute.Request.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                requestType: "json",
+                body: serializers.DynamicRequestPayload.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.flows.execute.Response.parseOrThrow(_response.body, {
+                return serializers.DynamicResponsePayload.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -121,7 +138,7 @@ class Flows {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.RulebricksApiTimeoutError();
+                    throw new errors.RulebricksApiTimeoutError("Timeout exceeded when calling POST /api/v1/flows/{slug}.");
                 case "unknown":
                     throw new errors.RulebricksApiError({
                         message: _response.error.errorMessage,
@@ -129,5 +146,11 @@ class Flows {
             }
         });
     }
+    _getCustomAuthorizationHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { "x-api-key": apiKeyValue };
+        });
+    }
 }
 exports.Flows = Flows;

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

@@ -1,8 +1,8 @@
 export var __esModule: boolean;
-export var decisions: any;
-export var assets: any;
 export var users: any;
-export var tests: any;
 export var values: any;
 export var rules: any;
 export var flows: any;
+export var decisions: any;
+export var assets: any;
+export var tests: any;

package/dist/api/resources/index.js

@@ -17,38 +17,46 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function (o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule)
-        return mod;
-    var result = {};
-    if (mod != null)
-        for (var k in mod)
-            if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
-                __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function (o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o)
+                if (Object.prototype.hasOwnProperty.call(o, k))
+                    ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule)
+            return mod;
+        var result = {};
+        if (mod != null)
+            for (var k = ownKeys(mod), i = 0; i < k.length; i++)
+                if (k[i] !== "default")
+                    __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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.flows = exports.rules = exports.values = exports.tests = exports.users = exports.assets = exports.decisions = void 0;
-exports.decisions = __importStar(require("./decisions"));
-__exportStar(require("./decisions/types"), exports);
-exports.assets = __importStar(require("./assets"));
-__exportStar(require("./assets/types"), exports);
+exports.tests = exports.assets = exports.decisions = exports.flows = exports.rules = exports.values = exports.users = void 0;
 exports.users = __importStar(require("./users"));
 __exportStar(require("./users/types"), exports);
-exports.tests = __importStar(require("./tests"));
-__exportStar(require("./tests/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.tests = __importStar(require("./tests"));
 __exportStar(require("./decisions/client/requests"), exports);
 __exportStar(require("./assets/client/requests"), exports);
 __exportStar(require("./users/client/requests"), exports);
-__exportStar(require("./tests/client/requests"), exports);
 __exportStar(require("./values/client/requests"), exports);

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

@@ -7,24 +7,34 @@ export class Rules {
     _options: any;
     /**
      * Executes a single rule identified by a unique slug. The request and response formats are dynamic, dependent on the rule configuration.
+     *
+     * @param {string} slug - The unique identifier for the resource.
+     * @param {RulebricksApi.DynamicRequestPayload} request
+     * @param {Rules.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.rules.solve("slug", {
+     *     await client.rules.solve("slug", {
      *         "name": "John Doe",
      *         "age": 30,
      *         "email": "jdoe@acme.co"
      *     })
      */
-    solve(slug: any, request: any, requestOptions: any): any;
+    solve(slug: string, request: RulebricksApi.DynamicRequestPayload, requestOptions: Rules.RequestOptions): any;
     /**
      * Executes a particular rule against multiple request data payloads provided in a list.
+     *
+     * @param {string} slug - The unique identifier for the resource.
+     * @param {RulebricksApi.DynamicRequestPayload[]} request
+     * @param {Rules.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.rules.bulkSolve("slug", [{
+     *     await client.rules.bulkSolve("slug", [{
      *             "name": "John Doe",
      *             "age": 30,
      *             "email": "jdoe@acme.co"
@@ -34,27 +44,26 @@ export class Rules {
      *             "email": "jane@example.com"
      *         }])
      */
-    bulkSolve(slug: any, request: any, requestOptions: any): any;
+    bulkSolve(slug: string, request: RulebricksApi.DynamicRequestPayload[], requestOptions: Rules.RequestOptions): any;
     /**
      * Executes multiple rules or flows in parallel based on a provided mapping of rule/flow slugs to payloads.
+     *
+     * @param {RulebricksApi.ParallelSolveRequest} request
+     * @param {Rules.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.rules.parallelSolve({
+     *     await client.rules.parallelSolve({
      *         "eligibility": {
-     *             "rule": "1ef03ms",
-     *             "name": "John Doe",
-     *             "age": 30,
-     *             "email": "jdoe@acme.co"
+     *             rule: "1ef03ms"
      *         },
      *         "offers": {
-     *             "flow": "OvmsYwn",
-     *             "customer_id": "12345",
-     *             "last_purchase_days_ago": 30,
-     *             "selected_plan": "premium"
+     *             flow: "OvmsYwn"
      *         }
      *     })
      */
-    parallelSolve(request: any, requestOptions: any): any;
+    parallelSolve(request: RulebricksApi.ParallelSolveRequest, requestOptions: Rules.RequestOptions): any;
+    _getCustomAuthorizationHeaders(): any;
 }