openvibe-sdk/coupons

Generated at 2026-10-27 15:37:35 UTC from openvibe-contracts v0.221.0 and openvibe-sdk v0.65.0.

From types/coupons.d.ts (server only). Declarations are shown verbatim.

export type ReportOutcome = 'worked' | 'failed';

export type ReportReason = 'invalid' | 'expired' | 'min_spend_not_met' | 'not_eligible' | 'other';

export interface CouponSubmission {
    code: string; title: string; merchant_id?: string; host?: string; url?: string; description?: string | null; expires?: string | null;
    expiry_basis?: 'submitter' | 'evidence'; evidence_url?: string; restrictions?: Record<string, unknown>; hint?: string | null; [k: string]: unknown;
}

export interface CouponsClient {
    merchants: {
        resolve(host: string, opts?: Opts): Promise<CouponsJson>;
        get(id: string, opts?: Opts): Promise<CouponsJson>;
        coupons(id: string, opts?: Opts): Promise<CouponsJson>;
    };
    get(id: string, opts?: Opts): Promise<CouponsJson>;
    submit(fields: CouponSubmission, opts?: Opts): Promise<CouponsJson>;
    report(id: string, req: { outcome: ReportOutcome; reason?: ReportReason | null }, opts?: Opts): Promise<CouponsJson>;
}

export function createCouponsClient(client: { json(opts: Record<string, unknown>): Promise<any> }, options?: { baseUrl?: string }): CouponsClient;