monade-sdk 0.1.0

package/README.md

@@ -0,0 +1,98 @@
+# monade-sdk
+
+`monade-sdk` is the official TypeScript client for Monade voice operations APIs.
+
+It is designed for teams that need to move quickly without losing control: campaign automation, assistant management, transcript and analytics ingestion, webhook workflows, wallet checks, outbound calls, and trunk lifecycle operations through one consistent client.
+
+## Why this SDK
+
+- One client, multiple Monade services
+- Typed API surface for modern TypeScript projects
+- Standardized auth and timeout behavior
+- Consistent error mapping (`ApiError`, `AuthError`, `ValidationError`)
+- Fast adoption path for scripts, backend services, and internal tools
+
+## Installation
+
+```bash
+npm install monade-sdk
+```
+
+## Quick start
+
+```ts
+import { MonadeClient } from "monade-sdk";
+
+const client = new MonadeClient({
+  baseUrl: "https://your-monade-host",
+  apiKey: process.env.MONADE_API_KEY,
+  timeoutMs: 30000
+});
+
+const campaigns = await client.campaigns.list();
+console.log("campaigns:", campaigns);
+```
+
+## Service surface
+
+- `client.campaigns`
+: campaign CRUD, lifecycle actions, contacts, and campaign analytics
+- `client.assistants`
+: assistant create/read/update/delete and lookup helpers
+- `client.knowledgeBases`
+: knowledge base lifecycle operations
+- `client.analytics`
+: analytics submission, transcript retrieval, call metrics, campaign stats
+- `client.webhooks`
+: webhook endpoint management and event lookup
+- `client.trunks`
+: user trunk create/list/get/update/delete operations
+- `client.wallet`
+: user credit balance access
+- `client.outboundCalls`
+: direct outbound call initiation
+
+## Error handling
+
+```ts
+import { MonadeClient, ApiError, AuthError, ValidationError } from "monade-sdk";
+
+const client = new MonadeClient({ apiKey: process.env.MONADE_API_KEY });
+
+try {
+  await client.wallet.getBalance("user_123");
+} catch (err) {
+  if (err instanceof AuthError) {
+    console.error("Authentication failed:", err.status, err.message);
+  } else if (err instanceof ValidationError) {
+    console.error("Validation failed:", err.status, err.data);
+  } else if (err instanceof ApiError) {
+    console.error("API failed:", err.status, err.message);
+  } else {
+    console.error("Unexpected error:", err);
+  }
+}
+```
+
+## Runtime defaults
+
+- Default `baseUrl`: `http://35.200.254.189`
+- Default `timeoutMs`: `30000`
+- If `apiKey` is provided, the SDK sends:
+  - `Authorization: Bearer <apiKey>`
+  - `X-API-Key: <apiKey>`
+
+## Operation manifest
+
+The SDK exposes API operation metadata for introspection and tooling:
+
+```ts
+import { supportedOperations, supportedOperationIds, operationsByGroup } from "monade-sdk";
+```
+
+Current SDK surface includes 64 operations across campaigns, assistants, knowledge bases, analytics, trunks, webhooks, wallet, and outbound calls.
+
+## Notes
+
+- This package is CommonJS-compatible and works in Node.js 18+.
+- Generated API models are exported from the package root for direct use in typed code.

package/dist/generated/apis/CampaignServiceApiApi.d.ts

@@ -0,0 +1,302 @@
+/**
+ * Monade Voice API (Public)
+ * Conservative public surface for SDKs and docs.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AddContactsToCampaignRequest, CreateCampaignRequest, HandleCallTerminationRequest, UpdateCampaignRequest } from '../models/index';
+export interface AddContactsToCampaignOperationRequest {
+    campaignId: string;
+    addContactsToCampaignRequest: AddContactsToCampaignRequest;
+    userUid?: string;
+}
+export interface ClearCampaignContactsRequest {
+    campaignId: string;
+    userUid?: string;
+}
+export interface CreateCampaignOperationRequest {
+    createCampaignRequest: CreateCampaignRequest;
+}
+export interface DeleteCampaignRequest {
+    campaignId: string;
+    userUid?: string;
+}
+export interface GetAllCampaignsForUserRequest {
+    userUid: string;
+}
+export interface GetCampaignAnalyticsRequest {
+    campaignId: string;
+    userUid?: string;
+}
+export interface GetCampaignDetailsRequest {
+    campaignId: string;
+}
+export interface GetContactDetailsRequest {
+    campaignId: string;
+    contactId: string;
+    userUid?: string;
+}
+export interface HandleCallTerminationOperationRequest {
+    handleCallTerminationRequest: HandleCallTerminationRequest;
+}
+export interface ListCampaignContactsRequest {
+    campaignId: string;
+    userUid?: string;
+    skip?: string;
+    limit?: string;
+}
+export interface ListCampaignsRequest {
+    status?: string;
+}
+export interface PauseCampaignRequest {
+    campaignId: string;
+    userUid?: string;
+}
+export interface ResumeCampaignRequest {
+    campaignId: string;
+    userUid?: string;
+}
+export interface StartCampaignRequest {
+    campaignId: string;
+    userUid?: string;
+}
+export interface StopCampaignRequest {
+    campaignId: string;
+    userUid?: string;
+}
+export interface UpdateCampaignOperationRequest {
+    campaignId: string;
+    updateCampaignRequest: UpdateCampaignRequest;
+    userUid?: string;
+}
+export interface UploadContactsViaCsvRequest {
+    campaignId: string;
+    userUid?: string;
+}
+/**
+ *
+ */
+export declare class CampaignServiceApiApi extends runtime.BaseAPI {
+    /**
+     * Add Contacts to Campaign
+     */
+    addContactsToCampaignRaw(requestParameters: AddContactsToCampaignOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Add Contacts to Campaign
+     */
+    addContactsToCampaign(requestParameters: AddContactsToCampaignOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Clear Campaign Contacts
+     */
+    clearCampaignContactsRaw(requestParameters: ClearCampaignContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Clear Campaign Contacts
+     */
+    clearCampaignContacts(requestParameters: ClearCampaignContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Create Campaign
+     */
+    createCampaignRaw(requestParameters: CreateCampaignOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Create Campaign
+     */
+    createCampaign(requestParameters: CreateCampaignOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Delete Campaign
+     */
+    deleteCampaignRaw(requestParameters: DeleteCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Delete Campaign
+     */
+    deleteCampaign(requestParameters: DeleteCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get All Campaigns for User
+     */
+    getAllCampaignsForUserRaw(requestParameters: GetAllCampaignsForUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get All Campaigns for User
+     */
+    getAllCampaignsForUser(requestParameters: GetAllCampaignsForUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get Campaign Analytics
+     */
+    getCampaignAnalyticsRaw(requestParameters: GetCampaignAnalyticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get Campaign Analytics
+     */
+    getCampaignAnalytics(requestParameters: GetCampaignAnalyticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get Campaign Details
+     */
+    getCampaignDetailsRaw(requestParameters: GetCampaignDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get Campaign Details
+     */
+    getCampaignDetails(requestParameters: GetCampaignDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get Contact Details
+     */
+    getContactDetailsRaw(requestParameters: GetContactDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get Contact Details
+     */
+    getContactDetails(requestParameters: GetContactDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Handle Call Termination
+     */
+    handleCallTerminationRaw(requestParameters: HandleCallTerminationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Handle Call Termination
+     */
+    handleCallTermination(requestParameters: HandleCallTerminationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * List Campaign Contacts
+     */
+    listCampaignContactsRaw(requestParameters: ListCampaignContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * List Campaign Contacts
+     */
+    listCampaignContacts(requestParameters: ListCampaignContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * List Campaigns
+     */
+    listCampaignsRaw(requestParameters: ListCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * List Campaigns
+     */
+    listCampaigns(requestParameters?: ListCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Pause Campaign
+     */
+    pauseCampaignRaw(requestParameters: PauseCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Pause Campaign
+     */
+    pauseCampaign(requestParameters: PauseCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Resume Campaign
+     */
+    resumeCampaignRaw(requestParameters: ResumeCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Resume Campaign
+     */
+    resumeCampaign(requestParameters: ResumeCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Start Campaign
+     */
+    startCampaignRaw(requestParameters: StartCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Start Campaign
+     */
+    startCampaign(requestParameters: StartCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Stop Campaign
+     */
+    stopCampaignRaw(requestParameters: StopCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Stop Campaign
+     */
+    stopCampaign(requestParameters: StopCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Termination Health Check
+     */
+    terminationHealthCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Termination Health Check
+     */
+    terminationHealthCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Update Campaign
+     */
+    updateCampaignRaw(requestParameters: UpdateCampaignOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Update Campaign
+     */
+    updateCampaign(requestParameters: UpdateCampaignOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Upload Contacts via CSV
+     */
+    uploadContactsViaCsvRaw(requestParameters: UploadContactsViaCsvRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Upload Contacts via CSV
+     */
+    uploadContactsViaCsv(requestParameters: UploadContactsViaCsvRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+}