@rulebricks/sdk 1.0.0

package/Client.d.ts

@@ -0,0 +1,26 @@
+export var __esModule: boolean;
+export class RulebricksApiClient {
+    constructor(_options: any);
+    _options: any;
+    get rules(): Client_1.Rules;
+    _rules: Client_1.Rules | undefined;
+    get flows(): Client_2.Flows;
+    _flows: Client_2.Flows | undefined;
+    get decisions(): Client_3.Decisions;
+    _decisions: Client_3.Decisions | undefined;
+    get assets(): Client_4.Assets;
+    _assets: Client_4.Assets | undefined;
+    get users(): Client_5.Users;
+    _users: Client_5.Users | undefined;
+    get tests(): Client_6.Tests;
+    _tests: Client_6.Tests | undefined;
+    get values(): Client_7.Values;
+    _values: Client_7.Values | undefined;
+}
+import Client_1 = require("./api/resources/rules/client/Client");
+import Client_2 = require("./api/resources/flows/client/Client");
+import Client_3 = require("./api/resources/decisions/client/Client");
+import Client_4 = require("./api/resources/assets/client/Client");
+import Client_5 = require("./api/resources/users/client/Client");
+import Client_6 = require("./api/resources/tests/client/Client");
+import Client_7 = require("./api/resources/values/client/Client");

package/Client.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RulebricksApiClient = void 0;
+const Client_1 = require("./api/resources/rules/client/Client");
+const Client_2 = require("./api/resources/flows/client/Client");
+const Client_3 = require("./api/resources/decisions/client/Client");
+const Client_4 = require("./api/resources/assets/client/Client");
+const Client_5 = require("./api/resources/users/client/Client");
+const Client_6 = require("./api/resources/tests/client/Client");
+const Client_7 = require("./api/resources/values/client/Client");
+class RulebricksApiClient {
+    constructor(_options) {
+        this._options = _options;
+    }
+    get rules() {
+        var _a;
+        return ((_a = this._rules) !== null && _a !== void 0 ? _a : (this._rules = new Client_1.Rules(this._options)));
+    }
+    get flows() {
+        var _a;
+        return ((_a = this._flows) !== null && _a !== void 0 ? _a : (this._flows = new Client_2.Flows(this._options)));
+    }
+    get decisions() {
+        var _a;
+        return ((_a = this._decisions) !== null && _a !== void 0 ? _a : (this._decisions = new Client_3.Decisions(this._options)));
+    }
+    get assets() {
+        var _a;
+        return ((_a = this._assets) !== null && _a !== void 0 ? _a : (this._assets = new Client_4.Assets(this._options)));
+    }
+    get users() {
+        var _a;
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_5.Users(this._options)));
+    }
+    get tests() {
+        var _a;
+        return ((_a = this._tests) !== null && _a !== void 0 ? _a : (this._tests = new Client_6.Tests(this._options)));
+    }
+    get values() {
+        var _a;
+        return ((_a = this._values) !== null && _a !== void 0 ? _a : (this._values = new Client_7.Values(this._options)));
+    }
+}
+exports.RulebricksApiClient = RulebricksApiClient;

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Prefix Software, Inc.]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,83 @@
+![Banner](banner.png)
+
+<p>
+    <a href="https://www.npmjs.com/package/@rulebricks/api" alt="npm shield">
+        <img src="https://img.shields.io/npm/v/@rulebricks/api" /></a>
+    <a href="https://github.com/rulebricks/node-sdk" alt="License">
+        <img src="https://img.shields.io/github/license/rulebricks/node-sdk" /></a>
+</p>
+
+## Documentation
+
+Find detailed examples of using this SDK in our [examples repository](https://github.com/rulebricks/examples).
+General API reference documentation is available on our User Guide [here](https://rulebricks.com/docs).
+
+## Installation
+
+```
+npm install --save @rulebricks/sdk
+# or
+yarn add @rulebricks/sdk
+```
+
+## Usage
+
+```typescript
+import { RulebricksApiClient } from "@rulebricks/sdk";
+import "dotenv/config";
+
+// Initialize the Rulebricks client
+const rb = new RulebricksApiClient({
+  environment: process.env.RULEBRICKS_ENVIRONMENT || "https://rulebricks.com",
+  apiKey:
+    process.env.RULEBRICKS_API_KEY || "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+});
+
+rb.rules.solve('tJOCd8XXXX', {
+  customer_id: 'anc39as3',
+  purchase_history: ['t-shirt', 'mug'],,
+  account_age_days: 4,
+  last_purchase_days_ago: 3,
+  email_subscription: false,
+}, {
+  // Request options (Optional, leave empty for default values)
+  // timeoutInSeconds: 10, (Optional: Use this to override the default timeout in seconds)
+  // maxRetries: 3, (Optional: Use this to override the default number of retries)
+}).then((result) => {
+  console.log(result);
+}).catch((err) => {
+  console.error(err);
+});
+```
+
+## Handling errors
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of `RulebricksApiError` will be thrown:
+
+```ts
+try {
+    // ...
+} catch (err) {
+    if (err instanceof RulebricksApiError) {
+        console.log(err.statusCode); // 400
+        console.log(err.message); // "BadRequestError"
+        console.log(err.body); // list of errors
+    }
+}
+```
+
+Error codes are as followed:
+
+| Status Code | Error Type            |
+| ----------- | --------------------- |
+| 400         | `BadRequestError`     |
+| 429         | `RateLimitError`      |
+| 500         | `InternalServerError` |
+
+## Contributing
+
+This library is generated programmatically. We suggest [opening an issue](https://github.com/rulebricks/node-sdk/issues) to discuss any issues or feature requests with us.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details.

package/api/errors/BadRequestError.d.ts

@@ -0,0 +1,7 @@
+export var __esModule: boolean;
+declare const BadRequestError_base: any;
+export class BadRequestError extends BadRequestError_base {
+    [x: string]: any;
+    constructor(body: any);
+}
+export {};

package/api/errors/BadRequestError.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function () { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function (o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestError = void 0;
+const errors = __importStar(require("../../errors"));
+class BadRequestError extends errors.RulebricksApiError {
+    constructor(body) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+        });
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+    }
+}
+exports.BadRequestError = BadRequestError;

package/api/errors/ForbiddenError.d.ts

@@ -0,0 +1,7 @@
+export var __esModule: boolean;
+declare const ForbiddenError_base: any;
+export class ForbiddenError extends ForbiddenError_base {
+    [x: string]: any;
+    constructor(body: any);
+}
+export {};

package/api/errors/ForbiddenError.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function () { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function (o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForbiddenError = void 0;
+const errors = __importStar(require("../../errors"));
+class ForbiddenError extends errors.RulebricksApiError {
+    constructor(body) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+        });
+        Object.setPrototypeOf(this, ForbiddenError.prototype);
+    }
+}
+exports.ForbiddenError = ForbiddenError;

package/api/errors/InternalServerError.d.ts

@@ -0,0 +1,7 @@
+export var __esModule: boolean;
+declare const InternalServerError_base: any;
+export class InternalServerError extends InternalServerError_base {
+    [x: string]: any;
+    constructor(body: any);
+}
+export {};

package/api/errors/InternalServerError.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function () { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function (o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalServerError = void 0;
+const errors = __importStar(require("../../errors"));
+class InternalServerError extends errors.RulebricksApiError {
+    constructor(body) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+        });
+        Object.setPrototypeOf(this, InternalServerError.prototype);
+    }
+}
+exports.InternalServerError = InternalServerError;

package/api/errors/NotFoundError.d.ts

@@ -0,0 +1,7 @@
+export var __esModule: boolean;
+declare const NotFoundError_base: any;
+export class NotFoundError extends NotFoundError_base {
+    [x: string]: any;
+    constructor(body: any);
+}
+export {};

package/api/errors/NotFoundError.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function () { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function (o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundError = void 0;
+const errors = __importStar(require("../../errors"));
+class NotFoundError extends errors.RulebricksApiError {
+    constructor(body) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}
+exports.NotFoundError = NotFoundError;

package/api/errors/index.d.ts

@@ -0,0 +1 @@
+export var __esModule: boolean;

package/api/errors/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function () { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    o[k2] = m[k];
+}));
+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("./BadRequestError"), exports);
+__exportStar(require("./InternalServerError"), exports);
+__exportStar(require("./NotFoundError"), exports);
+__exportStar(require("./ForbiddenError"), exports);

package/api/index.d.ts

@@ -0,0 +1 @@
+export var __esModule: boolean;

package/api/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function () { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function (o, m, k, k2) {
+    if (k2 === undefined)
+        k2 = k;
+    o[k2] = m[k];
+}));
+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("./resources"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./errors"), exports);

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

@@ -0,0 +1,100 @@
+export var __esModule: boolean;
+/**
+ * Administrative operations for managing rules, flows, folders, and usage
+ */
+export class Assets {
+    constructor(_options: any);
+    _options: any;
+    /**
+     * Delete a specific rule by its ID.
+     * @throws {@link RulebricksApi.BadRequestError}
+     * @throws {@link RulebricksApi.NotFoundError}
+     * @throws {@link RulebricksApi.InternalServerError}
+     *
+     * @example
+     *     await rulebricksApi.assets.deleteRule({})
+     */
+    deleteRule(request: {} | undefined, requestOptions: any): any;
+    /**
+     * Export a specific rule by its ID.
+     * @throws {@link RulebricksApi.BadRequestError}
+     * @throws {@link RulebricksApi.NotFoundError}
+     * @throws {@link RulebricksApi.InternalServerError}
+     *
+     * @example
+     *     await rulebricksApi.assets.exportRule({
+     *         id: "id"
+     *     })
+     */
+    exportRule(request: any, requestOptions: any): any;
+    /**
+     * Import a rule into the user's account.
+     * @throws {@link RulebricksApi.BadRequestError}
+     * @throws {@link RulebricksApi.ForbiddenError}
+     * @throws {@link RulebricksApi.InternalServerError}
+     *
+     * @example
+     *     await rulebricksApi.assets.importRule({
+     *         rule: {
+     *             "key": "value"
+     *         }
+     *     })
+     */
+    importRule(request: any, requestOptions: any): any;
+    /**
+     * List all rules in the organization. Optionally filter by folder name or ID.
+     * @throws {@link RulebricksApi.BadRequestError}
+     * @throws {@link RulebricksApi.InternalServerError}
+     *
+     * @example
+     *     await rulebricksApi.assets.listRules({})
+     */
+    listRules(request: {} | undefined, requestOptions: any): any;
+    /**
+     * List all flows in the organization.
+     * @throws {@link RulebricksApi.InternalServerError}
+     *
+     * @example
+     *     await rulebricksApi.assets.listFlows()
+     */
+    listFlows(requestOptions: any): any;
+    /**
+     * Get the rule execution usage of your organization.
+     *
+     * @example
+     *     await rulebricksApi.assets.usage()
+     */
+    usage(requestOptions: any): any;
+    /**
+     * Retrieve all rule folders for the authenticated user.
+     * @throws {@link RulebricksApi.InternalServerError}
+     *
+     * @example
+     *     await rulebricksApi.assets.listFolders()
+     */
+    listFolders(requestOptions: any): any;
+    /**
+     * Create a new rule folder or update an existing one for the authenticated user.
+     * @throws {@link RulebricksApi.BadRequestError}
+     * @throws {@link RulebricksApi.InternalServerError}
+     *
+     * @example
+     *     await rulebricksApi.assets.upsertFolder({
+     *         name: "Marketing Rules",
+     *         description: "Rules for marketing automation workflows"
+     *     })
+     */
+    upsertFolder(request: any, requestOptions: any): any;
+    /**
+     * Delete a specific rule folder for the authenticated user. This does not delete the rules within the folder.
+     * @throws {@link RulebricksApi.BadRequestError}
+     * @throws {@link RulebricksApi.NotFoundError}
+     * @throws {@link RulebricksApi.InternalServerError}
+     *
+     * @example
+     *     await rulebricksApi.assets.deleteFolder({
+     *         id: "abc123"
+     *     })
+     */
+    deleteFolder(request: any, requestOptions: any): any;
+}