@rulebricks/sdk 1.0.0 → 1.1.0

package/README.md

@@ -1,8 +1,8 @@
 ![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://www.npmjs.com/package/@rulebricks/sdk" alt="npm shield">
+        <img src="https://img.shields.io/npm/v/@rulebricks/sdk" /></a>
     <a href="https://github.com/rulebricks/node-sdk" alt="License">
         <img src="https://img.shields.io/github/license/rulebricks/node-sdk" /></a>
 </p>

package/api/errors/BadRequestError.js

@@ -20,20 +20,32 @@ 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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BadRequestError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class BadRequestError extends errors.RulebricksApiError {
     constructor(body) {
         super({

package/api/errors/ForbiddenError.js

@@ -20,20 +20,32 @@ 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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForbiddenError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class ForbiddenError extends errors.RulebricksApiError {
     constructor(body) {
         super({

package/api/errors/InternalServerError.js

@@ -20,20 +20,32 @@ 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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalServerError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class InternalServerError extends errors.RulebricksApiError {
     constructor(body) {
         super({

package/api/errors/NotFoundError.js

@@ -20,20 +20,32 @@ 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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class NotFoundError extends errors.RulebricksApiError {
     constructor(body) {
         super({

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

@@ -7,94 +7,129 @@ export class Assets {
     _options: any;
     /**
      * Delete a specific rule by its ID.
+     *
+     * @param {RulebricksApi.DeleteRuleRequest} request
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.NotFoundError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.assets.deleteRule({})
+     *     await client.assets.deleteRule({
+     *         id: "id"
+     *     })
      */
-    deleteRule(request: {} | undefined, requestOptions: any): any;
+    deleteRule(request: RulebricksApi.DeleteRuleRequest, requestOptions: Assets.RequestOptions): any;
     /**
      * Export a specific rule by its ID.
+     *
+     * @param {RulebricksApi.ExportRuleRequest} request
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.NotFoundError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.assets.exportRule({
+     *     await client.assets.exportRule({
      *         id: "id"
      *     })
      */
-    exportRule(request: any, requestOptions: any): any;
+    exportRule(request: RulebricksApi.ExportRuleRequest, requestOptions: Assets.RequestOptions): any;
     /**
      * Import a rule into the user's account.
+     *
+     * @param {RulebricksApi.ImportRuleRequest} request
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.ForbiddenError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.assets.importRule({
+     *     await client.assets.importRule({
      *         rule: {
      *             "key": "value"
      *         }
      *     })
      */
-    importRule(request: any, requestOptions: any): any;
+    importRule(request: RulebricksApi.ImportRuleRequest, requestOptions: Assets.RequestOptions): any;
     /**
      * List all rules in the organization. Optionally filter by folder name or ID.
+     *
+     * @param {RulebricksApi.ListRulesRequest} request
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.assets.listRules({})
+     *     await client.assets.listRules()
      */
-    listRules(request: {} | undefined, requestOptions: any): any;
+    listRules(...args: any[]): any;
     /**
      * List all flows in the organization.
+     *
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.assets.listFlows()
+     *     await client.assets.listFlows()
      */
-    listFlows(requestOptions: any): any;
+    listFlows(requestOptions: Assets.RequestOptions): any;
     /**
      * Get the rule execution usage of your organization.
      *
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
-     *     await rulebricksApi.assets.usage()
+     *     await client.assets.getUsage()
      */
-    usage(requestOptions: any): any;
+    getUsage(requestOptions: Assets.RequestOptions): any;
     /**
      * Retrieve all rule folders for the authenticated user.
+     *
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.assets.listFolders()
+     *     await client.assets.listFolders()
      */
-    listFolders(requestOptions: any): any;
+    listFolders(requestOptions: Assets.RequestOptions): any;
     /**
      * Create a new rule folder or update an existing one for the authenticated user.
+     *
+     * @param {RulebricksApi.UpsertFolderRequest} request
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.assets.upsertFolder({
+     *     await client.assets.upsertFolder({
      *         name: "Marketing Rules",
      *         description: "Rules for marketing automation workflows"
      *     })
      */
-    upsertFolder(request: any, requestOptions: any): any;
+    upsertFolder(request: RulebricksApi.UpsertFolderRequest, requestOptions: Assets.RequestOptions): any;
     /**
      * Delete a specific rule folder for the authenticated user. This does not delete the rules within the folder.
+     *
+     * @param {RulebricksApi.DeleteFolderRequest} request
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link RulebricksApi.BadRequestError}
      * @throws {@link RulebricksApi.NotFoundError}
      * @throws {@link RulebricksApi.InternalServerError}
      *
      * @example
-     *     await rulebricksApi.assets.deleteFolder({
+     *     await client.assets.deleteFolder({
      *         id: "abc123"
      *     })
      */
-    deleteFolder(request: any, requestOptions: any): any;
+    deleteFolder(request: RulebricksApi.DeleteFolderRequest, requestOptions: Assets.RequestOptions): any;
+    _getCustomAuthorizationHeaders(): any;
 }