@rulebricks/sdk 1.0.0 → 1.1.0

package/api/resources/rules/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.Rules = 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 efficiently executing individual rules in different formats
  */
@@ -69,11 +81,16 @@ class Rules {
     }
     /**
      * 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"
@@ -81,20 +98,20 @@ class Rules {
      */
     solve(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/solve/${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/solve/${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.rules.solve.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.rules.solve.Response.parseOrThrow(_response.body, {
+                return serializers.DynamicResponsePayload.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -121,7 +138,7 @@ class Rules {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.RulebricksApiTimeoutError();
+                    throw new errors.RulebricksApiTimeoutError("Timeout exceeded when calling POST /api/v1/solve/{slug}.");
                 case "unknown":
                     throw new errors.RulebricksApiError({
                         message: _response.error.errorMessage,
@@ -131,11 +148,16 @@ class Rules {
     }
     /**
      * 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"
@@ -147,20 +169,20 @@ class Rules {
      */
     bulkSolve(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/bulk-solve/${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/bulk-solve/${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.rules.bulkSolve.Request.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                requestType: "json",
+                body: serializers.rules.bulkSolve.Request.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.rules.bulkSolve.Response.parseOrThrow(_response.body, {
+                return serializers.rules.bulkSolve.Response.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -187,7 +209,7 @@ class Rules {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.RulebricksApiTimeoutError();
+                    throw new errors.RulebricksApiTimeoutError("Timeout exceeded when calling POST /api/v1/bulk-solve/{slug}.");
                 case "unknown":
                     throw new errors.RulebricksApiError({
                         message: _response.error.errorMessage,
@@ -197,43 +219,39 @@ class Rules {
     }
     /**
      * 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, 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/parallel-solve"),
+                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/parallel-solve"),
                 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.rules.parallelSolve.Request.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "strip",
-                }),
+                requestType: "json",
+                body: serializers.ParallelSolveRequest.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.rules.parallelSolve.Response.parseOrThrow(_response.body, {
+                return serializers.ParallelSolveResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -260,7 +278,7 @@ class Rules {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.RulebricksApiTimeoutError();
+                    throw new errors.RulebricksApiTimeoutError("Timeout exceeded when calling POST /api/v1/parallel-solve.");
                 case "unknown":
                     throw new errors.RulebricksApiError({
                         message: _response.error.errorMessage,
@@ -268,5 +286,11 @@ class Rules {
             }
         });
     }
+    _getCustomAuthorizationHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { "x-api-key": apiKeyValue };
+        });
+    }
 }
 exports.Rules = Rules;

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

@@ -7,21 +7,30 @@ export class Tests {
     _options: any;
     /**
      * Retrieves a list of tests associated with the rule identified by the slug.
+     *
+     * @param {string} slug - The unique identifier for the resource.
+     * @param {Tests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.NotFoundError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.tests.listRuleTests("slug")
+     *     await client.tests.listRuleTests("slug")
      */
-    listRuleTests(slug: any, requestOptions: any): any;
+    listRuleTests(slug: string, requestOptions: Tests.RequestOptions): any;
     /**
      * Adds a new test to the test suite of a rule identified by the slug.
+     *
+     * @param {string} slug - The unique identifier for the resource.
+     * @param {RulebricksApi.CreateTestRequest} request
+     * @param {Tests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.NotFoundError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.tests.createRuleTest("slug", {
+     *     await client.tests.createRuleTest("slug", {
      *         name: "Test 3",
      *         request: {
      *             "param1": "value1"
@@ -32,33 +41,47 @@ export class Tests {
      *         critical: true
      *     })
      */
-    createRuleTest(slug: any, request: any, requestOptions: any): any;
+    createRuleTest(slug: string, request: RulebricksApi.CreateTestRequest, requestOptions: Tests.RequestOptions): any;
     /**
      * Deletes a test from the test suite of a rule identified by the slug.
+     *
+     * @param {string} slug - The unique identifier for the resource.
+     * @param {string} testId - The ID of the test.
+     * @param {Tests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.NotFoundError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.tests.deleteRuleTest("slug", "testId")
+     *     await client.tests.deleteRuleTest("slug", "testId")
      */
-    deleteRuleTest(slug: any, testId: any, requestOptions: any): any;
+    deleteRuleTest(slug: string, testId: string, requestOptions: Tests.RequestOptions): any;
     /**
      * Retrieves a list of tests associated with the flow identified by the slug.
+     *
+     * @param {string} slug - The unique identifier for the resource.
+     * @param {Tests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.NotFoundError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.tests.listFlowTests("slug")
+     *     await client.tests.listFlowTests("slug")
      */
-    listFlowTests(slug: any, requestOptions: any): any;
+    listFlowTests(slug: string, requestOptions: Tests.RequestOptions): any;
     /**
      * Adds a new test to the test suite of a flow identified by the slug.
+     *
+     * @param {string} slug - The unique identifier for the resource.
+     * @param {RulebricksApi.CreateTestRequest} request
+     * @param {Tests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.NotFoundError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.tests.createFlowTest("slug", {
+     *     await client.tests.createFlowTest("slug", {
      *         name: "Test 3",
      *         request: {
      *             "param1": "value1"
@@ -69,14 +92,20 @@ export class Tests {
      *         critical: true
      *     })
      */
-    createFlowTest(slug: any, request: any, requestOptions: any): any;
+    createFlowTest(slug: string, request: RulebricksApi.CreateTestRequest, requestOptions: Tests.RequestOptions): any;
     /**
      * Deletes a test from the test suite of a flow identified by the slug.
+     *
+     * @param {string} slug - The unique identifier for the resource.
+     * @param {string} testId - The ID of the test.
+     * @param {Tests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.NotFoundError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.tests.deleteFlowTest("slug", "testId")
+     *     await client.tests.deleteFlowTest("slug", "testId")
      */
-    deleteFlowTest(slug: any, testId: any, requestOptions: any): any;
+    deleteFlowTest(slug: string, testId: string, requestOptions: Tests.RequestOptions): any;
+    _getCustomAuthorizationHeaders(): any;
 }