@chat-ads/chatads-sdk 0.1.6 → 0.1.8

package/README.md

@@ -19,7 +19,7 @@ import { ChatAdsClient } from "@chat-ads/chatads-sdk";
 
 const client = new ChatAdsClient({
   apiKey: process.env.CHATADS_API_KEY!,
-  baseUrl: "https://chatads--chatads-api-fastapiserver-serve.modal.run",
+  baseUrl: "https://api.getchatads.com",
   maxRetries: 2,
   raiseOnFailure: true,
 });
@@ -29,8 +29,8 @@ const response = await client.analyze({
   ip: "8.8.8.8",
 });
 
-if (response.success && response.data?.ad) {
-  console.log(response.data.ad);
+if (response.success && response.data?.Offers.length) {
+  console.log(response.data.Offers[0]);
 } else {
   console.error(response.error);
 }
@@ -90,26 +90,22 @@ try {
 {
   "success": true,
   "data": {
-    "matched": true,
-    "filled": true,
-    "ad": {
-      "product": "CRM Pro",
-      "link": "https://getchatads.com/example",
-      "message": "Try CRM Pro for your sales team",
-      "category": "Software"
-    },
-    "keyword": "CRM tools",
-    "intent_score": 0.85,
-    "intent_level": "high"
+    "Offers": [
+      {
+        "LinkText": "CRM tools",
+        "IntentLevel": "high",
+        "URL": "https://amazon.com/dp/example?tag=chatads-20",
+        "Status": "filled",
+        "Category": "Software"
+      }
+    ],
+    "Requested": 1,
+    "Returned": 1
   },
   "error": null,
   "meta": {
     "request_id": "req_123",
-    "extraction_method": "llm",
-    "message_analysis_used": "thorough",
-    "fill_priority_used": "coverage",
-    "min_intent_used": "low",
-    "processing_time_ms": 42.3,
+    "country": "US",
     "usage": {
       "monthly_requests": 120,
       "free_tier_limit": 1000,
@@ -128,7 +124,7 @@ TypeScript projects can import `ChatAdsResponseEnvelope` and related interfaces
 
 ```bash
 npm run build
-CHATADS_API_KEY=... CHATADS_BASE_URL=https://chatads--chatads-api-fastapiserver-serve.modal.run \
+CHATADS_API_KEY=... CHATADS_BASE_URL=https://api.getchatads.com \
   node dist/examples/basic.js
 ```
 

package/dist/client.js

@@ -6,7 +6,7 @@ const DEFAULT_BACKOFF_FACTOR = 500; // ms
 const DEFAULT_RETRYABLE_STATUSES = new Set([408, 409, 425, 429, 500, 502, 503, 504]);
 /**
  * Field aliases for normalizing optional field names.
- * Only includes the 6 optional fields from the OpenAPI spec.
+ * Only includes the 7 optional fields from the OpenAPI spec.
  */
 const FIELD_ALIASES = {
     messageanalysis: "message_analysis",
@@ -17,6 +17,8 @@ const FIELD_ALIASES = {
     min_intent: "min_intent",
     skipmessageanalysis: "skip_message_analysis",
     skip_message_analysis: "skip_message_analysis",
+    maxoffers: "max_offers",
+    max_offers: "max_offers",
 };
 export class ChatAdsClient {
     constructor(options) {

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { ChatAdsClient } from "./client.js";
 export { ChatAdsAPIError, ChatAdsSDKError } from "./errors.js";
 export type { ChatAdsClientOptions, AnalyzeOptions, AnalyzeMessageOptions, } from "./client.js";
-export type { ChatAdsResponseEnvelope, ChatAdsAd, ChatAdsData, ChatAdsError, ChatAdsMeta, UsageInfo, FunctionItemPayload, FunctionItemOptionalFields, MessageAnalysis, FillPriority, MinIntent, } from "./models.js";
+export type { ChatAdsResponseEnvelope, Offer, Product, AnalyzeData, ChatAdsError, ChatAdsMeta, UsageInfo, FunctionItemPayload, FunctionItemOptionalFields, MessageAnalysis, FillPriority, MinIntent, IntentLevel, OfferStatus, UrlSource, } from "./models.js";

package/dist/models.d.ts

@@ -1,12 +1,15 @@
 export type MessageAnalysis = "fast" | "thorough";
 export type FillPriority = "speed" | "coverage";
 export type MinIntent = "any" | "low" | "medium" | "high";
+export type IntentLevel = "high" | "medium" | "low" | "very_low";
+export type OfferStatus = "filled" | "scored" | "failed";
+export type UrlSource = "demo" | "serper" | "amazon_paapi" | "cache";
 /**
  * Optional fields for ChatAds API requests.
- * Only these 6 optional fields are supported (plus required `message`).
+ * Only these 7 optional fields are supported (plus required `message`).
  */
 export type FunctionItemOptionalFields = {
-    /** Client IP address for geo-detection (max 64 characters) */
+    /** Client IP address for geo-detection (max 45 characters) */
     ip?: string;
     /** ISO 3166-1 alpha-2 country code for geo-targeting */
     country?: string;
@@ -18,26 +21,63 @@ export type FunctionItemOptionalFields = {
     min_intent?: MinIntent;
     /** Skip NLP/LLM extraction and use message directly as search query. Default: false */
     skip_message_analysis?: boolean;
+    /** Maximum number of affiliate offers to return (1-2). Default: 1 */
+    max_offers?: number;
 };
 export type FunctionItemPayload = {
     message: string;
     extraFields?: Record<string, unknown>;
 } & FunctionItemOptionalFields;
-export interface ChatAdsAd {
-    product: string;
-    link: string;
-    message: string;
-    category: string;
+/**
+ * Product metadata from resolution.
+ */
+export interface Product {
+    /** Product title from search result */
+    Title?: string;
+    /** Product description/snippet from search result */
+    Description?: string;
+}
+/**
+ * Single affiliate offer returned by the API.
+ */
+export interface Offer {
+    /** Text to use for the affiliate link */
+    LinkText: string;
+    /** Product search term used */
+    SearchTerm?: string;
+    /** Intent score (0.0-1.0) */
+    IntentScore?: number | null;
+    /** Intent level classification */
+    IntentLevel: string;
+    /** Affiliate URL */
+    URL: string;
+    /** Source of the URL (e.g., amazon, serper) */
+    URLSource?: string;
+    /** Offer status */
+    Status: OfferStatus;
+    /** Reason for status (e.g., failure reason) */
+    Reason?: string;
+    /** Detected product category */
+    Category?: string;
+    /** Product metadata from resolution */
+    Product?: Product;
 }
-export interface ChatAdsData {
-    matched: boolean;
-    filled?: boolean;
-    ad?: ChatAdsAd | null;
-    keyword?: string | null;
-    reason?: string | null;
-    intent_score?: number | null;
-    intent_level?: string | null;
-    min_intent_required?: string | null;
+/**
+ * Response data containing affiliate offers.
+ */
+export interface AnalyzeData {
+    /** Array of affiliate offers */
+    Offers: Offer[];
+    /** Number of offers requested */
+    Requested: number;
+    /** Number of offers returned */
+    Returned: number;
+    /** Total processing latency in milliseconds */
+    LatencyMs?: number;
+    /** LLM extraction step timing */
+    ExtractionMs?: number;
+    /** Affiliate URL lookup timing */
+    LookupMs?: number;
 }
 export interface ChatAdsError {
     code: string;
@@ -54,26 +94,22 @@ export interface UsageInfo {
 }
 export interface ChatAdsMeta {
     request_id: string;
-    user_id?: string | null;
+    timestamp?: string;
+    version?: string;
     country?: string | null;
-    language?: string | null;
-    extraction_method?: "llm" | "nlp" | "skip" | null;
-    message_analysis_used?: "fast" | "thorough" | "skip" | null;
-    fill_priority_used?: "speed" | "coverage" | "skip" | null;
-    min_intent_used?: "any" | "low" | "medium" | "high" | null;
-    processing_time_ms?: number | null;
     usage?: UsageInfo | null;
+    timing_ms?: Record<string, number>;
     [key: string]: unknown;
 }
 export interface ChatAdsResponseEnvelope {
     success: boolean;
-    data?: ChatAdsData | null;
+    data?: AnalyzeData | null;
     error?: ChatAdsError | null;
     meta: ChatAdsMeta;
     [key: string]: unknown;
 }
 /**
  * Reserved payload keys that cannot be used in extraFields.
- * These are the 7 allowed request fields per the OpenAPI spec.
+ * These are the 8 allowed request fields per the OpenAPI spec.
  */
 export declare const RESERVED_PAYLOAD_KEYS: ReadonlySet<string>;

package/dist/models.js

@@ -1,6 +1,6 @@
 /**
  * Reserved payload keys that cannot be used in extraFields.
- * These are the 7 allowed request fields per the OpenAPI spec.
+ * These are the 8 allowed request fields per the OpenAPI spec.
  */
 export const RESERVED_PAYLOAD_KEYS = new Set([
     "message",
@@ -10,4 +10,5 @@ export const RESERVED_PAYLOAD_KEYS = new Set([
     "fill_priority",
     "min_intent",
     "skip_message_analysis",
+    "max_offers",
 ]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chat-ads/chatads-sdk",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "TypeScript/JavaScript client for the ChatAds prospect scoring API",
   "license": "MIT",
   "type": "module",