@segmentflow/segmentflow-mcp 0.7.0

package/local-docs-search.js

@@ -0,0 +1,635 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+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;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalDocsSearch = void 0;
+const minisearch_1 = __importDefault(require("minisearch"));
+const fs = __importStar(require("node:fs/promises"));
+const path = __importStar(require("node:path"));
+const logger_1 = require("./logger.js");
+const EMBEDDED_METHODS = [
+    {
+        name: 'get_brand_kit',
+        endpoint: '/api/v1/public/brand-kit',
+        httpMethod: 'get',
+        summary: 'List brand kits',
+        description: 'List brand kits',
+        stainlessPath: '(resource) v1.public > (method) get_brand_kit',
+        qualified: 'client.v1.public.getBrandKit',
+        response: '{ brandKits: { id: string; companyName: string; createdAt: string; isPrimary: boolean; logoUrl: string; name: string; previewColors: string[]; primaryFont: string; slug: string; updatedAt: string; website: string; }[]; count: number; }',
+        markdown: "## get_brand_kit\n\n`client.v1.public.getBrandKit(): { brandKits: object[]; count: number; }`\n\n**get** `/api/v1/public/brand-kit`\n\nList brand kits\n\n### Returns\n\n- `{ brandKits: { id: string; companyName: string; createdAt: string; isPrimary: boolean; logoUrl: string; name: string; previewColors: string[]; primaryFont: string; slug: string; updatedAt: string; website: string; }[]; count: number; }`\n\n  - `brandKits: { id: string; companyName: string; createdAt: string; isPrimary: boolean; logoUrl: string; name: string; previewColors: string[]; primaryFont: string; slug: string; updatedAt: string; website: string; }[]`\n  - `count: number`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.getBrandKit();\n\nconsole.log(response);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.getBrandKit',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.public.getBrandKit();\n\nconsole.log(response.brandKits);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/brand-kit \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY"',
+            },
+        },
+    },
+    {
+        name: 'trigger',
+        endpoint: '/api/v1/public/journeys/{id}/trigger',
+        httpMethod: 'post',
+        summary: 'Trigger a journey for a profile',
+        description: 'Start an API-triggerable journey for a single profile. Returns immediately; poll GET /journeys/runs/{runId} for status. Supports Idempotency-Key header.',
+        stainlessPath: '(resource) v1.public.journeys > (method) trigger',
+        qualified: 'client.v1.public.journeys.trigger',
+        params: [
+            'id: string;',
+            'profile: { anonymousId?: string; email?: string; userId?: string; };',
+            'variables?: object;',
+        ],
+        response: "{ runId: string; status: 'queued' | 'running' | 'completed' | 'failed' | 'exited'; }",
+        markdown: "## trigger\n\n`client.v1.public.journeys.trigger(id: string, profile: { anonymousId?: string; email?: string; userId?: string; }, variables?: object): { runId: string; status: 'queued' | 'running' | 'completed' | 'failed' | 'exited'; }`\n\n**post** `/api/v1/public/journeys/{id}/trigger`\n\nStart an API-triggerable journey for a single profile. Returns immediately; poll GET /journeys/runs/{runId} for status. Supports Idempotency-Key header.\n\n### Parameters\n\n- `id: string`\n\n- `profile: { anonymousId?: string; email?: string; userId?: string; }`\n  - `anonymousId?: string`\n  - `email?: string`\n  - `userId?: string`\n\n- `variables?: object`\n\n### Returns\n\n- `{ runId: string; status: 'queued' | 'running' | 'completed' | 'failed' | 'exited'; }`\n\n  - `runId: string`\n  - `status: 'queued' | 'running' | 'completed' | 'failed' | 'exited'`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.journeys.trigger('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { profile: {} });\n\nconsole.log(response);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.journeys.trigger',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.public.journeys.trigger('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {\n  profile: {},\n});\n\nconsole.log(response.runId);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/journeys/$ID/trigger \\\n    -H \'Content-Type: application/json\' \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY" \\\n    -d \'{\n          "profile": {}\n        }\'',
+            },
+        },
+    },
+    {
+        name: 'get_run_status',
+        endpoint: '/api/v1/public/journeys/runs/{runId}',
+        httpMethod: 'get',
+        summary: 'Get journey run status',
+        description: 'Fetch the status of a journey run previously created via POST /journeys/{id}/trigger.',
+        stainlessPath: '(resource) v1.public.journeys > (method) get_run_status',
+        qualified: 'client.v1.public.journeys.getRunStatus',
+        params: ['runId: string;'],
+        response: "{ completedAt: string; error: string; journeyId: string; profileId: string; runId: string; status: 'queued' | 'running' | 'completed' | 'failed' | 'exited'; triggeredAt: string; }",
+        markdown: "## get_run_status\n\n`client.v1.public.journeys.getRunStatus(runId: string): { completedAt: string; error: string; journeyId: string; profileId: string; runId: string; status: 'queued' | 'running' | 'completed' | 'failed' | 'exited'; triggeredAt: string; }`\n\n**get** `/api/v1/public/journeys/runs/{runId}`\n\nFetch the status of a journey run previously created via POST /journeys/{id}/trigger.\n\n### Parameters\n\n- `runId: string`\n\n### Returns\n\n- `{ completedAt: string; error: string; journeyId: string; profileId: string; runId: string; status: 'queued' | 'running' | 'completed' | 'failed' | 'exited'; triggeredAt: string; }`\n\n  - `completedAt: string`\n  - `error: string`\n  - `journeyId: string`\n  - `profileId: string`\n  - `runId: string`\n  - `status: 'queued' | 'running' | 'completed' | 'failed' | 'exited'`\n  - `triggeredAt: string`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.journeys.getRunStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.journeys.getRunStatus',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.public.journeys.getRunStatus(\n  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n);\n\nconsole.log(response.completedAt);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/journeys/runs/$RUN_ID \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY"',
+            },
+        },
+    },
+    {
+        name: 'create',
+        endpoint: '/api/v1/public/broadcasts',
+        httpMethod: 'post',
+        summary: 'Create and send a broadcast',
+        description: 'Create a broadcast and send immediately. v1 does not support scheduledAt; providing it returns 501. Supports Idempotency-Key header.',
+        stainlessPath: '(resource) v1.public.broadcasts > (method) create',
+        qualified: 'client.v1.public.broadcasts.create',
+        params: [
+            'name: string;',
+            'segmentId: string;',
+            'templateId: string;',
+            'scheduledAt?: string;',
+            'subject?: string;',
+        ],
+        response: "{ broadcastId: string; status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'; }",
+        markdown: "## create\n\n`client.v1.public.broadcasts.create(name: string, segmentId: string, templateId: string, scheduledAt?: string, subject?: string): { broadcastId: string; status: broadcast_status; }`\n\n**post** `/api/v1/public/broadcasts`\n\nCreate a broadcast and send immediately. v1 does not support scheduledAt; providing it returns 501. Supports Idempotency-Key header.\n\n### Parameters\n\n- `name: string`\n\n- `segmentId: string`\n\n- `templateId: string`\n\n- `scheduledAt?: string`\n\n- `subject?: string`\n\n### Returns\n\n- `{ broadcastId: string; status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'; }`\n\n  - `broadcastId: string`\n  - `status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst broadcast = await client.v1.public.broadcasts.create({\n  name: 'x',\n  segmentId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n  templateId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n});\n\nconsole.log(broadcast);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.broadcasts.create',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst broadcast = await client.v1.public.broadcasts.create({\n  name: 'x',\n  segmentId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n  templateId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n});\n\nconsole.log(broadcast.broadcastId);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/broadcasts \\\n    -H \'Content-Type: application/json\' \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY" \\\n    -d \'{\n          "name": "x",\n          "segmentId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n          "templateId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n        }\'',
+            },
+        },
+    },
+    {
+        name: 'cancel',
+        endpoint: '/api/v1/public/broadcasts/{id}/cancel',
+        httpMethod: 'post',
+        summary: 'Cancel an in-flight broadcast',
+        description: 'Cancel all in-flight workflows for a broadcast and mark it Failed. Idempotent — noop (still 200) on broadcasts in terminal states.',
+        stainlessPath: '(resource) v1.public.broadcasts > (method) cancel',
+        qualified: 'client.v1.public.broadcasts.cancel',
+        params: ['id: string;'],
+        response: "{ broadcastId: string; status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'; }",
+        markdown: "## cancel\n\n`client.v1.public.broadcasts.cancel(id: string): { broadcastId: string; status: broadcast_status; }`\n\n**post** `/api/v1/public/broadcasts/{id}/cancel`\n\nCancel all in-flight workflows for a broadcast and mark it Failed. Idempotent — noop (still 200) on broadcasts in terminal states.\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ broadcastId: string; status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'; }`\n\n  - `broadcastId: string`\n  - `status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.broadcasts.cancel('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.broadcasts.cancel',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.public.broadcasts.cancel('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response.broadcastId);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/broadcasts/$ID/cancel \\\n    -X POST \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY"',
+            },
+        },
+    },
+    {
+        name: 'prepare',
+        endpoint: '/api/v1/public/broadcasts/prepare',
+        httpMethod: 'post',
+        summary: 'Prepare a broadcast (dry-run, returns preparedSendId)',
+        description: 'Validate a broadcast draft and return a preparedSendId + audience snapshot. Bytes go nowhere until you redeem the id with /broadcasts/send-prepared. preparedSendIds expire after 15 minutes and are bound to the (organization, user) pair that created them.',
+        stainlessPath: '(resource) v1.public.broadcasts > (method) prepare',
+        qualified: 'client.v1.public.broadcasts.prepare',
+        params: ['name: string;', 'segmentId: string;', 'templateId: string;', 'subject?: string;'],
+        response: '{ audienceCount: number; expiresAt: string; preparedSendId: string; senderProfile: { id: string; fromEmail: string; name: string; }; subjectPreview: string; }',
+        markdown: "## prepare\n\n`client.v1.public.broadcasts.prepare(name: string, segmentId: string, templateId: string, subject?: string): { audienceCount: number; expiresAt: string; preparedSendId: string; senderProfile: object; subjectPreview: string; }`\n\n**post** `/api/v1/public/broadcasts/prepare`\n\nValidate a broadcast draft and return a preparedSendId + audience snapshot. Bytes go nowhere until you redeem the id with /broadcasts/send-prepared. preparedSendIds expire after 15 minutes and are bound to the (organization, user) pair that created them.\n\n### Parameters\n\n- `name: string`\n\n- `segmentId: string`\n\n- `templateId: string`\n\n- `subject?: string`\n\n### Returns\n\n- `{ audienceCount: number; expiresAt: string; preparedSendId: string; senderProfile: { id: string; fromEmail: string; name: string; }; subjectPreview: string; }`\n\n  - `audienceCount: number`\n  - `expiresAt: string`\n  - `preparedSendId: string`\n  - `senderProfile: { id: string; fromEmail: string; name: string; }`\n  - `subjectPreview: string`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.broadcasts.prepare({\n  name: 'x',\n  segmentId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n  templateId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n});\n\nconsole.log(response);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.broadcasts.prepare',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.public.broadcasts.prepare({\n  name: 'x',\n  segmentId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n  templateId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n});\n\nconsole.log(response.audienceCount);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/broadcasts/prepare \\\n    -H \'Content-Type: application/json\' \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY" \\\n    -d \'{\n          "name": "x",\n          "segmentId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n          "templateId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n        }\'',
+            },
+        },
+    },
+    {
+        name: 'send_prepared',
+        endpoint: '/api/v1/public/broadcasts/send-prepared',
+        httpMethod: 'post',
+        summary: 'Redeem a preparedSendId and trigger the broadcast',
+        description: "Atomically consumes a preparedSendId and starts the broadcast. One-time use — repeated calls with the same id replay the original response (idempotent), they never start a second send. Caller (organization, user) must match the prepare call. Requires the API key's `allowSends` metadata flag.",
+        stainlessPath: '(resource) v1.public.broadcasts > (method) send_prepared',
+        qualified: 'client.v1.public.broadcasts.sendPrepared',
+        params: ['preparedSendId: string;'],
+        response: "{ broadcastId: string; firstRedeem: boolean; status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'; }",
+        markdown: "## send_prepared\n\n`client.v1.public.broadcasts.sendPrepared(preparedSendId: string): { broadcastId: string; firstRedeem: boolean; status: broadcast_status; }`\n\n**post** `/api/v1/public/broadcasts/send-prepared`\n\nAtomically consumes a preparedSendId and starts the broadcast. One-time use — repeated calls with the same id replay the original response (idempotent), they never start a second send. Caller (organization, user) must match the prepare call. Requires the API key's `allowSends` metadata flag.\n\n### Parameters\n\n- `preparedSendId: string`\n\n### Returns\n\n- `{ broadcastId: string; firstRedeem: boolean; status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'; }`\n\n  - `broadcastId: string`\n  - `firstRedeem: boolean`\n  - `status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.broadcasts.sendPrepared({ preparedSendId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(response);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.broadcasts.sendPrepared',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.public.broadcasts.sendPrepared({\n  preparedSendId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n});\n\nconsole.log(response.broadcastId);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/broadcasts/send-prepared \\\n    -H \'Content-Type: application/json\' \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY" \\\n    -d \'{\n          "preparedSendId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n        }\'',
+            },
+        },
+    },
+    {
+        name: 'get_status',
+        endpoint: '/api/v1/public/broadcasts/{id}',
+        httpMethod: 'get',
+        summary: 'Get broadcast status + stats',
+        description: 'Get broadcast status + stats',
+        stainlessPath: '(resource) v1.public.broadcasts > (method) get_status',
+        qualified: 'client.v1.public.broadcasts.getStatus',
+        params: ['id: string;'],
+        response: "{ id: string; completedAt: string; name: string; scheduledAt: string; startedAt: string; stats: { failed: number; queued: number; sent: number; }; status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'; }",
+        markdown: "## get_status\n\n`client.v1.public.broadcasts.getStatus(id: string): { id: string; completedAt: string; name: string; scheduledAt: string; startedAt: string; stats: object; status: broadcast_status; }`\n\n**get** `/api/v1/public/broadcasts/{id}`\n\nGet broadcast status + stats\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ id: string; completedAt: string; name: string; scheduledAt: string; startedAt: string; stats: { failed: number; queued: number; sent: number; }; status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'; }`\n\n  - `id: string`\n  - `completedAt: string`\n  - `name: string`\n  - `scheduledAt: string`\n  - `startedAt: string`\n  - `stats: { failed: number; queued: number; sent: number; }`\n  - `status: 'NotStarted' | 'InProgress' | 'Triggered' | 'Sent' | 'Failed' | 'Archived' | 'Warming' | 'Paused'`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.broadcasts.getStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.broadcasts.getStatus',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.public.broadcasts.getStatus(\n  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n);\n\nconsole.log(response.id);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/broadcasts/$ID \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY"',
+            },
+        },
+    },
+    {
+        name: 'list',
+        endpoint: '/api/v1/public/templates',
+        httpMethod: 'get',
+        summary: 'List email templates',
+        description: 'List email templates',
+        stainlessPath: '(resource) v1.public.templates > (method) list',
+        qualified: 'client.v1.public.templates.list',
+        params: [
+            'cursor?: string;',
+            'limit?: number;',
+            'pageSize?: number;',
+            "purpose?: 'General' | 'Newsletter' | 'Promotional' | 'Transactional' | 'LeadMagnetDelivery';",
+            "status?: 'Active' | 'Archived';",
+        ],
+        response: "{ id: string; createdAt: string; isComplete: boolean; language: string; name: string; purpose: 'General' | 'Newsletter' | 'Promotional' | 'Transactional' | 'LeadMagnetDelivery'; status: 'Active' | 'Archived'; type: string; updatedAt: string; }[]",
+        markdown: "## list\n\n`client.v1.public.templates.list(cursor?: string, limit?: number, pageSize?: number, purpose?: 'General' | 'Newsletter' | 'Promotional' | 'Transactional' | 'LeadMagnetDelivery', status?: 'Active' | 'Archived'): { id: string; createdAt: string; isComplete: boolean; language: string; name: string; purpose: 'General' | 'Newsletter' | 'Promotional' | 'Transactional' | 'LeadMagnetDelivery'; status: template_status; type: string; updatedAt: string; }[]`\n\n**get** `/api/v1/public/templates`\n\nList email templates\n\n### Parameters\n\n- `cursor?: string`\n\n- `limit?: number`\n\n- `pageSize?: number`\n\n- `purpose?: 'General' | 'Newsletter' | 'Promotional' | 'Transactional' | 'LeadMagnetDelivery'`\n\n- `status?: 'Active' | 'Archived'`\n  Lifecycle status of a message template (Active or Archived)\n\n### Returns\n\n- `{ id: string; createdAt: string; isComplete: boolean; language: string; name: string; purpose: 'General' | 'Newsletter' | 'Promotional' | 'Transactional' | 'LeadMagnetDelivery'; status: 'Active' | 'Archived'; type: string; updatedAt: string; }[]`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst templates = await client.v1.public.templates.list();\n\nconsole.log(templates);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.templates.list',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst templates = await client.v1.public.templates.list();\n\nconsole.log(templates);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/templates \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY"',
+            },
+        },
+    },
+    {
+        name: 'get',
+        endpoint: '/api/v1/public/templates/{id}',
+        httpMethod: 'get',
+        summary: 'Get an email template by id',
+        description: 'Get an email template by id',
+        stainlessPath: '(resource) v1.public.templates > (method) get',
+        qualified: 'client.v1.public.templates.get',
+        params: ['id: string;'],
+        response: "{ id: string; createdAt: string; isComplete: boolean; language: string; name: string; purpose: 'General' | 'Newsletter' | 'Promotional' | 'Transactional' | 'LeadMagnetDelivery'; status: 'Active' | 'Archived'; type: string; updatedAt: string; }",
+        markdown: "## get\n\n`client.v1.public.templates.get(id: string): { id: string; createdAt: string; isComplete: boolean; language: string; name: string; purpose: 'General' | 'Newsletter' | 'Promotional' | 'Transactional' | 'LeadMagnetDelivery'; status: template_status; type: string; updatedAt: string; }`\n\n**get** `/api/v1/public/templates/{id}`\n\nGet an email template by id\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; isComplete: boolean; language: string; name: string; purpose: 'General' | 'Newsletter' | 'Promotional' | 'Transactional' | 'LeadMagnetDelivery'; status: 'Active' | 'Archived'; type: string; updatedAt: string; }`\n\n  - `id: string`\n  - `createdAt: string`\n  - `isComplete: boolean`\n  - `language: string`\n  - `name: string`\n  - `purpose: 'General' | 'Newsletter' | 'Promotional' | 'Transactional' | 'LeadMagnetDelivery'`\n  - `status: 'Active' | 'Archived'`\n  - `type: string`\n  - `updatedAt: string`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst template = await client.v1.public.templates.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(template);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.templates.get',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst template = await client.v1.public.templates.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(template.id);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/templates/$ID \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY"',
+            },
+        },
+    },
+    {
+        name: 'list',
+        endpoint: '/api/v1/public/segments',
+        httpMethod: 'get',
+        summary: 'List segments',
+        description: 'List segments',
+        stainlessPath: '(resource) v1.public.segments > (method) list',
+        qualified: 'client.v1.public.segments.list',
+        params: [
+            "membershipType?: 'computed' | 'static';",
+            "status?: 'NotStarted' | 'Running' | 'Paused' | 'Archived';",
+        ],
+        response: "{ id: string; createdAt: string; lastComputedAt: string; membershipType: 'computed' | 'static'; name: string; status: 'NotStarted' | 'Running' | 'Paused' | 'Archived'; updatedAt: string; userCount: number; }[]",
+        markdown: "## list\n\n`client.v1.public.segments.list(membershipType?: 'computed' | 'static', status?: 'NotStarted' | 'Running' | 'Paused' | 'Archived'): { id: string; createdAt: string; lastComputedAt: string; membershipType: 'computed' | 'static'; name: string; status: 'NotStarted' | 'Running' | 'Paused' | 'Archived'; updatedAt: string; userCount: number; }[]`\n\n**get** `/api/v1/public/segments`\n\nList segments\n\n### Parameters\n\n- `membershipType?: 'computed' | 'static'`\n  How segment membership is determined (computed or static)\n\n- `status?: 'NotStarted' | 'Running' | 'Paused' | 'Archived'`\n  Lifecycle status of a segment\n\n### Returns\n\n- `{ id: string; createdAt: string; lastComputedAt: string; membershipType: 'computed' | 'static'; name: string; status: 'NotStarted' | 'Running' | 'Paused' | 'Archived'; updatedAt: string; userCount: number; }[]`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst segments = await client.v1.public.segments.list();\n\nconsole.log(segments);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.segments.list',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst segments = await client.v1.public.segments.list();\n\nconsole.log(segments);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/segments \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY"',
+            },
+        },
+    },
+    {
+        name: 'preview',
+        endpoint: '/api/v1/public/segments/{id}/preview',
+        httpMethod: 'post',
+        summary: 'Preview segment audience count',
+        description: "Recompile the segment's live definition and count matching users from api.user_event. Bypasses the cached segment_membership table.",
+        stainlessPath: '(resource) v1.public.segments > (method) preview',
+        qualified: 'client.v1.public.segments.preview',
+        params: ['id: string;'],
+        response: '{ matchedUserCount: number; previewedAt: string; }',
+        markdown: "## preview\n\n`client.v1.public.segments.preview(id: string): { matchedUserCount: number; previewedAt: string; }`\n\n**post** `/api/v1/public/segments/{id}/preview`\n\nRecompile the segment's live definition and count matching users from api.user_event. Bypasses the cached segment_membership table.\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ matchedUserCount: number; previewedAt: string; }`\n\n  - `matchedUserCount: number`\n  - `previewedAt: string`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.segments.preview('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.segments.preview',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.public.segments.preview('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response.matchedUserCount);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/segments/$ID/preview \\\n    -X POST \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY"',
+            },
+        },
+    },
+    {
+        name: 'request_upload',
+        endpoint: '/api/v1/public/assets/upload-request',
+        httpMethod: 'post',
+        summary: 'Request a presigned asset upload',
+        description: 'Pre-mints an asset id and returns a presigned S3 PUT URL. Upload the bytes with the returned headers, then call /assets/{assetId}/finalize.',
+        stainlessPath: '(resource) v1.public.assets > (method) request_upload',
+        qualified: 'client.v1.public.assets.requestUpload',
+        params: [
+            'contentType: string;',
+            'filename: string;',
+            'size: number;',
+            "assetType?: 'content-image' | 'content-document' | 'lead-magnet';",
+        ],
+        response: '{ assetId: string; expiresAt: string; headers: object; uploadUrl: string; }',
+        markdown: "## request_upload\n\n`client.v1.public.assets.requestUpload(contentType: string, filename: string, size: number, assetType?: 'content-image' | 'content-document' | 'lead-magnet'): { assetId: string; expiresAt: string; headers: object; uploadUrl: string; }`\n\n**post** `/api/v1/public/assets/upload-request`\n\nPre-mints an asset id and returns a presigned S3 PUT URL. Upload the bytes with the returned headers, then call /assets/{assetId}/finalize.\n\n### Parameters\n\n- `contentType: string`\n\n- `filename: string`\n\n- `size: number`\n\n- `assetType?: 'content-image' | 'content-document' | 'lead-magnet'`\n\n### Returns\n\n- `{ assetId: string; expiresAt: string; headers: object; uploadUrl: string; }`\n\n  - `assetId: string`\n  - `expiresAt: string`\n  - `headers: object`\n  - `uploadUrl: string`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.assets.requestUpload({\n  contentType: 'x',\n  filename: 'x',\n  size: 9007199254740991,\n});\n\nconsole.log(response);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.assets.requestUpload',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.public.assets.requestUpload({\n  contentType: 'x',\n  filename: 'x',\n  size: 9007199254740991,\n});\n\nconsole.log(response.assetId);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/assets/upload-request \\\n    -H \'Content-Type: application/json\' \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY" \\\n    -d \'{\n          "contentType": "x",\n          "filename": "x",\n          "size": 9007199254740991\n        }\'',
+            },
+        },
+    },
+    {
+        name: 'finalize_upload',
+        endpoint: '/api/v1/public/assets/{id}/finalize',
+        httpMethod: 'post',
+        summary: 'Finalize a presigned upload',
+        description: 'Verifies the bytes landed in S3, strips EXIF/GPS metadata, extracts dimensions, and commits the asset row.',
+        stainlessPath: '(resource) v1.public.assets > (method) finalize_upload',
+        qualified: 'client.v1.public.assets.finalizeUpload',
+        params: [
+            'id: string;',
+            'altText?: string;',
+            'description?: string;',
+            "imageType?: 'logo' | 'hero' | 'header' | 'product' | 'background' | 'icon' | 'other';",
+        ],
+        response: '{ asset: { id: string; contentType: string; createdAt: string; filename: string; height: number; size: number; url: string; width: number; }; }',
+        markdown: "## finalize_upload\n\n`client.v1.public.assets.finalizeUpload(id: string, altText?: string, description?: string, imageType?: 'logo' | 'hero' | 'header' | 'product' | 'background' | 'icon' | 'other'): { asset: object; }`\n\n**post** `/api/v1/public/assets/{id}/finalize`\n\nVerifies the bytes landed in S3, strips EXIF/GPS metadata, extracts dimensions, and commits the asset row.\n\n### Parameters\n\n- `id: string`\n\n- `altText?: string`\n\n- `description?: string`\n\n- `imageType?: 'logo' | 'hero' | 'header' | 'product' | 'background' | 'icon' | 'other'`\n  Category of image for use in email templates\n\n### Returns\n\n- `{ asset: { id: string; contentType: string; createdAt: string; filename: string; height: number; size: number; url: string; width: number; }; }`\n\n  - `asset: { id: string; contentType: string; createdAt: string; filename: string; height: number; size: number; url: string; width: number; }`\n\n### Example\n\n```typescript\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.assets.finalizeUpload('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response);\n```",
+        perLanguage: {
+            typescript: {
+                method: 'client.v1.public.assets.finalizeUpload',
+                example: "import SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.public.assets.finalizeUpload(\n  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n);\n\nconsole.log(response.asset);",
+            },
+            http: {
+                example: 'curl https://api.segmentflow.ai/api/v1/public/assets/$ID/finalize \\\n    -X POST \\\n    -H "x-api-key: $SEGMENTFLOW_API_KEY"',
+            },
+        },
+    },
+];
+const EMBEDDED_READMES = [
+    {
+        language: 'typescript',
+        content: "# Segmentflow AI TypeScript API Library\n\n[![NPM version](https://img.shields.io/npm/v/@segmentflow/segmentflow-typescript.svg?label=npm%20(stable))](https://npmjs.org/package/@segmentflow/segmentflow-typescript) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@segmentflow/segmentflow-typescript)\n\nThis library provides convenient access to the Segmentflow AI REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [segmentflow.ai](https://segmentflow.ai/docs). The full API of this library can be found in [api.md](api.md).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Segmentflow AI MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40segmentflow%2Fsegmentflow-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBzZWdtZW50Zmxvdy9zZWdtZW50Zmxvdy1tY3AiXSwiZW52Ijp7IlNFR01FTlRGTE9XX0FQSV9LRVkiOiJNeSBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40segmentflow%2Fsegmentflow-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40segmentflow%2Fsegmentflow-mcp%22%5D%2C%22env%22%3A%7B%22SEGMENTFLOW_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install @segmentflow/segmentflow-typescript\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n<!-- prettier-ignore -->\n```js\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n  environment: 'development', // defaults to 'production'\n});\n\nconst response = await client.v1.public.journeys.trigger('REPLACE_ME', {\n  profile: { email: 'user@example.com' },\n});\n\nconsole.log(response.runId);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n<!-- prettier-ignore -->\n```ts\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  apiKey: process.env['SEGMENTFLOW_API_KEY'], // This is the default and can be omitted\n  environment: 'development', // defaults to 'production'\n});\n\nconst params: SegmentflowAI.V1.Public.JourneyTriggerParams = {\n  profile: { email: 'user@example.com' },\n};\nconst response: SegmentflowAI.V1.Public.JourneyTriggerResponse =\n  await client.v1.public.journeys.trigger('REPLACE_ME', params);\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n<!-- prettier-ignore -->\n```ts\nconst response = await client.v1.public.journeys\n  .trigger('REPLACE_ME', { profile: { email: 'user@example.com' } })\n  .catch(async (err) => {\n    if (err instanceof SegmentflowAI.APIError) {\n      console.log(err.status); // 400\n      console.log(err.name); // BadRequestError\n      console.log(err.headers); // {server: 'nginx', ...}\n    } else {\n      throw err;\n    }\n  });\n```\n\nError codes are as follows:\n\n| Status Code | Error Type                 |\n| ----------- | -------------------------- |\n| 400         | `BadRequestError`          |\n| 401         | `AuthenticationError`      |\n| 403         | `PermissionDeniedError`    |\n| 404         | `NotFoundError`            |\n| 422         | `UnprocessableEntityError` |\n| 429         | `RateLimitError`           |\n| >=500       | `InternalServerError`      |\n| N/A         | `APIConnectionError`       |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n<!-- prettier-ignore -->\n```js\n// Configure the default for all requests:\nconst client = new SegmentflowAI({\n  maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait client.v1.public.journeys.trigger('REPLACE_ME', { profile: { email: 'user@example.com' } }, {\n  maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default. You can configure this with a `timeout` option:\n\n<!-- prettier-ignore -->\n```ts\n// Configure the default for all requests:\nconst client = new SegmentflowAI({\n  timeout: 20 * 1000, // 20 seconds (default is 1 minute)\n});\n\n// Override per-request:\nawait client.v1.public.journeys.trigger('REPLACE_ME', { profile: { email: 'user@example.com' } }, {\n  timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n\n\n\n\n## Advanced Usage\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n<!-- prettier-ignore -->\n```ts\nconst client = new SegmentflowAI();\n\nconst response = await client.v1.public.journeys\n  .trigger('REPLACE_ME', { profile: { email: 'user@example.com' } })\n  .asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: response, response: raw } = await client.v1.public.journeys\n  .trigger('REPLACE_ME', { profile: { email: 'user@example.com' } })\n  .withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nconsole.log(response.runId);\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `SEGMENTFLOW_AI_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst client = new SegmentflowAI({\n  logger: logger.child({ name: 'SegmentflowAI' }),\n  logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait client.post('/some/path', {\n  body: { some_prop: 'foo' },\n  query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nclient.v1.public.journeys.trigger({\n  // ...\n  // @ts-expect-error baz is not yet public\n  baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\nimport fetch from 'my-fetch';\n\nconst client = new SegmentflowAI({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  fetchOptions: {\n    // `RequestInit` options\n  },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n<img src=\"https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg\" align=\"top\" width=\"18\" height=\"21\"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>\n\n```ts\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst client = new SegmentflowAI({\n  fetchOptions: {\n    dispatcher: proxyAgent,\n  },\n});\n```\n\n<img src=\"https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg\" align=\"top\" width=\"18\" height=\"21\"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>\n\n```ts\nimport SegmentflowAI from '@segmentflow/segmentflow-typescript';\n\nconst client = new SegmentflowAI({\n  fetchOptions: {\n    proxy: 'http://localhost:8888',\n  },\n});\n```\n\n<img src=\"https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg\" align=\"top\" width=\"18\" height=\"21\"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>\n\n```ts\nimport SegmentflowAI from 'npm:@segmentflow/segmentflow-typescript';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst client = new SegmentflowAI({\n  fetchOptions: {\n    client: httpClient,\n  },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/segmentflow/segmentflow-typescript/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n",
+    },
+];
+const INDEX_OPTIONS = {
+    fields: [
+        'name',
+        'endpoint',
+        'summary',
+        'description',
+        'qualified',
+        'stainlessPath',
+        'content',
+        'sectionContext',
+    ],
+    storeFields: ['kind', '_original'],
+    searchOptions: {
+        prefix: true,
+        fuzzy: 0.1,
+        boost: {
+            name: 5,
+            stainlessPath: 3,
+            endpoint: 3,
+            qualified: 3,
+            summary: 2,
+            content: 1,
+            description: 1,
+        },
+    },
+};
+/**
+ * Self-contained local search engine backed by MiniSearch.
+ * Method data is embedded at SDK build time; prose documents
+ * can be loaded from an optional docs directory at runtime.
+ */
+class LocalDocsSearch {
+    methodIndex;
+    proseIndex;
+    constructor() {
+        this.methodIndex = new minisearch_1.default(INDEX_OPTIONS);
+        this.proseIndex = new minisearch_1.default(INDEX_OPTIONS);
+    }
+    static async create(opts) {
+        const instance = new LocalDocsSearch();
+        instance.indexMethods(EMBEDDED_METHODS);
+        for (const readme of EMBEDDED_READMES) {
+            instance.indexProse(readme.content, `readme:${readme.language}`);
+        }
+        if (opts?.docsDir) {
+            await instance.loadDocsDirectory(opts.docsDir);
+        }
+        return instance;
+    }
+    search(props) {
+        const { query, language = 'typescript', detail = 'default', maxResults = 5, maxLength = 100_000 } = props;
+        const useMarkdown = detail === 'verbose' || detail === 'high';
+        // Search both indices and merge results by score.
+        // Filter prose hits so language-tagged content (READMEs and docs with
+        // frontmatter) only matches the requested language.
+        const methodHits = this.methodIndex
+            .search(query)
+            .map((hit) => ({ ...hit, _kind: 'http_method' }));
+        const proseHits = this.proseIndex
+            .search(query)
+            .filter((hit) => {
+            const source = hit['_original']?.source;
+            if (!source)
+                return true;
+            // Check for language-tagged sources: "readme:<lang>" or "lang:<lang>:<filename>"
+            let taggedLang;
+            if (source.startsWith('readme:'))
+                taggedLang = source.slice('readme:'.length);
+            else if (source.startsWith('lang:'))
+                taggedLang = source.split(':')[1];
+            if (!taggedLang)
+                return true;
+            return taggedLang === language || (language === 'javascript' && taggedLang === 'typescript');
+        })
+            .map((hit) => ({ ...hit, _kind: 'prose' }));
+        const merged = [...methodHits, ...proseHits].sort((a, b) => b.score - a.score);
+        const top = merged.slice(0, maxResults);
+        const fullResults = [];
+        for (const hit of top) {
+            const original = hit['_original'];
+            if (hit._kind === 'http_method') {
+                const m = original;
+                if (useMarkdown && m.markdown) {
+                    fullResults.push(m.markdown);
+                }
+                else {
+                    // Use per-language data when available, falling back to the
+                    // top-level fields (which are TypeScript-specific in the
+                    // legacy codepath).
+                    const langData = m.perLanguage?.[language];
+                    fullResults.push({
+                        method: langData?.method ?? m.qualified,
+                        summary: m.summary,
+                        description: m.description,
+                        endpoint: `${m.httpMethod.toUpperCase()} ${m.endpoint}`,
+                        ...(langData?.example ? { example: langData.example } : {}),
+                        ...(m.params ? { params: m.params } : {}),
+                        ...(m.response ? { response: m.response } : {}),
+                    });
+                }
+            }
+            else {
+                const c = original;
+                fullResults.push({
+                    content: c.content,
+                    ...(c.source ? { source: c.source } : {}),
+                });
+            }
+        }
+        let totalLength = 0;
+        const results = [];
+        for (const result of fullResults) {
+            const len = typeof result === 'string' ? result.length : JSON.stringify(result).length;
+            totalLength += len;
+            if (totalLength > maxLength)
+                break;
+            results.push(result);
+        }
+        if (results.length < fullResults.length) {
+            results.unshift(`Truncated; showing ${results.length} of ${fullResults.length} results.`);
+        }
+        return { results };
+    }
+    indexMethods(methods) {
+        const docs = methods.map((m, i) => ({
+            id: `method-${i}`,
+            kind: 'http_method',
+            name: m.name,
+            endpoint: m.endpoint,
+            summary: m.summary,
+            description: m.description,
+            qualified: m.qualified,
+            stainlessPath: m.stainlessPath,
+            _original: m,
+        }));
+        if (docs.length > 0) {
+            this.methodIndex.addAll(docs);
+        }
+    }
+    async loadDocsDirectory(docsDir) {
+        let entries;
+        try {
+            entries = await fs.readdir(docsDir, { withFileTypes: true });
+        }
+        catch (err) {
+            (0, logger_1.getLogger)().warn({ err, docsDir }, 'Could not read docs directory');
+            return;
+        }
+        const files = entries
+            .filter((e) => e.isFile())
+            .filter((e) => e.name.endsWith('.md') || e.name.endsWith('.markdown') || e.name.endsWith('.json'));
+        for (const file of files) {
+            try {
+                const filePath = path.join(docsDir, file.name);
+                const content = await fs.readFile(filePath, 'utf-8');
+                if (file.name.endsWith('.json')) {
+                    const texts = extractTexts(JSON.parse(content));
+                    if (texts.length > 0) {
+                        this.indexProse(texts.join('\n\n'), file.name);
+                    }
+                }
+                else {
+                    // Parse optional YAML frontmatter for language tagging.
+                    // Files with a "language" field in frontmatter will only
+                    // surface in searches for that language.
+                    //
+                    // Example:
+                    //   ---
+                    //   language: python
+                    //   ---
+                    //   # Error handling in Python
+                    //   ...
+                    const frontmatter = parseFrontmatter(content);
+                    const source = frontmatter.language ? `lang:${frontmatter.language}:${file.name}` : file.name;
+                    this.indexProse(content, source);
+                }
+            }
+            catch (err) {
+                (0, logger_1.getLogger)().warn({ err, file: file.name }, 'Failed to index docs file');
+            }
+        }
+    }
+    indexProse(markdown, source) {
+        const chunks = chunkMarkdown(markdown);
+        const baseId = this.proseIndex.documentCount;
+        const docs = chunks.map((chunk, i) => ({
+            id: `prose-${baseId + i}`,
+            kind: 'prose',
+            content: chunk.content,
+            ...(chunk.sectionContext != null ? { sectionContext: chunk.sectionContext } : {}),
+            _original: { ...chunk, source },
+        }));
+        if (docs.length > 0) {
+            this.proseIndex.addAll(docs);
+        }
+    }
+}
+exports.LocalDocsSearch = LocalDocsSearch;
+/** Lightweight markdown chunker — splits on headers, chunks by word count. */
+function chunkMarkdown(markdown) {
+    // Strip YAML frontmatter
+    const stripped = markdown.replace(/^---\n[\s\S]*?\n---\n?/, '');
+    const lines = stripped.split('\n');
+    const chunks = [];
+    const headers = [];
+    let current = [];
+    const flush = () => {
+        const text = current.join('\n').trim();
+        if (!text)
+            return;
+        const sectionContext = headers.length > 0 ? headers.join(' > ') : undefined;
+        // Split into ~200-word chunks
+        const words = text.split(/\s+/);
+        for (let i = 0; i < words.length; i += 200) {
+            const slice = words.slice(i, i + 200).join(' ');
+            if (slice) {
+                chunks.push({ content: slice, tag: 'p', ...(sectionContext != null ? { sectionContext } : {}) });
+            }
+        }
+        current = [];
+    };
+    for (const line of lines) {
+        const headerMatch = line.match(/^(#{1,6})\s+(.+)/);
+        if (headerMatch) {
+            flush();
+            const level = headerMatch[1].length;
+            const text = headerMatch[2].trim();
+            while (headers.length >= level)
+                headers.pop();
+            headers.push(text);
+        }
+        else {
+            current.push(line);
+        }
+    }
+    flush();
+    return chunks;
+}
+/** Recursively extracts string values from a JSON structure. */
+function extractTexts(data, depth = 0) {
+    if (depth > 10)
+        return [];
+    if (typeof data === 'string')
+        return data.trim() ? [data] : [];
+    if (Array.isArray(data))
+        return data.flatMap((item) => extractTexts(item, depth + 1));
+    if (typeof data === 'object' && data !== null) {
+        return Object.values(data).flatMap((v) => extractTexts(v, depth + 1));
+    }
+    return [];
+}
+/** Parses YAML frontmatter from a markdown string, extracting the language field if present. */
+function parseFrontmatter(markdown) {
+    const match = markdown.match(/^---\n([\s\S]*?)\n---/);
+    if (!match)
+        return {};
+    const body = match[1] ?? '';
+    const langMatch = body.match(/^language:\s*(.+)$/m);
+    return langMatch ? { language: langMatch[1].trim() } : {};
+}
+//# sourceMappingURL=local-docs-search.js.map