@rulebricks/sdk 1.0.0 → 1.2.0

package/api/types/FlowListResponse.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export declare type FlowListResponse = RulebricksApi.FlowDetail[];

package/api/types/Folder.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Folder {
+    /** Unique identifier for the folder. */
+    id?: string;
+    /** Name of the folder. */
+    name?: string;
+    /** Description of the folder. */
+    description?: string;
+    /** Timestamp of when the folder was last updated. */
+    updatedAt?: Date;
+}

package/api/types/FolderListResponse.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export declare type FolderListResponse = RulebricksApi.Folder[];

package/api/types/ListValue.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export interface ListValue extends RulebricksApi.DynamicValueBase {
+    /** The list value */
+    value?: string[];
+}

package/api/types/NumberValue.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export interface NumberValue extends RulebricksApi.DynamicValueBase {
+    /** The numeric value */
+    value?: number;
+}

package/api/types/ParallelSolveRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+/**
+ * A request containing multiple rule/flow executions to be run in parallel.
+ */
+export declare type ParallelSolveRequest = Record<string, RulebricksApi.ParallelSolveRequestValue>;

package/api/types/ParallelSolveRequestValue.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ParallelSolveRequestValue {
+    /** Slug of the rule to execute */
+    rule?: string;
+    /** Slug of the flow to execute */
+    flow?: string;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/api/types/ParallelSolveResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+/**
+ * Response from parallel rule/flow execution with results from each execution.
+ */
+export declare type ParallelSolveResponse = Record<string, RulebricksApi.DynamicResponsePayload>;

package/api/types/RuleBase.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RuleBase {
+    /** The unique identifier for the rule. */
+    id?: string;
+    /** The name of the rule. */
+    name?: string;
+    /** The description of the rule. */
+    description?: string;
+    /** The unique slug for the rule used in API requests. */
+    slug?: string;
+}

package/api/types/RuleDetail.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export interface RuleDetail extends RulebricksApi.RuleBase {
+    /** The date this rule was created. */
+    createdAt?: Date;
+    folder?: RulebricksApi.Folder;
+    /** The published request schema for the rule. */
+    requestSchema?: RulebricksApi.SchemaField[];
+    /** The published response schema for the rule. */
+    responseSchema?: RulebricksApi.SchemaField[];
+}

package/api/types/RuleExport.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The exported rule object containing all rule definition data.
+ */
+export declare type RuleExport = Record<string, unknown>;

package/api/types/RuleListResponse.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export declare type RuleListResponse = RulebricksApi.RuleDetail[];

package/api/types/RuleUsage.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RuleUsage {
+    /** The unique identifier for the rule. */
+    id?: string;
+    /** The name of the rule. */
+    name?: string;
+    /** The description of the rule. */
+    description?: string;
+    /** The unique slug for the rule used in API requests. */
+    slug?: string;
+    /** Whether the rule is published. */
+    published?: boolean;
+    /** The date this rule was last updated. */
+    updatedAt?: Date;
+}

package/api/types/SchemaField.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export interface SchemaField {
+    /** The unique key for this field. */
+    key?: string;
+    /** Whether this field is visible in the UI. */
+    show?: boolean;
+    /** Display name for this field. */
+    name?: string;
+    /** Description of this field. */
+    description?: string;
+    /** Data type of this field. */
+    type?: RulebricksApi.SchemaFieldType;
+    /** Default value for this field. */
+    defaultValue?: RulebricksApi.SchemaFieldDefaultValue;
+    /** Computed default value for this field. */
+    defaultComputedValue?: string;
+    /** Transformation expression to apply to this field. */
+    transform?: string;
+}

package/api/types/SchemaFieldDefaultValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Default value for this field.
+ */
+export declare type SchemaFieldDefaultValue = string | number | boolean | Record<string, unknown> | unknown[];

package/api/types/SchemaFieldType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Data type of this field.
+ */
+export declare type SchemaFieldType = "string" | "number" | "boolean" | "object" | "array";
+export declare const SchemaFieldType: {
+    readonly String: "string";
+    readonly Number: "number";
+    readonly Boolean: "boolean";
+    readonly Object: "object";
+    readonly Array: "array";
+};

package/api/types/SchemaFieldType.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaFieldType = void 0;
+exports.SchemaFieldType = {
+    String: "string",
+    Number: "number",
+    Boolean: "boolean",
+    Object: "object",
+    Array: "array",
+};

package/api/types/StringValue.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export interface StringValue extends RulebricksApi.DynamicValueBase {
+    /** The string value */
+    value?: string;
+}

package/api/types/SuccessMessage.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SuccessMessage {
+    /** Success message */
+    message?: string;
+}

package/api/types/Test.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export interface Test {
+    /** Unique identifier for the test. */
+    id: string;
+    /** The name of the test. */
+    name: string;
+    /** The request object for the test. */
+    request: Record<string, unknown>;
+    /** The expected response object for the test. */
+    response: Record<string, unknown>;
+    /** Indicates whether the test is critical. */
+    critical: boolean;
+    /** Indicates if the test resulted in an error. */
+    error: boolean;
+    /** Indicates if the test was successful. */
+    success: boolean;
+    /** The state of the test after execution. */
+    testState?: RulebricksApi.TestTestState;
+    /** The timestamp when the test was last executed. */
+    lastExecuted?: Date;
+}

package/api/types/TestListResponse.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export declare type TestListResponse = RulebricksApi.Test[];

package/api/types/TestTestState.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+/**
+ * The state of the test after execution.
+ */
+export interface TestTestState {
+    /** Execution time in seconds */
+    duration?: number;
+    /** Actual response returned */
+    response?: Record<string, unknown>;
+    conditions?: Record<string, RulebricksApi.TestTestStateConditionsItemValue>[];
+    /** HTTP status code returned */
+    httpStatus?: number;
+    successIdxs?: number[];
+    /** Error message or flag indicating if evaluation error occurred */
+    evaluationError?: RulebricksApi.TestTestStateEvaluationError;
+}

package/api/types/TestTestStateConditionsItemValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TestTestStateConditionsItemValue {
+    result?: boolean;
+    err?: string;
+}

package/api/types/TestTestStateEvaluationError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error message or flag indicating if evaluation error occurred
+ */
+export declare type TestTestStateEvaluationError = boolean | string;

package/api/types/UsageStatistics.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface UsageStatistics {
+    /** The current plan of the organization. */
+    plan?: string;
+    /** The start date of the current monthly period. */
+    monthlyPeriodStart?: string;
+    /** The end date of the current monthly period. */
+    monthlyPeriodEnd?: string;
+    /** The number of rule executions used this month. */
+    monthlyExecutionsUsage?: number;
+    /** The total number of rule executions allowed this month. */
+    monthlyExecutionsLimit?: number;
+    /** The number of rule executions remaining this month. */
+    monthlyExecutionsRemaining?: number;
+}

package/api/types/UserGroup.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface UserGroup {
+    /** Unique identifier of the user group. */
+    id?: string;
+    /** Name of the user group. */
+    name?: string;
+    /** Description of the user group. */
+    description?: string;
+    /** List of member emails in the user group. */
+    members?: string[];
+}

package/api/types/UserGroupListResponse.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export declare type UserGroupListResponse = RulebricksApi.UserGroup[];

package/api/types/UserInviteResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as RulebricksApi from "../index";
+export interface UserInviteResponse {
+    /** Success message indicating whether a new user was invited or an existing user's permissions were updated. */
+    message?: string;
+    user?: RulebricksApi.UserInviteResponseUser;
+}

package/api/types/UserInviteResponseUser.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface UserInviteResponseUser {
+    /** Email of the invited user. */
+    email?: string;
+    /** Role assigned to the user. */
+    role?: string;
+    /** Access groups assigned to the user. */
+    accessGroups?: string[];
+}

package/api/types/ValueLimits.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * System limits for dynamic values
+ */
+export interface ValueLimits {
+    /** Maximum number of value keys per user */
+    maxKeys?: number;
+    /** Maximum length of a single value in characters */
+    maxValueLength?: number;
+    /** Maximum total size of all values in bytes */
+    maxTotalSize?: number;
+    /** Maximum length of a key name */
+    maxKeyLength?: number;
+}

package/api/types/index.d.ts

@@ -1 +1,47 @@
-export var __esModule: boolean;
+export * from "./Error_";
+export * from "./SuccessMessage";
+export * from "./RuleBase";
+export * from "./RuleDetail";
+export * from "./RuleListResponse";
+export * from "./SchemaFieldType";
+export * from "./SchemaFieldDefaultValue";
+export * from "./SchemaField";
+export * from "./RuleExport";
+export * from "./FlowBase";
+export * from "./FlowExecutionError";
+export * from "./FlowDetail";
+export * from "./FlowListResponse";
+export * from "./Folder";
+export * from "./FolderListResponse";
+export * from "./TestTestStateConditionsItemValue";
+export * from "./TestTestStateEvaluationError";
+export * from "./TestTestState";
+export * from "./Test";
+export * from "./TestListResponse";
+export * from "./CreateTestRequest";
+export * from "./UserInviteResponseUser";
+export * from "./UserInviteResponse";
+export * from "./UserGroup";
+export * from "./UserGroupListResponse";
+export * from "./DecisionLogRequest";
+export * from "./DecisionLogResponse";
+export * from "./DecisionLogDecisionConditionsItemValue";
+export * from "./DecisionLogDecision";
+export * from "./DecisionLog";
+export * from "./UsageStatistics";
+export * from "./DynamicValueBase";
+export * from "./StringValue";
+export * from "./NumberValue";
+export * from "./BooleanValue";
+export * from "./ListValue";
+export * from "./DynamicValue";
+export * from "./DynamicValueListResponse";
+export * from "./RuleUsage";
+export * from "./ValueLimits";
+export * from "./DynamicRequestPayload";
+export * from "./DynamicResponsePayload";
+export * from "./BulkRuleResponseItemError";
+export * from "./BulkRuleResponseItem";
+export * from "./ParallelSolveRequestValue";
+export * from "./ParallelSolveRequest";
+export * from "./ParallelSolveResponse";

package/api/types/index.js

@@ -1,24 +1,63 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function (o, m, k, k2) {
-    if (k2 === undefined)
-        k2 = k;
+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]; } };
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
     Object.defineProperty(o, k2, desc);
-}) : (function (o, m, k, k2) {
-    if (k2 === undefined)
-        k2 = k;
+}) : (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);
+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("./BadRequestErrorBody"), exports);
-__exportStar(require("./InternalServerErrorBody"), exports);
-__exportStar(require("./NotFoundErrorBody"), exports);
-__exportStar(require("./ForbiddenErrorBody"), exports);
+__exportStar(require("./Error_"), exports);
+__exportStar(require("./SuccessMessage"), exports);
+__exportStar(require("./RuleBase"), exports);
+__exportStar(require("./RuleDetail"), exports);
+__exportStar(require("./RuleListResponse"), exports);
+__exportStar(require("./SchemaFieldType"), exports);
+__exportStar(require("./SchemaFieldDefaultValue"), exports);
+__exportStar(require("./SchemaField"), exports);
+__exportStar(require("./RuleExport"), exports);
+__exportStar(require("./FlowBase"), exports);
+__exportStar(require("./FlowExecutionError"), exports);
+__exportStar(require("./FlowDetail"), exports);
+__exportStar(require("./FlowListResponse"), exports);
+__exportStar(require("./Folder"), exports);
+__exportStar(require("./FolderListResponse"), exports);
+__exportStar(require("./TestTestStateConditionsItemValue"), exports);
+__exportStar(require("./TestTestStateEvaluationError"), exports);
+__exportStar(require("./TestTestState"), exports);
+__exportStar(require("./Test"), exports);
+__exportStar(require("./TestListResponse"), exports);
+__exportStar(require("./CreateTestRequest"), exports);
+__exportStar(require("./UserInviteResponseUser"), exports);
+__exportStar(require("./UserInviteResponse"), exports);
+__exportStar(require("./UserGroup"), exports);
+__exportStar(require("./UserGroupListResponse"), exports);
+__exportStar(require("./DecisionLogRequest"), exports);
+__exportStar(require("./DecisionLogResponse"), exports);
+__exportStar(require("./DecisionLogDecisionConditionsItemValue"), exports);
+__exportStar(require("./DecisionLogDecision"), exports);
+__exportStar(require("./DecisionLog"), exports);
+__exportStar(require("./UsageStatistics"), exports);
+__exportStar(require("./DynamicValueBase"), exports);
+__exportStar(require("./StringValue"), exports);
+__exportStar(require("./NumberValue"), exports);
+__exportStar(require("./BooleanValue"), exports);
+__exportStar(require("./ListValue"), exports);
+__exportStar(require("./DynamicValue"), exports);
+__exportStar(require("./DynamicValueListResponse"), exports);
+__exportStar(require("./RuleUsage"), exports);
+__exportStar(require("./ValueLimits"), exports);
+__exportStar(require("./DynamicRequestPayload"), exports);
+__exportStar(require("./DynamicResponsePayload"), exports);
+__exportStar(require("./BulkRuleResponseItemError"), exports);
+__exportStar(require("./BulkRuleResponseItem"), exports);
+__exportStar(require("./ParallelSolveRequestValue"), exports);
+__exportStar(require("./ParallelSolveRequest"), exports);
+__exportStar(require("./ParallelSolveResponse"), exports);

package/core/fetcher/APIResponse.d.ts

@@ -1 +1,10 @@
-export var __esModule: boolean;
+export declare type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    headers?: Record<string, any>;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+}

package/core/fetcher/Fetcher.d.ts

@@ -1,3 +1,39 @@
-export var __esModule: boolean;
-export { fetcherImpl as fetcher };
-declare function fetcherImpl(args: any): any;
+import { APIResponse } from "./APIResponse";
+export declare type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, string | undefined>;
+        queryParameters?: Record<string, string | string[] | object | object[] | null>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer";
+        duplex?: "half";
+    }
+    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
+export declare const fetcher: FetchFunction;