commune-ai 0.3.1 → 0.3.5

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { AttachmentRecord, AttachmentUrl, AttachmentUploadResponse, CreateDomainPayload, DomainEntry, InboxEntry, MessageListParams, SendMessagePayload, UnifiedMessage, SearchFilter, SearchOptions, SearchResult, IndexConversationPayload, ThreadListParams, ThreadListResponse, SearchThreadsParams, SearchThreadResult, ThreadMetadataEntry, DeliveryMetricsParams, DeliveryEventEntry, DeliveryEventsParams, DeliverySuppressionsParams, SuppressionEntry } from './types.js';
+import type { AttachmentRecord, AttachmentUrl, AttachmentUploadResponse, CreateDomainPayload, DomainEntry, InboxEntry, MessageListParams, SendMessagePayload, UnifiedMessage, SearchFilter, SearchOptions, SearchResult, IndexConversationPayload, ThreadListParams, ThreadListResponse, SearchThreadsParams, SearchThreadResult, ThreadMetadataEntry, DeliveryMetricsParams, DeliveryEventEntry, DeliveryEventsParams, DeliverySuppressionsParams, SuppressionEntry, PhoneNumber, UpdatePhoneNumberPayload, PhoneNumberWebhookPayload, AvailablePhoneNumber, ProvisionPhoneNumberPayload, SmsConversation, SmsConversationListParams, SmsMessage, SmsListParams, SmsSuppression, SendSmsPayload, SendSmsResult, SmsSearchParams, CreditBalance, CreditBundle, CreditCheckoutResult } from './types.js';
 export type ClientOptions = {
     baseUrl?: string;
     apiKey: string;
@@ -130,4 +130,41 @@ export declare class CommuneClient {
             expiresIn?: number;
         }) => Promise<AttachmentRecord | AttachmentUrl>;
     };
+    phoneNumbers: {
+        list: () => Promise<PhoneNumber[]>;
+        get: (phoneNumberId: string) => Promise<PhoneNumber>;
+        update: (phoneNumberId: string, payload: UpdatePhoneNumberPayload) => Promise<PhoneNumber>;
+        available: (params?: {
+            type?: "TollFree" | "Local";
+            country?: string;
+            area_code?: string;
+            limit?: number;
+        }) => Promise<AvailablePhoneNumber[]>;
+        provision: (payload?: ProvisionPhoneNumberPayload) => Promise<PhoneNumber>;
+        release: (phoneNumberId: string) => Promise<{
+            id: string;
+            status: string;
+            message: string;
+        }>;
+        setAllowList: (phoneNumberId: string, numbers: string[]) => Promise<PhoneNumber>;
+        setBlockList: (phoneNumberId: string, numbers: string[]) => Promise<PhoneNumber>;
+        setWebhook: (phoneNumberId: string, payload: PhoneNumberWebhookPayload) => Promise<PhoneNumber>;
+    };
+    sms: {
+        list: (params?: SmsListParams) => Promise<SmsMessage[]>;
+        send: (payload: SendSmsPayload) => Promise<SendSmsResult>;
+        conversations: (params?: SmsConversationListParams) => Promise<SmsConversation[]>;
+        thread: (remoteNumber: string, phoneNumberId?: string) => Promise<SmsMessage[]>;
+        search: (params: SmsSearchParams) => Promise<SmsMessage[]>;
+        suppressions: (phoneNumberId?: string) => Promise<SmsSuppression[]>;
+        removeSuppression: (phoneNumber: string) => Promise<{
+            removed: boolean;
+            phone_number: string;
+        }>;
+    };
+    credits: {
+        balance: () => Promise<CreditBalance>;
+        bundles: () => Promise<CreditBundle[]>;
+        checkout: (bundle: "starter" | "growth" | "scale", returnUrl?: string) => Promise<CreditCheckoutResult>;
+    };
 }

package/dist/client.js

@@ -273,6 +273,101 @@ export class CommuneClient {
                 return this.request(`/v1/attachments/${encodeURIComponent(attachmentId)}`);
             },
         };
+        this.phoneNumbers = {
+            list: async () => {
+                return this.request('/v1/phone-numbers');
+            },
+            get: async (phoneNumberId) => {
+                return this.request(`/v1/phone-numbers/${encodeURIComponent(phoneNumberId)}`);
+            },
+            update: async (phoneNumberId, payload) => {
+                return this.request(`/v1/phone-numbers/${encodeURIComponent(phoneNumberId)}`, { method: 'PATCH', json: payload });
+            },
+            available: async (params) => {
+                return this.request(`/v1/phone-numbers/available${buildQuery({
+                    type: params?.type,
+                    country: params?.country,
+                    area_code: params?.area_code,
+                    limit: params?.limit,
+                })}`);
+            },
+            provision: async (payload) => {
+                return this.request('/v1/phone-numbers', {
+                    method: 'POST',
+                    json: (payload ?? {}),
+                });
+            },
+            release: async (phoneNumberId) => {
+                return this.request(`/v1/phone-numbers/${encodeURIComponent(phoneNumberId)}`, { method: 'DELETE' });
+            },
+            setAllowList: async (phoneNumberId, numbers) => {
+                return this.request(`/v1/phone-numbers/${encodeURIComponent(phoneNumberId)}/allow-list`, { method: 'PUT', json: { numbers } });
+            },
+            setBlockList: async (phoneNumberId, numbers) => {
+                return this.request(`/v1/phone-numbers/${encodeURIComponent(phoneNumberId)}/block-list`, { method: 'PUT', json: { numbers } });
+            },
+            setWebhook: async (phoneNumberId, payload) => {
+                return this.request(`/v1/phone-numbers/${encodeURIComponent(phoneNumberId)}`, { method: 'PATCH', json: { webhook: payload } });
+            },
+        };
+        this.sms = {
+            list: async (params = {}) => {
+                return this.request(`/v1/sms${buildQuery({
+                    phone_number_id: params.phone_number_id,
+                    limit: params.limit,
+                    before: params.before,
+                    after: params.after,
+                })}`);
+            },
+            send: async (payload) => {
+                return this.request('/v1/sms/send', {
+                    method: 'POST',
+                    json: payload,
+                });
+            },
+            conversations: async (params = {}) => {
+                return this.request(`/v1/sms/conversations${buildQuery({
+                    phone_number_id: params.phone_number_id,
+                    limit: params.limit,
+                    cursor: params.cursor,
+                })}`);
+            },
+            thread: async (remoteNumber, phoneNumberId) => {
+                return this.request(`/v1/sms/conversations/${encodeURIComponent(remoteNumber)}${buildQuery({
+                    phone_number_id: phoneNumberId,
+                })}`);
+            },
+            search: async (params) => {
+                return this.request(`/v1/sms/search${buildQuery({
+                    q: params.q,
+                    phone_number_id: params.phone_number_id,
+                    limit: params.limit,
+                })}`);
+            },
+            suppressions: async (phoneNumberId) => {
+                return this.request(`/v1/sms/suppressions${buildQuery({ phone_number_id: phoneNumberId })}`);
+            },
+            removeSuppression: async (phoneNumber) => {
+                return this.request(`/v1/sms/suppressions/${encodeURIComponent(phoneNumber)}`, { method: 'DELETE' });
+            },
+        };
+        this.credits = {
+            balance: async () => {
+                return this.request('/v1/credits');
+            },
+            bundles: async () => {
+                return this.request('/v1/credits/bundles');
+            },
+            checkout: async (bundle, returnUrl) => {
+                return this.request('/v1/credits/checkout', {
+                    method: 'POST',
+                    json: {
+                        bundle,
+                        ...(returnUrl ? { success_url: returnUrl, cancel_url: returnUrl } : {}),
+                    },
+                });
+            },
+        };
         this.baseUrl = (options.baseUrl || DEFAULT_BASE_URL).replace(/\/$/, '');
         this.apiKey = options.apiKey;
         this.headers = options.headers;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { CommuneClient } from './client.js';
-export type { ApiError, ApiResponse, AttachmentRecord, Channel, ConversationListParams, CreateDomainPayload, CreateInboxPayload, Direction, DomainEntry, DomainWebhook, InboxEntry, InboxWebhook, InboundEmailWebhookPayload, MessageListParams, MessageMetadata, Participant, ParticipantRole, SendMessagePayload, SearchThreadResult, SearchThreadsParams, ThreadMetadataEntry, SvixHeaders, SuppressionEntry, Thread, DeliveryEventEntry, DeliveryEventsParams, DeliveryMetricsParams, DeliverySuppressionsParams, ThreadListParams, ThreadListResponse, UnifiedMessage, } from './types.js';
+export type { ApiError, ApiResponse, AttachmentRecord, Channel, ConversationListParams, CreateDomainPayload, CreateInboxPayload, Direction, DomainEntry, DomainWebhook, InboxEntry, InboxWebhook, InboundEmailWebhookPayload, MessageListParams, MessageMetadata, Participant, ParticipantRole, SendMessagePayload, SearchThreadResult, SearchThreadsParams, ThreadMetadataEntry, SvixHeaders, SuppressionEntry, Thread, DeliveryEventEntry, DeliveryEventsParams, DeliveryMetricsParams, DeliverySuppressionsParams, ThreadListParams, ThreadListResponse, UnifiedMessage, PhoneNumber, UpdatePhoneNumberPayload, PhoneNumberWebhookPayload, AvailablePhoneNumber, ProvisionPhoneNumberPayload, SmsConversation, SmsConversationListParams, SmsMessage, SmsListParams, SmsSuppression, SendSmsPayload, SendSmsResult, SmsSearchParams, CreditBalance, CreditBundle, CreditCheckoutResult, } from './types.js';
 export { verifyResendWebhook, verifyCommuneWebhook, computeCommuneSignature } from './webhooks.js';
 export type { CommuneWebhookHeaders } from './webhooks.js';
 export { createWebhookHandler } from './listener.js';

package/dist/types.d.ts

@@ -367,3 +367,136 @@ export interface DeliverySuppressionsParams {
     domainId?: string;
     limit?: number;
 }
+export interface AvailablePhoneNumber {
+    phoneNumber: string;
+    friendlyName: string;
+    capabilities: {
+        sms: boolean;
+        mms: boolean;
+        voice: boolean;
+    };
+    region?: string;
+    locality?: string;
+    postalCode?: string;
+}
+export interface ProvisionPhoneNumberPayload {
+    phone_number?: string;
+    type?: 'tollfree' | 'local';
+    country?: string;
+    friendly_name?: string;
+    area_code?: string;
+}
+export interface PhoneNumber {
+    id: string;
+    number: string;
+    numberType: 'tollfree' | 'local' | 'shortcode';
+    friendlyName: string | null;
+    country: string;
+    capabilities: {
+        sms: boolean;
+        mms: boolean;
+        voice: boolean;
+    };
+    status: 'active' | 'released' | 'suspended_non_payment';
+    allowList: string[];
+    blockList: string[];
+    creditCostPerMonth: number;
+    autoReply: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface PhoneNumberWebhookPayload {
+    endpoint?: string;
+    secret?: string;
+    events?: string[];
+}
+export interface UpdatePhoneNumberPayload {
+    friendlyName?: string;
+    autoReply?: string | null;
+    allowList?: string[];
+    blockList?: string[];
+    webhook?: PhoneNumberWebhookPayload;
+}
+export interface SmsConversation {
+    thread_id: string;
+    remote_number: string;
+    phone_number_id: string;
+    last_message_at: string;
+    last_message_preview: string | null;
+    message_count: number;
+    unread_count: number;
+}
+export interface SmsMessage {
+    message_id: string;
+    thread_id: string;
+    direction: 'inbound' | 'outbound';
+    content: string | null;
+    created_at: string;
+    metadata: {
+        delivery_status: string | null;
+        from_number: string | null;
+        to_number: string | null;
+        phone_number_id: string | null;
+        message_sid: string | null;
+        credits_charged: number | null;
+        sms_segments: number | null;
+        has_attachments: boolean;
+        mms_media: unknown[] | null;
+    };
+}
+export interface SendSmsPayload {
+    to: string;
+    body: string;
+    phone_number_id?: string;
+    media_url?: string[];
+}
+export interface SendSmsResult {
+    message_id: string;
+    thread_id: string;
+    message_sid: string;
+    status: string;
+    credits_charged: number;
+    segments: number;
+}
+export interface SmsConversationListParams {
+    phone_number_id?: string;
+    limit?: number;
+    cursor?: string;
+}
+export interface SmsSearchParams {
+    q: string;
+    phone_number_id?: string;
+    limit?: number;
+}
+export interface SmsListParams {
+    phone_number_id?: string;
+    limit?: number;
+    before?: string;
+    after?: string;
+}
+export interface SmsSuppression {
+    phone_number: string;
+    orgId: string;
+    phone_number_id?: string;
+    reason?: string;
+    created_at?: string;
+}
+export interface CreditBalance {
+    included: number;
+    purchased: number;
+    total: number;
+    usedThisCycle: number;
+}
+export interface CreditBundle {
+    id: string;
+    credits: number;
+    price: number;
+    price_per_credit: string;
+    available?: boolean;
+}
+export interface CreditCheckoutResult {
+    checkout_url: string;
+    bundle: string;
+    credits: number;
+    price: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commune-ai",
-  "version": "0.3.1",
+  "version": "0.3.5",
   "description": "Email infrastructure for agents — set up an inbox and send your first email in 30 seconds. Programmatic inboxes (~1 line), consistent threads, custom domains, attachments, and structured data.",
   "type": "module",
   "main": "dist/index.js",