@affset/mcp 0.1.1 → 0.2.0

package/dist/tools/getStats.js

@@ -6,10 +6,18 @@ import { GROUP_BY_VALUES, SUB_KEYS } from "../types.js";
 export const GET_STATS_DESCRIPTION = "Pull affset traffic stats grouped by a single dimension. Returns impressions, clicks, " +
     "conversions, CR, payout, media cost and ROI as a table. Drill down by calling " +
     "repeatedly: first group_by=date or campaign_id, then narrow with filters " +
-    "(campaign_ids, zone_ids, sub1..sub5) and change group_by (zone_id, sub1, ...). " +
+    "(campaign_ids, zone_ids, sub1..sub5, conversion_type, advertiser_email, publisher_email) " +
+    "and change group_by (zone_id, sub1, ...). " +
     'Sub columns are titled with the tenant\'s configured labels (e.g. "Zone (sub1)") ' +
     "when set; group_by/filters always take the raw subN key. " +
-    "ROI is blank until traffic cost has been imported for the slice.";
+    "conversion_type only matches conversion rows, so filtering by it zeroes impressions, clicks " +
+    "and media cost — it narrows to conversions of that type, not clicks that led to one. " +
+    "ROI is blank until traffic cost has been imported for the slice. " +
+    "group_by=advertiser_email / publisher_email break down by team member; the API limits them " +
+    "to owner/manager plus the matching side's manager role (403 otherwise). " +
+    "advertiser_email / publisher_email are also standalone filters — narrow every row to one " +
+    "advertiser's campaigns or one publisher's zones regardless of group_by, instead of breaking " +
+    "every user out into its own row. Same role limits as the matching group_by value.";
 export const getStatsInputSchema = {
     group_by: z
         .enum(GROUP_BY_VALUES)
@@ -34,6 +42,25 @@ export const getStatsInputSchema = {
     sub3: z.string().optional().describe("Filter by sub3 value(s)."),
     sub4: z.string().optional().describe("Filter by sub4 value(s)."),
     sub5: z.string().optional().describe("Filter by sub5 value(s)."),
+    conversion_type: z
+        .string()
+        .optional()
+        .describe("Filter by conversion type value(s) (e.g. deposit, register), comma-separated for multiple. " +
+        'Pass "" to select conversions recorded without a type.'),
+    advertiser_email: z
+        .string()
+        .trim()
+        .email()
+        .optional()
+        .describe("Narrow to one advertiser's campaigns, independent of group_by. Owner/manager: any advertiser. " +
+        "advertiser_manager: only one of their own assigned advertisers (else 403). Other roles: 403."),
+    publisher_email: z
+        .string()
+        .trim()
+        .email()
+        .optional()
+        .describe("Narrow to one publisher's zones, independent of group_by. Owner/manager: any publisher. " +
+        "publisher_manager: only one of their own assigned publishers (else 403). Other roles: 403."),
 };
 export async function getStats(client, args) {
     try {
@@ -53,6 +80,14 @@ export async function getStats(client, args) {
             if (value !== undefined)
                 query[key] = value;
         }
+        if (args.conversion_type !== undefined)
+            query.conversion_type = args.conversion_type;
+        if (args.advertiser_email !== undefined) {
+            query.advertiser_email = args.advertiser_email.trim();
+        }
+        if (args.publisher_email !== undefined) {
+            query.publisher_email = args.publisher_email.trim();
+        }
         const data = await client.get("/api/stats", query);
         const table = formatStatsTable(data.stats ?? [], args.group_by, data.sub_labels);
         const heading = groupHeader(args.group_by, data.sub_labels);

package/dist/tools/getTrackingLink.d.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { type AffsetClient } from "../client.js";
+import type { Config } from "../runtimeConfig.js";
+import { type LinkArgs } from "../lib/linkArgs.js";
+export declare const GET_TRACKING_LINK_DESCRIPTION: string;
+export declare const getTrackingLinkInputSchema: {
+    source_click_id: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    cost: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sub1: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sub2: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sub3: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sub4: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sub5: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    campaign_id: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodNumber]>;
+    zone_id: z.ZodOptional<z.ZodString>;
+};
+type GetTrackingLinkArgs = LinkArgs & {
+    campaign_id: string | number;
+    zone_id?: string;
+};
+export declare function getTrackingLink(client: AffsetClient, config: Config, args: GetTrackingLinkArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/getZoneUrl.d.ts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { AffsetClient } from "../client.js";
+import type { Config } from "../runtimeConfig.js";
+import { type LinkArgs } from "../lib/linkArgs.js";
+export declare const GET_ZONE_URL_DESCRIPTION: string;
+export declare const getZoneUrlInputSchema: {
+    source_click_id: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    cost: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sub1: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sub2: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sub3: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sub4: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sub5: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    zone_id: z.ZodOptional<z.ZodString>;
+};
+type GetZoneUrlArgs = LinkArgs & {
+    zone_id?: string;
+};
+export declare function getZoneUrl(client: AffsetClient, config: Config, args: GetZoneUrlArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/listCampaigns.d.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { AffsetClient } from "../client.js";
+import { CAMPAIGN_STATUSES } from "../types.js";
+export declare const LIST_CAMPAIGNS_DESCRIPTION: string;
+export declare const listCampaignsInputSchema: {
+    status: z.ZodOptional<z.ZodEnum<["active", "paused", "archived"]>>;
+    name_contains: z.ZodOptional<z.ZodString>;
+    limit: z.ZodDefault<z.ZodNumber>;
+    offset: z.ZodDefault<z.ZodNumber>;
+    sort: z.ZodDefault<z.ZodEnum<["name", "created_at", "start_date"]>>;
+    order: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
+};
+type ListCampaignsArgs = {
+    status?: (typeof CAMPAIGN_STATUSES)[number];
+    name_contains?: string;
+    limit: number;
+    offset: number;
+    sort: "name" | "created_at" | "start_date";
+    order: "asc" | "desc";
+};
+export declare function listCampaigns(client: AffsetClient, args: ListCampaignsArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/listConversions.d.ts

@@ -0,0 +1,29 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { AffsetClient } from "../client.js";
+declare const SORT_FIELDS: readonly ["created_at", "ad_event_id", "click_id"];
+export declare const LIST_CONVERSIONS_DESCRIPTION: string;
+export declare const listConversionsInputSchema: {
+    limit: z.ZodDefault<z.ZodNumber>;
+    offset: z.ZodDefault<z.ZodNumber>;
+    sort: z.ZodDefault<z.ZodEnum<["created_at", "ad_event_id", "click_id"]>>;
+    order: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
+    click_id: z.ZodOptional<z.ZodString>;
+    source_click_id: z.ZodOptional<z.ZodString>;
+    type: z.ZodOptional<z.ZodString>;
+    payload_contains: z.ZodOptional<z.ZodString>;
+    zero_payout: z.ZodOptional<z.ZodBoolean>;
+};
+type ListConversionsArgs = {
+    limit: number;
+    offset: number;
+    sort: (typeof SORT_FIELDS)[number];
+    order: "asc" | "desc";
+    click_id?: string;
+    source_click_id?: string;
+    type?: string;
+    payload_contains?: string;
+    zero_payout?: boolean;
+};
+export declare function listConversions(client: AffsetClient, args: ListConversionsArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/listPayoutRules.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { type AffsetClient } from "../client.js";
+export declare const LIST_PAYOUT_RULES_DESCRIPTION: string;
+export declare const listPayoutRulesInputSchema: {
+    campaign_id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+};
+type ListPayoutRulesArgs = {
+    campaign_id: string | number;
+};
+export declare function listPayoutRules(client: AffsetClient, args: ListPayoutRulesArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/listSubLabels.d.ts

@@ -0,0 +1,5 @@
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { AffsetClient } from "../client.js";
+export declare const LIST_SUB_LABELS_DESCRIPTION: string;
+export declare const listSubLabelsInputSchema: {};
+export declare function listSubLabels(client: AffsetClient): Promise<CallToolResult>;

package/dist/tools/listTargetingRules.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { type AffsetClient } from "../client.js";
+export declare const LIST_TARGETING_RULES_DESCRIPTION: string;
+export declare const listTargetingRulesInputSchema: {
+    campaign_id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+};
+type ListTargetingRulesArgs = {
+    campaign_id: string | number;
+};
+export declare function listTargetingRules(client: AffsetClient, args: ListTargetingRulesArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/listTargetingTypes.d.ts

@@ -0,0 +1,5 @@
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { AffsetClient } from "../client.js";
+export declare const LIST_TARGETING_TYPES_DESCRIPTION: string;
+export declare const listTargetingTypesInputSchema: {};
+export declare function listTargetingTypes(client: AffsetClient): Promise<CallToolResult>;

package/dist/tools/listTeam.d.ts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { AffsetClient } from "../client.js";
+export declare const LIST_TEAM_DESCRIPTION: string;
+export declare const listTeamInputSchema: {
+    role: z.ZodOptional<z.ZodString>;
+    include_expired: z.ZodDefault<z.ZodBoolean>;
+};
+type ListTeamArgs = {
+    role?: string;
+    include_expired: boolean;
+};
+export declare function listTeam(client: AffsetClient, args: ListTeamArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/listZones.d.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { AffsetClient } from "../client.js";
+import { ZONE_STATUSES } from "../types.js";
+export declare const LIST_ZONES_DESCRIPTION: string;
+export declare const listZonesInputSchema: {
+    status: z.ZodOptional<z.ZodEnum<["active", "inactive"]>>;
+    name_contains: z.ZodOptional<z.ZodString>;
+    limit: z.ZodDefault<z.ZodNumber>;
+    offset: z.ZodDefault<z.ZodNumber>;
+    sort: z.ZodDefault<z.ZodEnum<["name", "created_at", "site_url"]>>;
+    order: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
+};
+type ListZonesArgs = {
+    status?: (typeof ZONE_STATUSES)[number];
+    name_contains?: string;
+    limit: number;
+    offset: number;
+    sort: "name" | "created_at" | "site_url";
+    order: "asc" | "desc";
+};
+export declare function listZones(client: AffsetClient, args: ListZonesArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/removeTargetingRule.d.ts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { type AffsetClient } from "../client.js";
+import { type TargetingMethod } from "../lib/targeting.js";
+export declare const REMOVE_TARGETING_RULE_DESCRIPTION: string;
+export declare const removeTargetingRuleInputSchema: {
+    campaign_id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    rule_id: z.ZodOptional<z.ZodNumber>;
+    type: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    method: z.ZodOptional<z.ZodEnum<["whitelist", "blacklist"]>>;
+    confirm: z.ZodDefault<z.ZodBoolean>;
+};
+type RemoveTargetingRuleArgs = {
+    campaign_id: string | number;
+    rule_id?: number;
+    type?: string | number;
+    method?: TargetingMethod;
+    confirm: boolean;
+};
+export declare function removeTargetingRule(client: AffsetClient, args: RemoveTargetingRuleArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/setCampaignStatus.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { AffsetClient } from "../client.js";
+/** Media-buyer verbs → API status. */
+export declare const CAMPAIGN_ACTIONS: readonly ["run", "pause"];
+export declare const SET_CAMPAIGN_STATUS_DESCRIPTION: string;
+export declare const setCampaignStatusInputSchema: {
+    campaign_id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    action: z.ZodEnum<["run", "pause"]>;
+    confirm: z.ZodDefault<z.ZodBoolean>;
+};
+type SetCampaignStatusArgs = {
+    campaign_id: string | number;
+    action: (typeof CAMPAIGN_ACTIONS)[number];
+    confirm: boolean;
+};
+export declare function setCampaignStatus(client: AffsetClient, args: SetCampaignStatusArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/setPayoutGoal.d.ts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { type AffsetClient } from "../client.js";
+export declare const SET_PAYOUT_GOAL_DESCRIPTION: string;
+export declare const setPayoutGoalInputSchema: {
+    campaign_id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    goal_type: z.ZodUnion<[z.ZodString, z.ZodNull]>;
+    confirm: z.ZodDefault<z.ZodBoolean>;
+};
+type SetPayoutGoalArgs = {
+    campaign_id: string | number;
+    goal_type: string | null;
+    confirm: boolean;
+};
+export declare function setPayoutGoal(client: AffsetClient, args: SetPayoutGoalArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/setPayoutRule.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { type AffsetClient } from "../client.js";
+export declare const SET_PAYOUT_RULE_DESCRIPTION: string;
+export declare const setPayoutRuleInputSchema: {
+    campaign_id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    payout: z.ZodNumber;
+    zone_id: z.ZodOptional<z.ZodString>;
+    confirm: z.ZodDefault<z.ZodBoolean>;
+};
+type SetPayoutRuleArgs = {
+    campaign_id: string | number;
+    payout: number;
+    zone_id?: string;
+    confirm: boolean;
+};
+export declare function setPayoutRule(client: AffsetClient, args: SetPayoutRuleArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/setSubLabels.d.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { AffsetClient } from "../client.js";
+export declare const SET_SUB_LABELS_DESCRIPTION: string;
+export declare const setSubLabelsInputSchema: {
+    sub1: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
+    sub2: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
+    sub3: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
+    sub4: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
+    sub5: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
+    confirm: z.ZodDefault<z.ZodBoolean>;
+};
+type SetSubLabelsArgs = {
+    sub1?: string | null;
+    sub2?: string | null;
+    sub3?: string | null;
+    sub4?: string | null;
+    sub5?: string | null;
+    confirm: boolean;
+};
+export declare function setSubLabels(client: AffsetClient, args: SetSubLabelsArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/setTargetingRule.d.ts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { type AffsetClient } from "../client.js";
+import { type TargetingMethod } from "../lib/targeting.js";
+export declare const SET_TARGETING_RULE_DESCRIPTION: string;
+export declare const setTargetingRuleInputSchema: {
+    campaign_id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    type: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    method: z.ZodEnum<["whitelist", "blacklist"]>;
+    rule: z.ZodString;
+    confirm: z.ZodDefault<z.ZodBoolean>;
+};
+type SetTargetingRuleArgs = {
+    campaign_id: string | number;
+    type: string | number;
+    method: TargetingMethod;
+    rule: string;
+    confirm: boolean;
+};
+export declare function setTargetingRule(client: AffsetClient, args: SetTargetingRuleArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/updateCampaign.d.ts

@@ -0,0 +1,35 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { type AffsetClient } from "../client.js";
+import { CAMPAIGN_STATUSES, PACING_VALUES, PAYMENT_MODELS } from "../types.js";
+export declare const UPDATE_CAMPAIGN_DESCRIPTION: string;
+export declare const updateCampaignInputSchema: {
+    campaign_id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    name: z.ZodOptional<z.ZodString>;
+    redirect_url: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodEnum<["active", "paused", "archived"]>>;
+    payment_model: z.ZodOptional<z.ZodEnum<["cpa", "cpm"]>>;
+    rate: z.ZodOptional<z.ZodNumber>;
+    start_date: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodNull]>>;
+    end_date: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodNull]>>;
+    daily_budget: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
+    total_budget: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
+    pacing: z.ZodOptional<z.ZodEnum<["asap", "even"]>>;
+    confirm: z.ZodDefault<z.ZodBoolean>;
+};
+type UpdateCampaignArgs = {
+    campaign_id: string | number;
+    name?: string;
+    redirect_url?: string;
+    status?: (typeof CAMPAIGN_STATUSES)[number];
+    payment_model?: (typeof PAYMENT_MODELS)[number];
+    rate?: number;
+    start_date?: string | number | null;
+    end_date?: string | number | null;
+    daily_budget?: number | null;
+    total_budget?: number | null;
+    pacing?: (typeof PACING_VALUES)[number];
+    confirm: boolean;
+};
+export declare function updateCampaign(client: AffsetClient, args: UpdateCampaignArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/updateZone.d.ts

@@ -0,0 +1,25 @@
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { type AffsetClient } from "../client.js";
+import { ZONE_STATUSES } from "../types.js";
+export declare const UPDATE_ZONE_DESCRIPTION: string;
+export declare const updateZoneInputSchema: {
+    zone_id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodEnum<["active", "inactive"]>>;
+    postback_url: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
+    site_url: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
+    traffic_back_url: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
+    confirm: z.ZodDefault<z.ZodBoolean>;
+};
+type UpdateZoneArgs = {
+    zone_id: string;
+    name?: string;
+    status?: (typeof ZONE_STATUSES)[number];
+    postback_url?: string | null;
+    site_url?: string | null;
+    traffic_back_url?: string | null;
+    confirm: boolean;
+};
+export declare function updateZone(client: AffsetClient, args: UpdateZoneArgs): Promise<CallToolResult>;
+export {};

package/dist/tools/whoami.d.ts

@@ -0,0 +1,6 @@
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { AffsetClient } from "../client.js";
+import type { Config } from "../runtimeConfig.js";
+export declare const WHOAMI_DESCRIPTION: string;
+export declare const whoamiInputSchema: {};
+export declare function whoami(client: AffsetClient, config: Config): Promise<CallToolResult>;

package/dist/types.d.ts

@@ -0,0 +1,210 @@
+/** Shapes of the affset tenant API responses this server consumes. */
+/** A single grouped row from `GET /api/stats`. */
+export interface StatRow {
+    date?: string;
+    campaign_id?: string;
+    campaign_name?: string | null;
+    zone_id?: string;
+    zone_name?: string | null;
+    country?: string | null;
+    conversion_type?: string | null;
+    publisher_email?: string | null;
+    advertiser_email?: string | null;
+    sub1?: string | null;
+    sub2?: string | null;
+    sub3?: string | null;
+    sub4?: string | null;
+    sub5?: string | null;
+    impressions: number;
+    fallbacks: number;
+    unsold: number;
+    clicks: number;
+    conversions: number;
+    spend?: number;
+    payout?: number;
+    media_cost?: number;
+    /** (payout - media_cost) / media_cost; null when the slice carries no cost. */
+    roi?: number | null;
+}
+export interface StatsResponse {
+    stats: StatRow[];
+    period: {
+        from: number;
+        to: number;
+    };
+    /** Tenant display names for sub1..sub5 (e.g. sub1 -> "Zone"); {} when none set. */
+    sub_labels?: SubLabels;
+}
+export interface Pagination {
+    total: number;
+    limit: number;
+    offset: number;
+    has_more: boolean;
+}
+/**
+ * One conversion from GET /api/conversions.
+ *
+ * spend/payout are absent (key missing) when the caller's role may not see them —
+ * publisher-side roles lose `spend`, advertiser-side roles lose `payout`. `null`
+ * is different: the column is visible and simply has no amount recorded. Consumers
+ * that treat "no payout" as a signal have to tell the two apart.
+ */
+export interface Conversion {
+    ad_event_id: string;
+    namespace?: string;
+    click_id: string | null;
+    payload: string | null;
+    spend?: number | null;
+    payout?: number | null;
+    source_click_id?: string | null;
+    sub1?: string | null;
+    sub2?: string | null;
+    sub3?: string | null;
+    sub4?: string | null;
+    sub5?: string | null;
+    /** Unix ms when the conversion was recorded. */
+    created_at: number;
+}
+export interface ConversionsResponse {
+    conversions: Conversion[];
+    pagination: Pagination;
+}
+/** Campaign row from list/get. */
+export interface Campaign {
+    id: number;
+    name: string;
+    status: string;
+    redirect_url?: string | null;
+    payment_model?: string;
+    rate?: number;
+    start_date?: number | null;
+    end_date?: number | null;
+    user_email?: string | null;
+    daily_budget?: number | null;
+    total_budget?: number | null;
+    pacing?: string;
+    budget_paused?: number;
+    budget_pause_reason?: string | null;
+    silent?: number;
+    payout_goal_type?: string | null;
+    created_at?: number;
+    updated_at?: number;
+    targeting_rules?: TargetingRule[];
+}
+/** Response of POST /api/campaigns. */
+export interface CreateCampaignResponse {
+    id: number;
+    name: string;
+    status: string;
+    created_at: number;
+}
+export interface CampaignsResponse {
+    campaigns: Campaign[];
+    pagination: Pagination;
+}
+export interface Zone {
+    id: string;
+    name: string;
+    status: string;
+    site_url?: string | null;
+    traffic_back_url?: string | null;
+    postback_url?: string | null;
+    user_email?: string | null;
+    manager_email?: string | null;
+    created_at?: number;
+    updated_at?: number;
+}
+export interface ZonesResponse {
+    zones: Zone[];
+    pagination: Pagination;
+}
+export interface CreateZoneResponse {
+    id: string;
+    status: string;
+    created_at: number;
+}
+export interface UpdateZoneResponse {
+    id: string;
+    updated_at: number;
+}
+export interface UpdateCampaignResponse {
+    id: number;
+    updated_at: number;
+}
+/** Subset of GET /api/tenant this server reads. */
+export interface TenantSettingsResponse {
+    company?: string;
+    /** IANA name; every date the tools render or resolve is in this zone. */
+    timezone?: string;
+    sub_labels?: SubLabels;
+    /** Tenant's own API domain; "" when unset. Integration URLs must use it. */
+    custom_api_domain?: string;
+}
+/** One payout rule from GET/POST /api/campaigns/{id}/payout_rules. */
+export interface PayoutRule {
+    id: number;
+    campaign_id: number;
+    zone_id: string | null;
+    payout: number;
+    created_at?: number;
+}
+export interface PayoutRulesResponse {
+    payout_rules: PayoutRule[];
+}
+/**
+ * One team member from GET /api/api-keys?type=user, or the response of
+ * POST /api/api-keys?type=user (create).
+ *
+ * `token` is present in both. It is not a one-time secret — affset returns it
+ * on every list call to a permitted role, same as the dashboard's "Copy token"
+ * button — but `list_team` deliberately never echoes it anyway, since a
+ * browsing-style "show my team" query is a bad place for live credentials to
+ * repeatedly pass through model context. `create_team_member` is the
+ * considered exception: it echoes the token exactly once, on the one call
+ * that just minted it for the operator to hand to that person.
+ */
+export interface TeamMember {
+    token?: string;
+    namespace?: string;
+    user_id?: string;
+    email: string | null;
+    role: string;
+    created_at: number;
+    expires_at?: number;
+    permissions?: string[];
+    manager_email?: string;
+}
+/** Response of POST /api/api-keys?type=user — same shape as TeamMember, token always present. */
+export type CreateTeamMemberResponse = TeamMember & {
+    token: string;
+};
+export interface TargetingRule {
+    id?: number;
+    campaign_id?: string | number;
+    targeting_rule_type_id: number;
+    targeting_method: "whitelist" | "blacklist";
+    rule: string;
+}
+export interface TargetingRulesResponse {
+    targeting_rules: TargetingRule[];
+}
+export interface TargetingRuleType {
+    id: number;
+    name: string;
+    description?: string | null;
+}
+export interface TargetingRuleTypesResponse {
+    targeting_rule_types: TargetingRuleType[];
+}
+/** The five traffic-source breakdown keys. */
+export declare const SUB_KEYS: readonly ["sub1", "sub2", "sub3", "sub4", "sub5"];
+export type SubKey = (typeof SUB_KEYS)[number];
+/** Tenant display names for sub slots; only labeled slots are present. */
+export type SubLabels = Partial<Record<SubKey, string>>;
+/** Valid `group_by` dimensions accepted by `GET /api/stats`. */
+export declare const GROUP_BY_VALUES: readonly ["date", "campaign_id", "zone_id", "country", "conversion_type", "publisher_email", "advertiser_email", "sub1", "sub2", "sub3", "sub4", "sub5"];
+export type GroupBy = (typeof GROUP_BY_VALUES)[number];
+export declare const CAMPAIGN_STATUSES: readonly ["active", "paused", "archived"];
+export declare const ZONE_STATUSES: readonly ["active", "inactive"];
+export declare const PAYMENT_MODELS: readonly ["cpa", "cpm"];
+export declare const PACING_VALUES: readonly ["asap", "even"];

package/dist/types.js

@@ -9,6 +9,7 @@ export const GROUP_BY_VALUES = [
     "country",
     "conversion_type",
     "publisher_email",
+    "advertiser_email",
     ...SUB_KEYS,
 ];
 export const CAMPAIGN_STATUSES = ["active", "paused", "archived"];