@domu-ai/kiban-sdk 1.72.0

package/dashboard/schemas.js

@@ -0,0 +1,258 @@
+"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 __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 () {
+    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.CreateBody = exports.createBodyTimeSlotsItemTimeRegExp = exports.PreviewResponse = exports.PreviewBody = exports.previewBodyTimeSlotsItemTimeRegExp = exports.UpdateReviewResponse = exports.UpdateReviewBody = exports.updateReviewBodyNotesMax = exports.UpdateReviewParams = exports.GetReviewStatusResponse = exports.GetReviewStatusBody = exports.GetCallResponse = exports.GetCallParams = exports.GetOutputFieldsResponse = exports.GetInputFieldsResponse = exports.GetAgentsResponse = exports.GetScheduleConfigResponse = exports.GetScheduleConfigParams = exports.GetCampaignsResponse = exports.GetCampaignNamesResponse = exports.GetCampaignNamesBody = void 0;
+/**
+ * Generated by orval v8.2.0 🍺
+ * Do not edit manually.
+ * Kiban Dashboard API
+ * Dashboard endpoints for authenticated backoffice operations and campaign management.
+ * OpenAPI spec version: 1.0.0
+ */
+const zod = __importStar(require("zod"));
+/**
+ * Returns a map of campaign ID to campaign name for the specified campaign IDs.
+ * @summary Get campaign names by IDs
+ */
+exports.GetCampaignNamesBody = zod.object({
+    "campaignIds": zod.array(zod.string()).min(1)
+});
+exports.GetCampaignNamesResponse = zod.object({
+    "data": zod.record(zod.string(), zod.string().nullable())
+});
+/**
+ * Returns a list of campaigns for the authenticated user's organization.
+ * @summary List campaigns
+ */
+exports.GetCampaignsResponse = zod.object({
+    "data": zod.array(zod.object({
+        "id": zod.string(),
+        "name": zod.string().nullable()
+    }))
+});
+/**
+ * Returns campaign configuration needed for the schedule builder: timezone, contact hours, phone columns, and target count.
+ * @summary Get campaign schedule configuration
+ */
+exports.GetScheduleConfigParams = zod.object({
+    "campaignId": zod.string()
+});
+exports.GetScheduleConfigResponse = zod.object({
+    "data": zod.object({
+        "campaign_id": zod.string(),
+        "campaign_name": zod.string(),
+        "timezone": zod.string().nullable(),
+        "phone_columns": zod.array(zod.string()),
+        "contact_hours": zod.object({
+            "monday": zod.object({
+                "minHour": zod.number(),
+                "maxHour": zod.number()
+            }).optional(),
+            "tuesday": zod.object({
+                "minHour": zod.number(),
+                "maxHour": zod.number()
+            }).optional(),
+            "wednesday": zod.object({
+                "minHour": zod.number(),
+                "maxHour": zod.number()
+            }).optional(),
+            "thursday": zod.object({
+                "minHour": zod.number(),
+                "maxHour": zod.number()
+            }).optional(),
+            "friday": zod.object({
+                "minHour": zod.number(),
+                "maxHour": zod.number()
+            }).optional(),
+            "saturday": zod.object({
+                "minHour": zod.number(),
+                "maxHour": zod.number()
+            }).optional(),
+            "sunday": zod.object({
+                "minHour": zod.number(),
+                "maxHour": zod.number()
+            }).optional()
+        }),
+        "max_attempts": zod.number(),
+        "contact_limit": zod.number().nullable(),
+        "allowed_call_holidays": zod.array(zod.string()).nullable(),
+        "loaded_target_count": zod.number()
+    })
+});
+/**
+ * Returns a list of agents for the authenticated user's organization.
+ * @summary List agents
+ */
+exports.GetAgentsResponse = zod.object({
+    "data": zod.array(zod.object({
+        "id": zod.string(),
+        "name": zod.string().nullable(),
+        "campaign_id": zod.string()
+    }))
+});
+/**
+ * Returns unique input field labels from all campaigns for the authenticated user's organization.
+ * @summary List input field keys
+ */
+exports.GetInputFieldsResponse = zod.object({
+    "data": zod.array(zod.string())
+});
+/**
+ * Returns unique output field keys from all calls for the authenticated user's organization.
+ * @summary List output field keys
+ */
+exports.GetOutputFieldsResponse = zod.object({
+    "data": zod.array(zod.string())
+});
+/**
+ * Returns full call details including target information and input fields.
+ * @summary Get call details by ID
+ */
+exports.GetCallParams = zod.object({
+    "callId": zod.string()
+});
+exports.GetCallResponse = zod.object({
+    "call": zod.unknown().nullish()
+});
+/**
+ * Returns the review status (reviewed flag and notes) for the specified call IDs.
+ * @summary Get review status for multiple calls
+ */
+exports.GetReviewStatusBody = zod.object({
+    "callIds": zod.array(zod.string()).min(1)
+});
+exports.GetReviewStatusResponse = zod.object({
+    "data": zod.record(zod.string(), zod.object({
+        "reviewed": zod.boolean(),
+        "notes": zod.string().nullable()
+    }))
+});
+/**
+ * Updates the reviewed flag and/or notes for a specific call.
+ * @summary Update call review status
+ */
+exports.UpdateReviewParams = zod.object({
+    "callId": zod.string()
+});
+exports.updateReviewBodyNotesMax = 1000;
+exports.UpdateReviewBody = zod.object({
+    "reviewed": zod.boolean().optional(),
+    "notes": zod.string().max(exports.updateReviewBodyNotesMax).optional()
+});
+exports.UpdateReviewResponse = zod.object({
+    "data": zod.object({
+        "reviewed": zod.boolean(),
+        "notes": zod.string().nullable()
+    })
+});
+/**
+ * Generates journey JSON from schedule config and validates compliance rules. Returns journey, warnings, target count, and estimated steps without persisting anything.
+ * @summary Preview a campaign schedule
+ */
+exports.previewBodyTimeSlotsItemTimeRegExp = new RegExp('^([01]\\d|2[0-3]):([0-5]\\d)$');
+exports.PreviewBody = zod.object({
+    "campaign_id": zod.string().min(1),
+    "name": zod.string().optional(),
+    "time_slots": zod.array(zod.object({
+        "id": zod.string(),
+        "time": zod.string().regex(exports.previewBodyTimeSlotsItemTimeRegExp),
+        "days_of_week": zod.array(zod.union([zod.literal(1), zod.literal(2), zod.literal(3), zod.literal(4), zod.literal(5), zod.literal(6), zod.literal(7)])).min(1)
+    })).min(1),
+    "phone_rotation": zod.object({
+        "statuses": zod.array(zod.enum(['primary', 'secondary', 'tertiary', 'quaternary', 'quinary', 'senary', 'septenary'])).min(1),
+        "minutes_between": zod.number().min(1)
+    })
+});
+exports.PreviewResponse = zod.object({
+    "data": zod.object({
+        "journey": zod.object({
+            "name": zod.string(),
+            "steps": zod.array(zod.object({
+                "name": zod.string(),
+                "type": zod.enum(['call', 'message', 'wait']),
+                "params": zod.object({
+                    "cron": zod.object({
+                        "year": zod.string(),
+                        "month": zod.string(),
+                        "day_of_month": zod.string(),
+                        "day_of_week": zod.string(),
+                        "hours": zod.string(),
+                        "minutes": zod.string()
+                    }),
+                    "max_attempts": zod.number(),
+                    "label": zod.string().optional(),
+                    "slug": zod.string().optional(),
+                    "filter": zod.object({
+                        "phone_number_status": zod.string().optional(),
+                        "timezone": zod.string().optional()
+                    }).optional()
+                }),
+                "condition": zod.object({
+                    "if": zod.unknown()
+                }).optional(),
+                "next": zod.string().optional()
+            }))
+        }),
+        "warnings": zod.array(zod.object({
+            "type": zod.enum(['outside_contact_hours', 'no_contact_hours', 'holiday_conflict', 'invalid_cron', 'slot_overlap']),
+            "message": zod.string(),
+            "slot_id": zod.string(),
+            "severity": zod.enum(['error', 'warning', 'info']),
+            "day": zod.string().optional(),
+            "time": zod.string().optional()
+        })),
+        "target_count": zod.number(),
+        "estimated_steps": zod.number()
+    })
+});
+/**
+ * Creates a journey from schedule config. Validates compliance rules and rejects with 400 if blocking errors exist. Returns 409 if journey name already exists. Optionally activates the journey.
+ * @summary Create a campaign schedule
+ */
+exports.createBodyTimeSlotsItemTimeRegExp = new RegExp('^([01]\\d|2[0-3]):([0-5]\\d)$');
+exports.CreateBody = zod.object({
+    "campaign_id": zod.string().min(1),
+    "name": zod.string().optional(),
+    "time_slots": zod.array(zod.object({
+        "id": zod.string(),
+        "time": zod.string().regex(exports.createBodyTimeSlotsItemTimeRegExp),
+        "days_of_week": zod.array(zod.union([zod.literal(1), zod.literal(2), zod.literal(3), zod.literal(4), zod.literal(5), zod.literal(6), zod.literal(7)])).min(1)
+    })).min(1),
+    "phone_rotation": zod.object({
+        "statuses": zod.array(zod.enum(['primary', 'secondary', 'tertiary', 'quaternary', 'quinary', 'senary', 'septenary'])).min(1),
+        "minutes_between": zod.number().min(1)
+    }),
+    "activate": zod.boolean().optional()
+});

package/fetcher.d.ts

@@ -0,0 +1,2 @@
+export * from "./shared/fetcher";
+export { default } from "./shared/fetcher";

package/fetcher.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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+__exportStar(require("./shared/fetcher"), exports);
+var fetcher_1 = require("./shared/fetcher");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(fetcher_1).default; } });

package/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Kiban API SDK entrypoint.
+ *
+ * Public API functions remain available at root for backwards compatibility.
+ * Internal and dashboard SDKs are namespaced exports.
+ */
+export * from "./public";
+export * as publicSdk from "./public";
+export * as internalSdk from "./internal";
+export * as dashboardSdk from "./dashboard";
+export { setAuthToken, clearAuthToken, setApiBaseUrl, clearApiBaseUrl, getApiBaseUrl, } from "./shared/fetcher";

package/index.js

@@ -0,0 +1,55 @@
+"use strict";
+/**
+ * Kiban API SDK entrypoint.
+ *
+ * Public API functions remain available at root for backwards compatibility.
+ * Internal and dashboard SDKs are namespaced exports.
+ */
+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 __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 __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.getApiBaseUrl = exports.clearApiBaseUrl = exports.setApiBaseUrl = exports.clearAuthToken = exports.setAuthToken = exports.dashboardSdk = exports.internalSdk = exports.publicSdk = void 0;
+__exportStar(require("./public"), exports);
+exports.publicSdk = __importStar(require("./public"));
+exports.internalSdk = __importStar(require("./internal"));
+exports.dashboardSdk = __importStar(require("./dashboard"));
+var fetcher_1 = require("./shared/fetcher");
+Object.defineProperty(exports, "setAuthToken", { enumerable: true, get: function () { return fetcher_1.setAuthToken; } });
+Object.defineProperty(exports, "clearAuthToken", { enumerable: true, get: function () { return fetcher_1.clearAuthToken; } });
+Object.defineProperty(exports, "setApiBaseUrl", { enumerable: true, get: function () { return fetcher_1.setApiBaseUrl; } });
+Object.defineProperty(exports, "clearApiBaseUrl", { enumerable: true, get: function () { return fetcher_1.clearApiBaseUrl; } });
+Object.defineProperty(exports, "getApiBaseUrl", { enumerable: true, get: function () { return fetcher_1.getApiBaseUrl; } });