agentref 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,421 @@
+interface PaginationMeta {
+    total: number;
+    page: number;
+    pageSize: number;
+    hasMore: boolean;
+    nextCursor?: string;
+    requestId: string;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    meta: PaginationMeta;
+}
+interface AgentRefConfig {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+    dangerouslyAllowBrowser?: boolean;
+}
+interface MutationOptions {
+    idempotencyKey?: string;
+}
+interface Merchant {
+    id: string;
+    email: string;
+    companyName?: string | null;
+    domain?: string | null;
+    domainVerified?: boolean;
+    trustLevel?: string;
+    stripeConnected?: boolean;
+    createdAt?: string;
+    [key: string]: unknown;
+}
+type CommissionType = 'one_time' | 'recurring' | 'recurring_limited';
+type ProgramStatus = 'active' | 'paused' | 'archived';
+interface Program {
+    id: string;
+    name: string;
+    description?: string | null;
+    landingPageUrl?: string | null;
+    commissionType: CommissionType;
+    commissionPercent: number;
+    commissionLimitMonths?: number | null;
+    cookieDuration: number;
+    payoutThreshold: number;
+    autoApproveAffiliates: boolean;
+    status: ProgramStatus;
+    isPublic?: boolean;
+    merchantId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    [key: string]: unknown;
+}
+interface CreateProgramParams {
+    name: string;
+    commissionType: CommissionType;
+    commissionPercent: number;
+    cookieDuration?: number;
+    payoutThreshold?: number;
+    autoApproveAffiliates?: boolean;
+    description?: string;
+    landingPageUrl?: string;
+    commissionLimitMonths?: number;
+}
+interface UpdateProgramParams {
+    name?: string;
+    commissionType?: CommissionType;
+    commissionPercent?: number;
+    cookieDuration?: number;
+    payoutThreshold?: number;
+    autoApproveAffiliates?: boolean;
+    description?: string;
+    landingPageUrl?: string;
+    status?: ProgramStatus;
+}
+interface CreateCouponParams {
+    affiliateId: string;
+    code: string;
+    expiresAt?: string;
+}
+interface ProgramStats {
+    [key: string]: unknown;
+}
+type AffiliateStatus = 'pending' | 'approved' | 'blocked';
+interface Affiliate {
+    id: string;
+    userId?: string;
+    programId?: string;
+    code?: string;
+    status?: AffiliateStatus | string;
+    totalClicks?: number;
+    totalConversions?: number;
+    totalEarnings?: number;
+    createdAt?: string;
+    [key: string]: unknown;
+}
+type ConversionStatus = 'pending' | 'approved' | 'rejected' | 'refunded';
+interface Conversion {
+    id: string;
+    affiliateId?: string;
+    programId?: string;
+    amount?: number;
+    commission?: number;
+    status?: ConversionStatus | string;
+    method?: 'cookie' | 'coupon' | 'metadata' | string;
+    stripeSessionId?: string | null;
+    createdAt?: string;
+    [key: string]: unknown;
+}
+interface ConversionStats {
+    [key: string]: unknown;
+}
+type PayoutStatus = 'pending' | 'processing' | 'completed' | 'failed';
+interface Payout {
+    id: string;
+    affiliateId?: string;
+    amount?: number;
+    status?: PayoutStatus | string;
+    method?: string | null;
+    createdAt?: string;
+    completedAt?: string | null;
+    [key: string]: unknown;
+}
+interface PendingAffiliate {
+    affiliateId?: string;
+    email?: string;
+    name?: string | null;
+    code?: string;
+    programId?: string;
+    programName?: string;
+    payoutMethod?: 'paypal' | 'bank_transfer' | null;
+    paypalEmail?: string | null;
+    bankIban?: string | null;
+    pendingAmount?: number;
+    currency?: string;
+    threshold?: number;
+    meetsThreshold?: boolean;
+    commissionCount?: number;
+    hasPayoutMethod?: boolean;
+    [key: string]: unknown;
+}
+interface PayoutStats {
+    [key: string]: unknown;
+}
+type FlagStatus = 'open' | 'reviewed' | 'dismissed' | 'confirmed';
+type FlagType = 'suspicious_activity' | 'self_referral' | 'high_click_frequency' | 'conversion_anomaly' | 'manual_review';
+interface Flag {
+    id: string;
+    affiliateId?: string;
+    type?: FlagType | string;
+    status?: FlagStatus | string;
+    details?: Record<string, unknown> | null;
+    note?: string | null;
+    createdAt?: string;
+    resolvedAt?: string | null;
+    [key: string]: unknown;
+}
+interface FlagStats {
+    [key: string]: unknown;
+}
+interface ResolveFlagParams {
+    status: 'reviewed' | 'dismissed' | 'confirmed';
+    note?: string;
+    blockAffiliate?: boolean;
+}
+type BillingTierId = 'free' | 'starter' | 'growth' | 'pro' | 'scale';
+interface BillingTier {
+    id: BillingTierId;
+    name: string;
+    price: number;
+    maxRevenue?: number;
+    features?: string[];
+    bookable?: boolean;
+    [key: string]: unknown;
+}
+interface BillingStatus {
+    tier?: BillingTierId | string;
+    monthlyRevenue?: number;
+    nextTier?: BillingTierId | string | null;
+    stripeSubscriptionId?: string | null;
+    [key: string]: unknown;
+}
+interface Coupon {
+    id: string;
+    code: string;
+    affiliateId?: string;
+    programId?: string;
+    createdAt?: string;
+    [key: string]: unknown;
+}
+interface Invite {
+    token?: string;
+    email?: string;
+    programId?: string;
+    expiresAt?: string;
+    createdAt?: string;
+    [key: string]: unknown;
+}
+
+type HttpMethod = 'GET' | 'HEAD' | 'POST' | 'PATCH' | 'DELETE';
+interface RequestOptions {
+    method: HttpMethod;
+    path: string;
+    body?: unknown;
+    query?: Record<string, string | number | boolean | undefined>;
+    idempotencyKey?: string;
+}
+declare class HttpClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly timeout;
+    private readonly maxRetries;
+    constructor(config?: AgentRefConfig);
+    request<T>(options: RequestOptions): Promise<T>;
+    private buildUrl;
+    private parseError;
+    private isRetryable;
+    private retryAfterToSeconds;
+    private retryAfterToMs;
+    private wait;
+    private backoff;
+}
+
+declare class AffiliatesResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(params?: {
+        programId?: string;
+        includeBlocked?: boolean;
+        cursor?: string;
+        limit?: number;
+        page?: number;
+        pageSize?: number;
+        offset?: number;
+    }): Promise<PaginatedResponse<Affiliate>>;
+    get(id: string): Promise<Affiliate>;
+    approve(id: string, options?: MutationOptions): Promise<Affiliate>;
+    block(id: string, data?: {
+        reason?: string;
+    }, options?: MutationOptions): Promise<Affiliate>;
+    unblock(id: string, options?: MutationOptions): Promise<Affiliate>;
+}
+
+declare class BillingResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    current(): Promise<BillingStatus>;
+    tiers(): Promise<BillingTier[]>;
+    subscribe(data: {
+        tier: 'starter' | 'growth' | 'pro' | 'scale';
+    }, options?: MutationOptions): Promise<BillingStatus>;
+}
+
+declare class ConversionsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(params?: {
+        programId?: string;
+        affiliateId?: string;
+        status?: string;
+        startDate?: string;
+        endDate?: string;
+        from?: string;
+        to?: string;
+        cursor?: string;
+        limit?: number;
+        page?: number;
+        pageSize?: number;
+        offset?: number;
+    }): Promise<PaginatedResponse<Conversion>>;
+    stats(params?: {
+        programId?: string;
+        period?: '7d' | '30d' | '90d' | 'all';
+    }): Promise<ConversionStats>;
+    recent(params?: {
+        limit?: number;
+    }): Promise<Conversion[]>;
+}
+
+declare class FlagsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(params?: {
+        status?: string;
+        type?: string;
+        affiliateId?: string;
+        cursor?: string;
+        limit?: number;
+        page?: number;
+        pageSize?: number;
+        offset?: number;
+    }): Promise<PaginatedResponse<Flag>>;
+    stats(): Promise<FlagStats>;
+    resolve(id: string, data: ResolveFlagParams, options?: MutationOptions): Promise<Flag>;
+}
+
+interface DomainStatus {
+    domain: string | null;
+    verified: boolean;
+    txtRecord?: string | null;
+    [key: string]: unknown;
+}
+declare class MerchantResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    get(): Promise<Merchant>;
+    domainStatus(): Promise<DomainStatus>;
+}
+
+declare class PayoutsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(params?: {
+        programId?: string;
+        affiliateId?: string;
+        status?: PayoutStatus;
+        startDate?: string;
+        endDate?: string;
+        from?: string;
+        to?: string;
+        cursor?: string;
+        limit?: number;
+        page?: number;
+        pageSize?: number;
+        offset?: number;
+    }): Promise<PaginatedResponse<Payout>>;
+    listPending(params?: {
+        programId?: string;
+        cursor?: string;
+        limit?: number;
+        page?: number;
+        pageSize?: number;
+        offset?: number;
+    }): Promise<PaginatedResponse<PendingAffiliate>>;
+    stats(params?: {
+        programId?: string;
+        period?: '7d' | '30d' | '90d' | 'all';
+    }): Promise<PayoutStats>;
+}
+
+declare class ProgramsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(params?: {
+        cursor?: string;
+        limit?: number;
+        page?: number;
+        pageSize?: number;
+        offset?: number;
+    }): Promise<PaginatedResponse<Program>>;
+    listAll(params?: {
+        pageSize?: number;
+    }): AsyncGenerator<Program>;
+    get(id: string): Promise<Program>;
+    create(data: CreateProgramParams, options?: MutationOptions): Promise<Program>;
+    update(id: string, data: UpdateProgramParams): Promise<Program>;
+    delete(id: string): Promise<Program>;
+    stats(id: string, params?: {
+        period?: string;
+    }): Promise<ProgramStats>;
+    listAffiliates(id: string, params?: {
+        includeBlocked?: boolean;
+        cursor?: string;
+        limit?: number;
+        page?: number;
+        pageSize?: number;
+        offset?: number;
+    }): Promise<PaginatedResponse<Affiliate>>;
+    listCoupons(id: string): Promise<Coupon[]>;
+    createCoupon(id: string, data: CreateCouponParams, options?: MutationOptions): Promise<Coupon>;
+    createInvite(id: string, data: {
+        email?: string;
+        name?: string;
+        isPublic?: boolean;
+        usageLimit?: number;
+        expiresInDays?: number;
+    }, options?: MutationOptions): Promise<Invite>;
+}
+
+declare class AgentRef {
+    readonly programs: ProgramsResource;
+    readonly affiliates: AffiliatesResource;
+    readonly conversions: ConversionsResource;
+    readonly payouts: PayoutsResource;
+    readonly flags: FlagsResource;
+    readonly billing: BillingResource;
+    readonly merchant: MerchantResource;
+    constructor(config?: AgentRefConfig);
+}
+
+declare class AgentRefError extends Error {
+    readonly code: string;
+    readonly status: number;
+    readonly requestId: string;
+    constructor(message: string, code: string, status: number, requestId: string);
+}
+declare class AuthError extends AgentRefError {
+    constructor(message: string, code: string, requestId: string);
+}
+declare class ForbiddenError extends AgentRefError {
+    constructor(message: string, code: string, requestId: string);
+}
+declare class ValidationError extends AgentRefError {
+    readonly details: unknown;
+    constructor(message: string, code: string, requestId: string, details?: unknown);
+}
+declare class NotFoundError extends AgentRefError {
+    constructor(message: string, code: string, requestId: string);
+}
+declare class ConflictError extends AgentRefError {
+    constructor(message: string, code: string, requestId: string);
+}
+declare class RateLimitError extends AgentRefError {
+    readonly retryAfter: number;
+    constructor(message: string, code: string, requestId: string, retryAfter: number);
+}
+declare class ServerError extends AgentRefError {
+    constructor(message: string, code: string, status: number, requestId: string);
+}
+
+export { type Affiliate, type AffiliateStatus, AgentRef, type AgentRefConfig, AgentRefError, AuthError, type BillingStatus, type BillingTier, type BillingTierId, type CommissionType, ConflictError, type Conversion, type ConversionStats, type ConversionStatus, type Coupon, type CreateCouponParams, type CreateProgramParams, type Flag, type FlagStats, type FlagStatus, type FlagType, ForbiddenError, type Invite, type Merchant, type MutationOptions, NotFoundError, type PaginatedResponse, type PaginationMeta, type Payout, type PayoutStats, type PayoutStatus, type PendingAffiliate, type Program, type ProgramStats, type ProgramStatus, RateLimitError, type ResolveFlagParams, ServerError, type UpdateProgramParams, ValidationError };