@rulebricks/sdk 1.5.0 → 2.0.0

package/api/resources/assets/resources/rules/client/index.d.ts

@@ -1 +1 @@
-export * from "./requests";
+export * from "./requests/index.js";

package/api/resources/assets/resources/rules/client/index.js

@@ -14,4 +14,4 @@ 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("./requests"), exports);
+__exportStar(require("./requests/index.js"), exports);

package/api/resources/assets/resources/rules/client/requests/DeleteRuleRequest.d.ts

@@ -1,10 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * @example
  *     {
- *         id: "id"
+ *         id: "2855f8da-2654-4df9-8903-8f797cbfe8eb"
  *     }
  */
 export interface DeleteRuleRequest {

package/api/resources/assets/resources/rules/client/requests/DeleteRuleRequest.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/assets/resources/rules/client/requests/ImportRuleRequest.d.ts

@@ -1,11 +1,9 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * @example
  *     {
  *         rule: {
- *             "key": "value"
+ *             "name": "Imported Rule",
+ *             "description": "A rule imported via API"
  *         }
  *     }
  */

package/api/resources/assets/resources/rules/client/requests/ImportRuleRequest.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/assets/resources/rules/client/requests/ListRulesRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         folder: "Marketing Rules"
+ *     }
+ */
+export interface ListRulesRequest {
+    /** Filter rules by folder name or folder ID */
+    folder?: string;
+}

package/api/resources/assets/resources/rules/client/requests/ListRulesRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/assets/resources/rules/client/requests/PullRulesRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         id: "2855f8da-2654-4df9-8903-8f797cbfe8eb"
+ *     }
+ */
+export interface PullRulesRequest {
+    /** The ID of the rule to export. */
+    id: string;
+}

package/api/resources/assets/resources/rules/client/requests/PullRulesRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/assets/resources/rules/client/requests/index.d.ts

@@ -1,4 +1,4 @@
-export { type DeleteRuleRequest } from "./DeleteRuleRequest";
-export { type RulesPullRequest } from "./RulesPullRequest";
-export { type ImportRuleRequest } from "./ImportRuleRequest";
-export { type RulesListRequest } from "./RulesListRequest";
+export type { DeleteRuleRequest } from "./DeleteRuleRequest.js";
+export type { ImportRuleRequest } from "./ImportRuleRequest.js";
+export type { ListRulesRequest } from "./ListRulesRequest.js";
+export type { PullRulesRequest } from "./PullRulesRequest.js";

package/api/resources/assets/resources/rules/index.d.ts

@@ -1 +1 @@
-export * from "./client";
+export * from "./client/index.js";

package/api/resources/assets/resources/rules/index.js

@@ -14,4 +14,4 @@ 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("./client"), exports);
+__exportStar(require("./client/index.js"), exports);

package/api/resources/assets/types/ExportAssetsResponse.d.ts

@@ -0,0 +1,2 @@
+import type * as Rulebricks from "../../../index.js";
+export type ExportAssetsResponse = Rulebricks.ExportManifestResponse | Rulebricks.ExportManifestPreviewResponse;

package/api/resources/assets/types/ExportAssetsResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/assets/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./ExportAssetsResponse.js";

package/api/resources/assets/types/index.js

@@ -0,0 +1,17 @@
+"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("./ExportAssetsResponse.js"), exports);

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

@@ -0,0 +1,167 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Rulebricks from "../../../index.js";
+import { AdminClient } from "../resources/admin/client/Client.js";
+import { RelationshipsClient } from "../resources/relationships/client/Client.js";
+export declare namespace ContextsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Operations for managing and interacting with Contexts (Entities) and their instances
+ */
+export declare class ContextsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ContextsClient.Options>;
+    protected _admin: AdminClient | undefined;
+    protected _relationships: RelationshipsClient | undefined;
+    constructor(options: ContextsClient.Options);
+    get admin(): AdminClient;
+    get relationships(): RelationshipsClient;
+    /**
+     * Retrieve the current state of a context instance.
+     *
+     * @param {Rulebricks.GetInstanceContextsRequest} request
+     * @param {ContextsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Rulebricks.NotFoundError}
+     * @throws {@link Rulebricks.InternalServerError}
+     *
+     * @example
+     *     await client.contexts.getInstance({
+     *         slug: "customer",
+     *         instance: "cust-12345"
+     *     })
+     */
+    getInstance(request: Rulebricks.GetInstanceContextsRequest, requestOptions?: ContextsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.ContextInstanceState>;
+    private __getInstance;
+    /**
+     * Submit data to a context instance, creating it if it doesn't exist. May trigger bound rule/flow evaluations.
+     *
+     * @param {Rulebricks.SubmitContextsRequest} request
+     * @param {ContextsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.NotFoundError}
+     * @throws {@link Rulebricks.InternalServerError}
+     *
+     * @example
+     *     await client.contexts.submit({
+     *         slug: "customer",
+     *         instance: "cust-12345",
+     *         body: {
+     *             "email": "customer@example.com",
+     *             "age": 30
+     *         }
+     *     })
+     */
+    submit(request: Rulebricks.SubmitContextsRequest, requestOptions?: ContextsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.SubmitContextDataResponse>;
+    private __submit;
+    /**
+     * Delete a specific context instance and its history.
+     *
+     * @param {Rulebricks.DeleteInstanceContextsRequest} request
+     * @param {ContextsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Rulebricks.NotFoundError}
+     * @throws {@link Rulebricks.InternalServerError}
+     *
+     * @example
+     *     await client.contexts.deleteInstance({
+     *         slug: "customer",
+     *         instance: "cust-12345"
+     *     })
+     */
+    deleteInstance(request: Rulebricks.DeleteInstanceContextsRequest, requestOptions?: ContextsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.DeleteContextInstanceResponse>;
+    private __deleteInstance;
+    /**
+     * Retrieve the change history for a context instance.
+     *
+     * @param {Rulebricks.GetHistoryContextsRequest} request
+     * @param {ContextsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Rulebricks.NotFoundError}
+     * @throws {@link Rulebricks.InternalServerError}
+     *
+     * @example
+     *     await client.contexts.getHistory({
+     *         slug: "customer",
+     *         instance: "cust-12345"
+     *     })
+     */
+    getHistory(request: Rulebricks.GetHistoryContextsRequest, requestOptions?: ContextsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.ContextInstanceHistory>;
+    private __getHistory;
+    /**
+     * Get list of rules/flows that need to be evaluated for this instance.
+     *
+     * @param {Rulebricks.GetPendingContextsRequest} request
+     * @param {ContextsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Rulebricks.NotFoundError}
+     * @throws {@link Rulebricks.InternalServerError}
+     *
+     * @example
+     *     await client.contexts.getPending({
+     *         slug: "customer",
+     *         instance: "cust-12345"
+     *     })
+     */
+    getPending(request: Rulebricks.GetPendingContextsRequest, requestOptions?: ContextsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.ContextInstancePendingResponse>;
+    private __getPending;
+    /**
+     * Execute a specific rule using the context instance's state as input.
+     *
+     * @param {Rulebricks.SolveContextRuleRequest} request
+     * @param {ContextsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.NotFoundError}
+     * @throws {@link Rulebricks.InternalServerError}
+     *
+     * @example
+     *     await client.contexts.solve({
+     *         slug: "customer",
+     *         instance: "cust-12345",
+     *         ruleSlug: "eligibility-check"
+     *     })
+     */
+    solve(request: Rulebricks.SolveContextRuleRequest, requestOptions?: ContextsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.SolveContextRuleResponse>;
+    private __solve;
+    /**
+     * Trigger re-evaluation of all bound rules and flows for the instance.
+     *
+     * @param {Rulebricks.CascadeContextRequest} request
+     * @param {ContextsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Rulebricks.NotFoundError}
+     * @throws {@link Rulebricks.InternalServerError}
+     *
+     * @example
+     *     await client.contexts.cascade({
+     *         slug: "customer",
+     *         instance: "cust-12345"
+     *     })
+     */
+    cascade(request: Rulebricks.CascadeContextRequest, requestOptions?: ContextsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.CascadeContextResponse>;
+    private __cascade;
+    /**
+     * Execute a specific flow using the context instance's state as input.
+     *
+     * @param {Rulebricks.SolveContextFlowRequest} request
+     * @param {ContextsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Rulebricks.BadRequestError}
+     * @throws {@link Rulebricks.NotFoundError}
+     * @throws {@link Rulebricks.InternalServerError}
+     *
+     * @example
+     *     await client.contexts.execute({
+     *         slug: "customer",
+     *         instance: "cust-12345",
+     *         flowSlug: "onboarding-flow"
+     *     })
+     */
+    execute(request: Rulebricks.SolveContextFlowRequest, requestOptions?: ContextsClient.RequestOptions): core.HttpResponsePromise<Rulebricks.SolveContextFlowResponse>;
+    private __execute;
+}