@myapihq/sdk 2.21.0 → 2.22.0

package/dist/email.d.ts

@@ -155,3 +155,77 @@ export declare function sendTestEmail(apiKey: string, orgId: string, templateId:
 }>;
 export declare function listTemplates(apiKey: string, orgId: string): Promise<EmailTemplate[]>;
 export declare function deleteTemplate(apiKey: string, orgId: string, templateId: string): Promise<void>;
+export type CampaignSourceKind = 'crm_query' | 'list';
+/** A CRM contact filter, mirroring `crm contacts search`. */
+export interface CampaignCRMQuery {
+    stage?: string;
+    origin?: string;
+    company_id?: string;
+    /** Engaged MORE than N days ago — includes contacts never engaged at all. */
+    max_last_engagement_days?: number;
+    /** Engaged within the last N days. */
+    min_last_engagement_days?: number;
+}
+export interface CampaignListSource {
+    addresses: string[];
+}
+export interface CreateCampaignInput {
+    name: string;
+    template_id: string;
+    from_address: string;
+    source_kind: CampaignSourceKind;
+    source_ref?: CampaignCRMQuery | CampaignListSource;
+}
+export interface Campaign {
+    id: string;
+    org_id: string;
+    name: string;
+    template_id: string;
+    from_address: string;
+    source_kind: CampaignSourceKind;
+    source_ref: unknown;
+    /** draft | ready | active | paused | paused_insufficient_funds | completed | cancelled */
+    status: string;
+    resolved_at: string | null;
+    recipient_count: number | null;
+    estimated_cost_cents: number | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface CampaignResolution {
+    status: string;
+    recipients: number;
+    /** Counts by reason: suppressed, duplicate, invalid. */
+    excluded: Record<string, number>;
+    source_rows: number;
+    estimated_cost_cents: number;
+    note: string;
+}
+export interface CampaignRecipient {
+    id: string;
+    address: string;
+    contact_id: string | null;
+    state: string;
+    excluded_reason: string | null;
+    message_id: string | null;
+    error: string | null;
+    sent_at: string | null;
+}
+export interface CampaignStats {
+    status: string;
+    by_state: Record<string, number>;
+    sent_today: number;
+    per_day_limit: number;
+}
+export declare function createCampaign(apiKey: string, orgId: string, input: CreateCampaignInput): Promise<Campaign>;
+export declare function listCampaigns(apiKey: string, orgId: string): Promise<Campaign[]>;
+export declare function getCampaign(apiKey: string, orgId: string, id: string): Promise<Campaign>;
+export declare function updateCampaign(apiKey: string, orgId: string, id: string, patch: Partial<CreateCampaignInput>): Promise<Campaign>;
+/** Freezes the recipient set and reports who it reaches and what it would cost. Sends nothing. */
+export declare function resolveCampaign(apiKey: string, orgId: string, id: string): Promise<CampaignResolution>;
+export declare function startCampaign(apiKey: string, orgId: string, id: string): Promise<Campaign>;
+export declare function pauseCampaign(apiKey: string, orgId: string, id: string): Promise<Campaign>;
+export declare function resumeCampaign(apiKey: string, orgId: string, id: string): Promise<Campaign>;
+export declare function cancelCampaign(apiKey: string, orgId: string, id: string): Promise<Campaign>;
+export declare function listCampaignRecipients(apiKey: string, orgId: string, id: string, state?: string): Promise<CampaignRecipient[]>;
+export declare function getCampaignStats(apiKey: string, orgId: string, id: string): Promise<CampaignStats>;

package/dist/email.js

@@ -30,6 +30,17 @@ exports.editTemplate = editTemplate;
 exports.sendTestEmail = sendTestEmail;
 exports.listTemplates = listTemplates;
 exports.deleteTemplate = deleteTemplate;
+exports.createCampaign = createCampaign;
+exports.listCampaigns = listCampaigns;
+exports.getCampaign = getCampaign;
+exports.updateCampaign = updateCampaign;
+exports.resolveCampaign = resolveCampaign;
+exports.startCampaign = startCampaign;
+exports.pauseCampaign = pauseCampaign;
+exports.resumeCampaign = resumeCampaign;
+exports.cancelCampaign = cancelCampaign;
+exports.listCampaignRecipients = listCampaignRecipients;
+exports.getCampaignStats = getCampaignStats;
 const client_1 = require("./client");
 const config_1 = require("./config");
 exports.EXPOSES = [
@@ -67,6 +78,18 @@ exports.EXPOSES = [
     'POST /email/orgs/{org_id}/verify',
     'POST /email/orgs/{org_id}/verify-bulk',
     'GET /email/orgs/{org_id}/verify-jobs/{id}',
+    // Campaigns — scheduling on top of send
+    'POST /email/orgs/{org_id}/campaigns',
+    'GET /email/orgs/{org_id}/campaigns',
+    'GET /email/orgs/{org_id}/campaigns/{campaign_id}',
+    'PATCH /email/orgs/{org_id}/campaigns/{campaign_id}',
+    'POST /email/orgs/{org_id}/campaigns/{campaign_id}/resolve',
+    'POST /email/orgs/{org_id}/campaigns/{campaign_id}/start',
+    'POST /email/orgs/{org_id}/campaigns/{campaign_id}/pause',
+    'POST /email/orgs/{org_id}/campaigns/{campaign_id}/resume',
+    'POST /email/orgs/{org_id}/campaigns/{campaign_id}/cancel',
+    'GET /email/orgs/{org_id}/campaigns/{campaign_id}/recipients',
+    'GET /email/orgs/{org_id}/campaigns/{campaign_id}/stats',
 ];
 async function verifyEmail(apiKey, orgId, email) {
     return (0, client_1.request)('POST', `${config_1.EMAIL_BASE}/email/orgs/${encodeURIComponent(orgId)}/verify`, apiKey, { email });
@@ -197,3 +220,47 @@ async function listTemplates(apiKey, orgId) {
 async function deleteTemplate(apiKey, orgId, templateId) {
     return (0, client_1.request)('DELETE', `${config_1.EMAIL_BASE}/email/orgs/${encodeURIComponent(orgId)}/templates/${encodeURIComponent(templateId)}`, apiKey);
 }
+function campaignsUrl(orgId) {
+    return `${config_1.EMAIL_BASE}/email/orgs/${encodeURIComponent(orgId)}/campaigns`;
+}
+function campaignUrl(orgId, id) {
+    return `${campaignsUrl(orgId)}/${encodeURIComponent(id)}`;
+}
+async function createCampaign(apiKey, orgId, input) {
+    return (0, client_1.request)('POST', campaignsUrl(orgId), apiKey, input);
+}
+// Walks the cursor: one page is not the whole list.
+async function listCampaigns(apiKey, orgId) {
+    return (0, client_1.requestAll)(campaignsUrl(orgId), apiKey);
+}
+async function getCampaign(apiKey, orgId, id) {
+    return (0, client_1.request)('GET', campaignUrl(orgId, id), apiKey);
+}
+async function updateCampaign(apiKey, orgId, id, patch) {
+    return (0, client_1.request)('PATCH', campaignUrl(orgId, id), apiKey, patch);
+}
+/** Freezes the recipient set and reports who it reaches and what it would cost. Sends nothing. */
+async function resolveCampaign(apiKey, orgId, id) {
+    return (0, client_1.request)('POST', `${campaignUrl(orgId, id)}/resolve`, apiKey);
+}
+async function startCampaign(apiKey, orgId, id) {
+    return (0, client_1.request)('POST', `${campaignUrl(orgId, id)}/start`, apiKey);
+}
+async function pauseCampaign(apiKey, orgId, id) {
+    return (0, client_1.request)('POST', `${campaignUrl(orgId, id)}/pause`, apiKey);
+}
+async function resumeCampaign(apiKey, orgId, id) {
+    return (0, client_1.request)('POST', `${campaignUrl(orgId, id)}/resume`, apiKey);
+}
+async function cancelCampaign(apiKey, orgId, id) {
+    return (0, client_1.request)('POST', `${campaignUrl(orgId, id)}/cancel`, apiKey);
+}
+async function listCampaignRecipients(apiKey, orgId, id, state) {
+    const url = state
+        ? `${campaignUrl(orgId, id)}/recipients?state=${encodeURIComponent(state)}`
+        : `${campaignUrl(orgId, id)}/recipients`;
+    return (0, client_1.requestAll)(url, apiKey);
+}
+async function getCampaignStats(apiKey, orgId, id) {
+    return (0, client_1.request)('GET', `${campaignUrl(orgId, id)}/stats`, apiKey);
+}

package/dist/hq.d.ts

@@ -76,6 +76,30 @@ export type FreeTierEntry = {
     reset_at?: string;
 };
 export declare function getFreeTier(apiKey: string): Promise<FreeTierEntry[] | null>;
+export interface SendingStatus {
+    sending_paused: boolean;
+    sends_24h: number;
+    bounces_24h: number;
+    complaints_24h: number;
+    bounce_threshold: number;
+    complaint_threshold: number;
+    within_limits: boolean;
+    /** Why it was paused, as recorded THEN — not whether it would pause now. */
+    paused_reason_when_paused?: string;
+    /** Present only while paused: whether a resume would be accepted today. */
+    can_resume_now?: boolean;
+    /** Set when under 100 sends in 24h, where the ratios are not judged. */
+    note?: string;
+}
+export interface ResumeSendingResult {
+    sending_paused: boolean;
+    resumed: boolean;
+    sends: number;
+    bounces: number;
+    message: string;
+}
+export declare function getSendingStatus(apiKey: string): Promise<SendingStatus>;
+export declare function resumeSending(apiKey: string): Promise<ResumeSendingResult>;
 export declare function getAccount(apiKey: string): Promise<AccountInfo>;
 export declare function getMailingAddress(apiKey: string): Promise<{
     mailing_address: string | null;

package/dist/hq.js

@@ -6,6 +6,8 @@ exports.sendCode = sendCode;
 exports.verifyCode = verifyCode;
 exports.upgradeAccount = upgradeAccount;
 exports.getFreeTier = getFreeTier;
+exports.getSendingStatus = getSendingStatus;
+exports.resumeSending = resumeSending;
 exports.getAccount = getAccount;
 exports.getMailingAddress = getMailingAddress;
 exports.setMailingAddress = setMailingAddress;
@@ -42,6 +44,8 @@ exports.EXPOSES = [
     'PATCH /hq/account/upgrade',
     'GET /hq/account/me',
     'GET /hq/account/free-tier',
+    'GET /hq/account/sending',
+    'POST /hq/account/resume-sending',
     'POST /hq/account/create/key',
     'GET /hq/account/keys',
     'POST /hq/account/keys/revoke-all',
@@ -92,6 +96,13 @@ async function upgradeAccount(apiKey, email) {
 async function getFreeTier(apiKey) {
     return (0, client_1.request)('GET', `${config_1.HQ_BASE}/hq/account/free-tier`, apiKey);
 }
+async function getSendingStatus(apiKey) {
+    return (0, client_1.request)('GET', `${config_1.HQ_BASE}/hq/account/sending`, apiKey);
+}
+// Rejected with STILL_OVER_THRESHOLD while the last 24h remain over the limit.
+async function resumeSending(apiKey) {
+    return (0, client_1.request)('POST', `${config_1.HQ_BASE}/hq/account/resume-sending`, apiKey);
+}
 async function getAccount(apiKey) {
     return (0, client_1.request)('GET', `${config_1.HQ_BASE}/hq/account/me`, apiKey);
 }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.21.0";
+export declare const SDK_VERSION = "2.22.0";

package/dist/version.js

@@ -8,4 +8,4 @@ exports.SDK_VERSION = void 0;
 // Why a constant and not a package.json read: the SDK runs inside edge
 // functions (Cloudflare Workers), so it must not import node:fs. A literal
 // is the only version source that works in every runtime we ship to.
-exports.SDK_VERSION = '2.21.0';
+exports.SDK_VERSION = '2.22.0';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@myapihq/sdk",
   "license": "Apache-2.0",
-  "version": "2.21.0",
+  "version": "2.22.0",
   "description": "TypeScript SDK for the MyAPI ecosystem",
   "repository": {
     "type": "git",