@rulebricks/sdk 1.2.1 → 1.4.0

package/api/resources/index.js

@@ -26,17 +26,15 @@ 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("./assets/client/requests"), exports);
 __exportStar(require("./users/client/requests"), exports);
 __exportStar(require("./values/client/requests"), exports);

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

@@ -1,11 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as RulebricksApi from "../../../index";
+import * as Rulebricks from "../../../index";
 export declare namespace Rules {
     interface Options {
-        environment: core.Supplier<string>;
+        environment?: core.Supplier<environments.RulebricksEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
@@ -31,11 +32,11 @@ export declare 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 {Rulebricks.DynamicRequestPayload} request
      * @param {Rules.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link RulebricksApi.BadRequestError}
-     * @throws {@link RulebricksApi.InternalServerError}
+     * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
      *     await client.rules.solve("slug", {
@@ -44,16 +45,16 @@ export declare class Rules {
      *         "email": "jdoe@acme.co"
      *     })
      */
-    solve(slug: string, request: RulebricksApi.DynamicRequestPayload, requestOptions?: Rules.RequestOptions): Promise<RulebricksApi.DynamicResponsePayload>;
+    solve(slug: string, request: Rulebricks.DynamicRequestPayload, requestOptions?: Rules.RequestOptions): Promise<Rulebricks.DynamicResponsePayload>;
     /**
      * 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 {Rulebricks.DynamicRequestPayload[]} request
      * @param {Rules.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link RulebricksApi.BadRequestError}
-     * @throws {@link RulebricksApi.InternalServerError}
+     * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
      *     await client.rules.bulkSolve("slug", [{
@@ -66,15 +67,15 @@ export declare class Rules {
      *             "email": "jane@example.com"
      *         }])
      */
-    bulkSolve(slug: string, request: RulebricksApi.DynamicRequestPayload[], requestOptions?: Rules.RequestOptions): Promise<RulebricksApi.BulkRuleResponseItem[]>;
+    bulkSolve(slug: string, request: Rulebricks.DynamicRequestPayload[], requestOptions?: Rules.RequestOptions): Promise<Rulebricks.BulkRuleResponseItem[]>;
     /**
      * Executes multiple rules or flows in parallel based on a provided mapping of rule/flow slugs to payloads.
      *
-     * @param {RulebricksApi.ParallelSolveRequest} request
+     * @param {Rulebricks.ParallelSolveRequest} request
      * @param {Rules.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link RulebricksApi.BadRequestError}
-     * @throws {@link RulebricksApi.InternalServerError}
+     * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
      *     await client.rules.parallelSolve({
@@ -86,7 +87,7 @@ export declare class Rules {
      *         }
      *     })
      */
-    parallelSolve(request: RulebricksApi.ParallelSolveRequest, requestOptions?: Rules.RequestOptions): Promise<RulebricksApi.ParallelSolveResponse>;
+    parallelSolve(request: Rulebricks.ParallelSolveRequest, requestOptions?: Rules.RequestOptions): Promise<Rulebricks.ParallelSolveResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "x-api-key": string;
     }>;

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

@@ -39,8 +39,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Rules = void 0;
+const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const RulebricksApi = __importStar(require("../../../index"));
+const Rulebricks = __importStar(require("../../../index"));
 const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
@@ -55,11 +56,11 @@ 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 {Rulebricks.DynamicRequestPayload} request
      * @param {Rules.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link RulebricksApi.BadRequestError}
-     * @throws {@link RulebricksApi.InternalServerError}
+     * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
      *     await client.rules.solve("slug", {
@@ -69,10 +70,10 @@ class Rules {
      *     })
      */
     solve(slug, request, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
-                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)}`),
+                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, `solve/${encodeURIComponent(slug)}`),
                 method: "POST",
                 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",
@@ -93,11 +94,11 @@ class Rules {
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
-                        throw new RulebricksApi.BadRequestError(_response.error.body);
+                        throw new Rulebricks.BadRequestError(_response.error.body);
                     case 500:
-                        throw new RulebricksApi.InternalServerError(_response.error.body);
+                        throw new Rulebricks.InternalServerError(_response.error.body);
                     default:
-                        throw new errors.RulebricksApiError({
+                        throw new errors.RulebricksError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
                         });
@@ -105,14 +106,14 @@ class Rules {
             }
             switch (_response.error.reason) {
                 case "non-json":
-                    throw new errors.RulebricksApiError({
+                    throw new errors.RulebricksError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.RulebricksApiTimeoutError("Timeout exceeded when calling POST /api/v1/solve/{slug}.");
+                    throw new errors.RulebricksTimeoutError("Timeout exceeded when calling POST /solve/{slug}.");
                 case "unknown":
-                    throw new errors.RulebricksApiError({
+                    throw new errors.RulebricksError({
                         message: _response.error.errorMessage,
                     });
             }
@@ -122,11 +123,11 @@ 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 {Rulebricks.DynamicRequestPayload[]} request
      * @param {Rules.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link RulebricksApi.BadRequestError}
-     * @throws {@link RulebricksApi.InternalServerError}
+     * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
      *     await client.rules.bulkSolve("slug", [{
@@ -140,10 +141,10 @@ class Rules {
      *         }])
      */
     bulkSolve(slug, request, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
-                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)}`),
+                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, `bulk-solve/${encodeURIComponent(slug)}`),
                 method: "POST",
                 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",
@@ -164,11 +165,11 @@ class Rules {
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
-                        throw new RulebricksApi.BadRequestError(_response.error.body);
+                        throw new Rulebricks.BadRequestError(_response.error.body);
                     case 500:
-                        throw new RulebricksApi.InternalServerError(_response.error.body);
+                        throw new Rulebricks.InternalServerError(_response.error.body);
                     default:
-                        throw new errors.RulebricksApiError({
+                        throw new errors.RulebricksError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
                         });
@@ -176,14 +177,14 @@ class Rules {
             }
             switch (_response.error.reason) {
                 case "non-json":
-                    throw new errors.RulebricksApiError({
+                    throw new errors.RulebricksError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.RulebricksApiTimeoutError("Timeout exceeded when calling POST /api/v1/bulk-solve/{slug}.");
+                    throw new errors.RulebricksTimeoutError("Timeout exceeded when calling POST /bulk-solve/{slug}.");
                 case "unknown":
-                    throw new errors.RulebricksApiError({
+                    throw new errors.RulebricksError({
                         message: _response.error.errorMessage,
                     });
             }
@@ -192,11 +193,11 @@ 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 {Rulebricks.ParallelSolveRequest} request
      * @param {Rules.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link RulebricksApi.BadRequestError}
-     * @throws {@link RulebricksApi.InternalServerError}
+     * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.InternalServerError}
      *
      * @example
      *     await client.rules.parallelSolve({
@@ -209,10 +210,10 @@ class Rules {
      *     })
      */
     parallelSolve(request, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
-                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"),
+                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, "parallel-solve"),
                 method: "POST",
                 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",
@@ -233,11 +234,11 @@ class Rules {
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
-                        throw new RulebricksApi.BadRequestError(_response.error.body);
+                        throw new Rulebricks.BadRequestError(_response.error.body);
                     case 500:
-                        throw new RulebricksApi.InternalServerError(_response.error.body);
+                        throw new Rulebricks.InternalServerError(_response.error.body);
                     default:
-                        throw new errors.RulebricksApiError({
+                        throw new errors.RulebricksError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
                         });
@@ -245,14 +246,14 @@ class Rules {
             }
             switch (_response.error.reason) {
                 case "non-json":
-                    throw new errors.RulebricksApiError({
+                    throw new errors.RulebricksError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.RulebricksApiTimeoutError("Timeout exceeded when calling POST /api/v1/parallel-solve.");
+                    throw new errors.RulebricksTimeoutError("Timeout exceeded when calling POST /parallel-solve.");
                 case "unknown":
-                    throw new errors.RulebricksApiError({
+                    throw new errors.RulebricksError({
                         message: _response.error.errorMessage,
                     });
             }

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

@@ -1,135 +1,23 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as RulebricksApi from "../../../index";
+import { Rules } from "../resources/rules/client/Client";
+import { Flows } from "../resources/flows/client/Client";
 export declare namespace Tests {
     interface Options {
-        environment: core.Supplier<string>;
+        environment?: core.Supplier<environments.RulebricksEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
     }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
-    }
 }
-/**
- * Administrative operations for programmatically managing test suites for rules and flows
- */
 export declare class Tests {
     protected readonly _options: Tests.Options;
+    protected _rules: Rules | undefined;
+    protected _flows: Flows | undefined;
     constructor(_options: Tests.Options);
-    /**
-     * 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 client.tests.listRuleTests("slug")
-     */
-    listRuleTests(slug: string, requestOptions?: Tests.RequestOptions): Promise<RulebricksApi.TestListResponse>;
-    /**
-     * 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 client.tests.createRuleTest("slug", {
-     *         name: "Test 3",
-     *         request: {
-     *             "param1": "value1"
-     *         },
-     *         response: {
-     *             "status": "success"
-     *         },
-     *         critical: true
-     *     })
-     */
-    createRuleTest(slug: string, request: RulebricksApi.CreateTestRequest, requestOptions?: Tests.RequestOptions): Promise<RulebricksApi.Test>;
-    /**
-     * 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 client.tests.deleteRuleTest("slug", "testId")
-     */
-    deleteRuleTest(slug: string, testId: string, requestOptions?: Tests.RequestOptions): Promise<RulebricksApi.Test>;
-    /**
-     * 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 client.tests.listFlowTests("slug")
-     */
-    listFlowTests(slug: string, requestOptions?: Tests.RequestOptions): Promise<RulebricksApi.TestListResponse>;
-    /**
-     * 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 client.tests.createFlowTest("slug", {
-     *         name: "Test 3",
-     *         request: {
-     *             "param1": "value1"
-     *         },
-     *         response: {
-     *             "status": "success"
-     *         },
-     *         critical: true
-     *     })
-     */
-    createFlowTest(slug: string, request: RulebricksApi.CreateTestRequest, requestOptions?: Tests.RequestOptions): Promise<RulebricksApi.Test>;
-    /**
-     * 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 client.tests.deleteFlowTest("slug", "testId")
-     */
-    deleteFlowTest(slug: string, testId: string, requestOptions?: Tests.RequestOptions): Promise<RulebricksApi.Test>;
-    protected _getCustomAuthorizationHeaders(): Promise<{
-        "x-api-key": string;
-    }>;
+    get rules(): Rules;
+    get flows(): Flows;
 }