@myapihq/sdk 2.4.0 → 2.4.2

package/src/webhook.ts

@@ -1,88 +0,0 @@
-import { request } from './client';
-import { WEBHOOK_BASE as BASE_URL } from './config';
-import type { Exposes } from './exposes';
-
-export const EXPOSES: Exposes = [
-  'POST /webhook/orgs/{org_id}/endpoints',
-  'GET /webhook/orgs/{org_id}/endpoints',
-  'PATCH /webhook/orgs/{org_id}/endpoints/{endpoint_id}',
-  'DELETE /webhook/orgs/{org_id}/endpoints/{endpoint_id}',
-  'GET /webhook/orgs/{org_id}/deliveries/{delivery_id}',
-];
-
-export interface WebhookEndpoint {
-  id: string;
-  org_id: string;
-  name: string;
-  description?: string;
-  slug: string;
-  url: string;
-  // Dot-path into the webhook body whose value (an email) gets ingested
-  // into CRM as a contact + webhook_received event on each delivery.
-  // Default 'email' (top-level). Empty string disables CRM ingest.
-  crm_email_path?: string;
-  // URL every inbound delivery is forwarded to (POST, async, best-effort).
-  // Empty/absent when forwarding is disabled. Backend webhook/endpoints.go.
-  forward_url?: string;
-  created_at: string;
-}
-
-export interface Delivery {
-  id: string;
-  endpoint_id: string;
-  payload: unknown;
-  received_at: string;
-  // Forwarding outcome for this delivery, present only when the endpoint has
-  // a forward_url configured (backend webhook/endpoints.go). forward_status
-  // is the HTTP status of the forward POST; last_forward_error carries the
-  // failure message when the forward attempt errored.
-  forward_status?: number;
-  last_forward_at?: string;
-  last_forward_error?: string;
-}
-
-export interface CreateEndpointOptions {
-  description?: string;
-  // CRM auto-ingest config. Empty string disables; undefined defaults to
-  // 'email' (top-level). For nested shapes pass the dot-path (e.g.
-  // 'data.object.customer_email' for Stripe, 'sender.email' for GitHub).
-  crm_email_path?: string;
-  // Backend (2026-05-15): optional URL to forward every inbound delivery to
-  // (POST, async, best-effort). Headers `X-MyAPI-Webhook-Endpoint-Id` and
-  // `X-MyAPI-Webhook-Delivery-Id` are attached. Use http:// or https://.
-  // Empty string disables forwarding.
-  forward_url?: string;
-}
-
-// All fields optional — only those passed are mutated. Mirrors the backend
-// PATCH /webhook/orgs/{org_id}/endpoints/{id} contract (slug is immutable).
-export interface UpdateEndpointPayload {
-  name?: string;
-  description?: string;
-  crm_email_path?: string;
-  forward_url?: string;
-}
-
-export async function createEndpoint(apiKey: string, orgId: string, name: string, opts: CreateEndpointOptions = {}): Promise<WebhookEndpoint> {
-  const body: Record<string, unknown> = { name };
-  if (opts.description !== undefined) body.description = opts.description;
-  if (opts.crm_email_path !== undefined) body.crm_email_path = opts.crm_email_path;
-  if (opts.forward_url !== undefined) body.forward_url = opts.forward_url;
-  return request('POST', `${BASE_URL}/webhook/orgs/${encodeURIComponent(orgId)}/endpoints`, apiKey, body);
-}
-
-export async function updateEndpoint(apiKey: string, orgId: string, endpointId: string, payload: UpdateEndpointPayload): Promise<WebhookEndpoint> {
-  return request('PATCH', `${BASE_URL}/webhook/orgs/${encodeURIComponent(orgId)}/endpoints/${encodeURIComponent(endpointId)}`, apiKey, payload);
-}
-
-export async function listEndpoints(apiKey: string, orgId: string): Promise<WebhookEndpoint[]> {
-  return request('GET', `${BASE_URL}/webhook/orgs/${encodeURIComponent(orgId)}/endpoints`, apiKey);
-}
-
-export async function deleteEndpoint(apiKey: string, orgId: string, endpointId: string): Promise<void> {
-  return request('DELETE', `${BASE_URL}/webhook/orgs/${encodeURIComponent(orgId)}/endpoints/${encodeURIComponent(endpointId)}`, apiKey);
-}
-
-export async function getDelivery(apiKey: string, orgId: string, deliveryId: string): Promise<Delivery> {
-  return request('GET', `${BASE_URL}/webhook/orgs/${encodeURIComponent(orgId)}/deliveries/${encodeURIComponent(deliveryId)}`, apiKey);
-}

package/src/workflow.ts

@@ -1,162 +0,0 @@
-import { request, requestPage } from './client';
-import { WORKFLOW_BASE as BASE_URL } from './config';
-import type { Exposes } from './exposes';
-
-export const EXPOSES: Exposes = [
-  'POST /workflow/orgs/{org_id}/workflows',
-  'GET /workflow/orgs/{org_id}/workflows',
-  'GET /workflow/orgs/{org_id}/workflows/{workflow_id}',
-  'PATCH /workflow/orgs/{org_id}/workflows/{workflow_id}',
-  'DELETE /workflow/orgs/{org_id}/workflows/{workflow_id}',
-  'POST /workflow/orgs/{org_id}/workflows/{workflow_id}/enable',
-  'POST /workflow/orgs/{org_id}/workflows/{workflow_id}/disable',
-  'GET /workflow/orgs/{org_id}/workflows/{workflow_id}/runs',
-  'GET /workflow/orgs/{org_id}/runs/{run_id}',
-];
-
-
-
-/**
- * A single step in a workflow.
- *
- * `to`, `subject`, `text`, and `html` (or the resolved `template_id` body) all support
- * `{{payload.field}}` and `{{payload.nested.field}}` interpolation, evaluated at run time
- * against the inbound webhook body.
- *
- * For `send_email`, `from` must be an activated mailbox on a domain assigned to the account.
- * Each `send_email` execution is billed 1¢ and tracking pixels + click redirectors are
- * automatically injected into the HTML body.
- */
-export type WorkflowStep =
-  | { type: 'send_email'; from: string; to: string; subject: string; template_id?: string; text?: string; html?: string }
-  | { type: 'slack_message'; webhook_url: string; text: string }
-  // Backend (2026-05-15): `http_request` step is now accepted (alias: `http`).
-  // POSTs (or other method) to `url` with the inbound payload; supports
-  // template substitution in url/body the same way email steps do.
-  | { type: 'http_request' | 'http'; url: string; method?: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE'; body?: string; headers?: Record<string, string> }
-  // `enqueue_job` (alias: `enqueue`) hands durable work to my-queue-api —
-  // the step enqueues a job on `queue` carrying `payload` (template
-  // substitution supported, same as email/http steps). The workflow stays
-  // the trigger layer; the queue owns retry/durability. Backend: pending —
-  // see docs/cross-repo-prompts/backend-orchestration-composition.md.
-  | { type: 'enqueue_job' | 'enqueue'; queue: string; payload?: string; dedup_key?: string; delay_seconds?: number };
-
-export interface Workflow {
-  id: string;
-  org_id: string;
-  name: string;
-  trigger_type: string;
-  trigger_config: { endpoint_id: string };
-  steps: WorkflowStep[];
-  enabled: boolean;
-  created_at: string;
-  updated_at: string;
-}
-export interface WorkflowRun {
-  id: string;
-  workflow_id: string;
-  trigger_payload: unknown;
-  status: 'pending' | 'running' | 'completed' | 'failed';
-  error?: string;
-  attempt: number;
-  started_at?: string;
-  finished_at?: string;
-  created_at: string;
-  // Per-step output records, populated by GetRun only (backend crud.go:639
-  // returns step_outputs; ListRuns omits them). Empty array when none.
-  step_outputs?: unknown[];
-}
-
-export interface ListRunsOptions {
-  limit?: number;   // 1-500, default 100 server-side
-  cursor?: string;  // last run id from the prior page (keyset)
-}
-
-export interface WorkflowRunsPage {
-  runs: WorkflowRun[];
-  next_cursor?: string;
-  has_more?: boolean;
-}
-
-// Local URL-shape check on http_request steps. Same shape as the SSRF
-// audit's scheme allowlist on webhook.forward_url and queue.consumer_url —
-// this is *UX defense*, not security: the backend MUST also validate
-// (which it does, via the same middleware) — see
-// docs/cross-repo-prompts/backend-workflow-step-validation.md.
-// Catches javascript:, file:, gopher:, data:, and whitespace/null-byte
-// hosts at agent typo-fix latency instead of at "why didn't my workflow
-// fire" investigation latency.
-function validateSteps(steps: WorkflowStep[]): void {
-  for (let i = 0; i < steps.length; i++) {
-    const s = steps[i];
-    if (s.type === 'http_request' || s.type === 'http') {
-      let parsed: URL;
-      try { parsed = new URL(s.url); }
-      catch {
-        throw new Error(`step ${i} (${s.type}): "url" is not a valid URL — got ${JSON.stringify(s.url)}.`);
-      }
-      if (parsed.protocol !== 'http:' && parsed.protocol !== 'https:') {
-        throw new Error(`step ${i} (${s.type}): "url" must use http:// or https:// scheme — got "${parsed.protocol}" in ${JSON.stringify(s.url)}.`);
-      }
-    }
-  }
-}
-
-export async function createWorkflow(apiKey: string, orgId: string, payload: {
-  name: string;
-  trigger_config: { endpoint_id: string };
-  steps: WorkflowStep[];
-}): Promise<Workflow> {
-  validateSteps(payload.steps);
-  return request('POST', `${BASE_URL}/workflow/orgs/${encodeURIComponent(orgId)}/workflows`, apiKey, payload);
-}
-
-export async function listWorkflows(apiKey: string, orgId: string): Promise<Workflow[]> {
-  return request('GET', `${BASE_URL}/workflow/orgs/${encodeURIComponent(orgId)}/workflows`, apiKey);
-}
-
-export async function getWorkflow(apiKey: string, orgId: string, workflowId: string): Promise<Workflow> {
-  return request('GET', `${BASE_URL}/workflow/orgs/${encodeURIComponent(orgId)}/workflows/${encodeURIComponent(workflowId)}`, apiKey);
-}
-
-export async function updateWorkflow(apiKey: string, orgId: string, workflowId: string, payload: { name?: string; trigger_config?: { endpoint_id: string }; steps?: WorkflowStep[] }): Promise<Workflow> {
-  if (payload.steps) validateSteps(payload.steps);
-  return request('PATCH', `${BASE_URL}/workflow/orgs/${encodeURIComponent(orgId)}/workflows/${encodeURIComponent(workflowId)}`, apiKey, payload);
-}
-
-export async function enableWorkflow(apiKey: string, orgId: string, workflowId: string): Promise<void> {
-  return request('POST', `${BASE_URL}/workflow/orgs/${encodeURIComponent(orgId)}/workflows/${encodeURIComponent(workflowId)}/enable`, apiKey);
-}
-
-export async function disableWorkflow(apiKey: string, orgId: string, workflowId: string): Promise<void> {
-  return request('POST', `${BASE_URL}/workflow/orgs/${encodeURIComponent(orgId)}/workflows/${encodeURIComponent(workflowId)}/disable`, apiKey);
-}
-
-export async function deleteWorkflow(apiKey: string, orgId: string, workflowId: string): Promise<void> {
-  return request('DELETE', `${BASE_URL}/workflow/orgs/${encodeURIComponent(orgId)}/workflows/${encodeURIComponent(workflowId)}`, apiKey);
-}
-
-// listWorkflowRuns returns recent runs newest-first. The backend wraps this
-// in a keyset-pagination envelope (limit 1-500 + cursor), so we use
-// requestPage to preserve next_cursor — a plain `request` would drop it.
-export async function listWorkflowRuns(
-  apiKey: string,
-  orgId: string,
-  workflowId: string,
-  opts: ListRunsOptions = {},
-): Promise<WorkflowRunsPage> {
-  const qs = new URLSearchParams();
-  if (opts.limit !== undefined) qs.set('limit', String(opts.limit));
-  if (opts.cursor) qs.set('cursor', opts.cursor);
-  const query = qs.toString() ? `?${qs.toString()}` : '';
-  const page = await requestPage<WorkflowRun>(
-    'GET',
-    `${BASE_URL}/workflow/orgs/${encodeURIComponent(orgId)}/workflows/${encodeURIComponent(workflowId)}/runs${query}`,
-    apiKey,
-  );
-  return { runs: page.data, next_cursor: page.next_cursor, has_more: page.has_more };
-}
-
-export async function getWorkflowRun(apiKey: string, orgId: string, runId: string): Promise<WorkflowRun> {
-  return request('GET', `${BASE_URL}/workflow/orgs/${encodeURIComponent(orgId)}/runs/${encodeURIComponent(runId)}`, apiKey);
-}

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "declaration": true,
-    "outDir": "./dist",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": ["src/**/*"]
-}