@omni-commerce/sdk 0.3.0 → 0.5.0

package/dist/index.cjs

@@ -26,7 +26,7 @@ function normalizeClientOptions(options = {}) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.3.0";
+var SDK_VERSION = "0.5.0";
 var SDK_USER_AGENT = `omnicommerce-js/${SDK_VERSION}`;
 
 // src/environments.ts
@@ -430,6 +430,18 @@ function sleep(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
+// src/core/multipart.ts
+function toMultipartBody(fields) {
+  const form = new FormData();
+  for (const [key, value] of Object.entries(fields)) {
+    if (value === void 0 || value === null) continue;
+    if (value instanceof Blob) form.append(key, value);
+    else if (typeof value === "object") form.append(key, JSON.stringify(value));
+    else form.append(key, String(value));
+  }
+  return form;
+}
+
 // src/core/path.ts
 function encodePathParam(name, value) {
   if (typeof value !== "string" || value.trim() === "") {
@@ -582,37 +594,415 @@ var AnalyticsClient = class {
   }
   _http;
   /**
-     * Get Sales Analytics
+     * Get Ads Analytics
+     *
+     * Ad spend, attributed sales, ROAS, and ACOS over the last 28 days, and per-product sales and ad metrics for today, yesterday, 7-day and 28-day averages, and the same day one and four weeks ago. Matches the Ads page. Requires `analytics:read`.
+  
+  Amounts are in `data.filters.currency`. The periods count back from the end of the range.
+     *
+     * `GET /api/v1/analytics/ads`
+     */
+  getAds(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      marketplace,
+      country,
+      store,
+      currency
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/ads",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        marketplace,
+        country,
+        store,
+        currency
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Get AI Traffic Analytics
+     *
+     * Visits and crawls from AI assistants and search engines: totals, a daily trend, breakdowns by source, route, country, and product, and recent events. Matches the AI Traffic page. Requires `analytics:read`.
+  
+  A range covers at most 365 days; a longer one is shortened to the last 365 days. Read the applied range from `data.filters`.
+     *
+     * `GET /api/v1/analytics/ai-traffic`
+     */
+  getAiTraffic(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      source,
+      trafficType,
+      route,
+      country
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/ai-traffic",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        source,
+        trafficType,
+        route,
+        country
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Get Video and LIVE Analytics
+     *
+     * Views, product clicks, orders, and GMV from shoppable videos and LIVE streams, by day, by content type, and per video. Matches the Video / LIVE page. Requires `analytics:read`.
+  
+  Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
+     *
+     * `GET /api/v1/analytics/content`
+     */
+  getContent(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      marketplace,
+      country,
+      store,
+      currency
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/content",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        marketplace,
+        country,
+        store,
+        currency
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Get Order Analytics
+     *
+     * Order KPIs with their change against the previous period, a daily trend, sales by order status and by marketplace, and the top products by net sales. Repeat buyers are counted but not listed. Matches the Orders analysis page. Requires `analytics:read`.
+  
+  Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
+     *
+     * `GET /api/v1/analytics/orders`
+     */
+  getOrders(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      marketplace,
+      country,
+      store,
+      currency
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/orders",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        marketplace,
+        country,
+        store,
+        currency
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Get Growth Overview
+     *
+     * Sales, traffic, and profit KPIs with their change against the previous period, a daily trend, the traffic funnel, sales by channel, top and lagging products, and ranked next actions. Matches the Growth Intelligence overview page. Requires `analytics:read`.
+  
+  Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
+     *
+     * `GET /api/v1/analytics/overview`
+     */
+  getOverview(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      marketplace,
+      country,
+      store,
+      currency
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/overview",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        marketplace,
+        country,
+        store,
+        currency
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Get Pricing Analytics
+     *
+     * Selling products with their margin, velocity, stock cover, prices, competitor median, and a pricing recommendation. Matches the Pricing page. Requires `analytics:read`.
+  
+  Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
+     *
+     * `GET /api/v1/analytics/pricing`
+     */
+  getPricing(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      marketplace,
+      country,
+      store,
+      currency
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/pricing",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        marketplace,
+        country,
+        store,
+        currency
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Get Product Analytics
+     *
+     * Per-product sales, traffic, price, stock, profit, and ad performance, ranked by net sales, with ranked insights. Pass `productId` for specific products, for example on a product page. Matches the Products page. Requires `analytics:read`.
+  
+  Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
+     *
+     * `GET /api/v1/analytics/products`
+     */
+  getProducts(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      marketplace,
+      country,
+      store,
+      currency,
+      q,
+      productId,
+      limit
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/products",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        marketplace,
+        country,
+        store,
+        currency,
+        q,
+        productId,
+        limit
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Get Profit Analytics
      *
-     * Sales KPIs for a date range with the change against the previous period of equal length, a daily trend, sales by order status and by marketplace, and the top products by net sales. Matches the Orders analysis page. Requires `analytics:read`.
+     * Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P&L Analysis page. Requires `analytics:read`.
   
   Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
      *
-     * `GET /api/v1/analytics/sales`
+     * `GET /api/v1/analytics/profit`
      */
-  getSales(request = {}, requestOptions) {
+  getProfit(request = {}, requestOptions) {
     const {
       organizationId,
       from,
       to,
+      timeZone,
       marketplace,
       country,
       store,
       currency,
-      timeZone
+      sku
     } = request ?? {};
     return this._http.request({
       method: "GET",
-      path: "/api/v1/analytics/sales",
+      path: "/api/v1/analytics/profit",
       query: {
         organizationId,
         from,
         to,
+        timeZone,
         marketplace,
         country,
         store,
         currency,
-        timeZone
+        sku
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Get Business Report
+     *
+     * The management summary: headline KPIs, top products, sales by marketplace, alerts, settlement totals, and data quality. Matches the Business Reports page. Requires `analytics:read`.
+  
+  Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
+     *
+     * `GET /api/v1/analytics/reports`
+     */
+  getReports(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      marketplace,
+      country,
+      store,
+      currency
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/reports",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        marketplace,
+        country,
+        store,
+        currency
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Get Store Analytics
+     *
+     * Seller Centre shop metrics: visitors, page views, followers, the placed, paid, and confirmed buyer funnel, a daily trend, and the app and web split. Matches the Analytics (Seller Centre) page. Requires `analytics:read`.
+  
+  Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
+     *
+     * `GET /api/v1/analytics/stores`
+     */
+  getStores(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      marketplace,
+      country,
+      store,
+      currency
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/stores",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        marketplace,
+        country,
+        store,
+        currency
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Get Traffic Analytics
+     *
+     * Impressions, page views, visitors, add-to-cart, and conversion, with the funnel, a daily trend, products ranked by lost conversion, diagnostics, and the videos that drive traffic. Matches the Traffic page. Requires `analytics:read`.
+  
+  Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
+     *
+     * `GET /api/v1/analytics/traffic`
+     */
+  getTraffic(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      marketplace,
+      country,
+      store,
+      currency
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/traffic",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        marketplace,
+        country,
+        store,
+        currency
       },
       body: void 0,
       ...mergeRequestOptions(requestOptions)
@@ -710,44 +1100,6 @@ var AopClient = class {
     });
   }
 };
-var ApiClient = class {
-  constructor(_http) {
-    this._http = _http;
-  }
-  _http;
-  /**
-   * API Root
-   *
-   * Public API discovery root. Merchant payments are handled by organization-scoped checkout session endpoints.
-   *
-   * `GET /api`
-   */
-  root(requestOptions) {
-    return this._http.request({
-      method: "GET",
-      path: "/api",
-      query: void 0,
-      body: void 0,
-      ...mergeRequestOptions(requestOptions)
-    });
-  }
-  /**
-   * API v1 Root
-   *
-   * Public API v1 discovery root. Merchant payments are handled by organization-scoped checkout session endpoints.
-   *
-   * `GET /api/v1`
-   */
-  v1(requestOptions) {
-    return this._http.request({
-      method: "GET",
-      path: "/api/v1",
-      query: void 0,
-      body: void 0,
-      ...mergeRequestOptions(requestOptions)
-    });
-  }
-};
 var CampaignsClient = class {
   constructor(_http) {
     this._http = _http;
@@ -1068,6 +1420,48 @@ var DirectoryClient = class {
     });
   }
 };
+var DocumentsClient = class {
+  constructor(_http) {
+    this._http = _http;
+  }
+  _http;
+  /**
+     * Upload Document
+     *
+     * Upload one file to the knowledge base as multipart/form-data. Requires `documents:write`.
+  
+  Accepted: PDF up to 20 MB, Excel (.xlsx/.xlsm) up to 10 MB, images up to 8 MB, CSV and Markdown up to 2 MB. PDFs, Markdown, and images are indexed in the background; poll `GET /api/v1/documents/{documentId}` until `status` is `completed`. CSV and Excel are stored for agents to read but are not indexed.
+     *
+     * `POST /api/v1/documents`
+     */
+  upload(request, requestOptions) {
+    const { ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: "/api/v1/documents",
+      query: void 0,
+      body: toMultipartBody(body),
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Get Document
+   *
+   * Read one knowledge base document and its indexing status. Requires `documents:read`.
+   *
+   * `GET /api/v1/documents/{documentId}`
+   */
+  get(request, requestOptions) {
+    const { documentId, organizationId } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/documents/${encodePathParam("documentId", documentId)}`,
+      query: { organizationId },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+};
 var EvaluateClient = class {
   constructor(_http) {
     this._http = _http;
@@ -1969,6 +2363,25 @@ var ProductsClient = class {
       ...mergeRequestOptions(requestOptions)
     });
   }
+  /**
+     * Upload Product Image
+     *
+     * Upload one image to a product's or variant's gallery as multipart/form-data. Requires `catalog:write`.
+  
+  JPEG, PNG, WebP, AVIF, or HEIC up to 8 MB; WebP, AVIF, and HEIC are stored as JPEG. The image is added at `position`, or at the end. Publish the product to send the new gallery to marketplaces.
+     *
+     * `POST /api/v1/products/{productId}/images`
+     */
+  uploadImage(request, requestOptions) {
+    const { productId, ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: `/api/v1/products/${encodePathParam("productId", productId)}/images`,
+      query: void 0,
+      body: toMultipartBody(body),
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
   /**
      * Update Product Inventory
      *
@@ -2298,17 +2711,19 @@ var PromotionsClient = class {
     });
   }
   /**
-   * Sync Promotion to Marketplaces
-   *
-   * Queue marketplace push for assigned products (Shopee promotion, Lazada Store Flash Sale/voucher/Flexicombo, TikTok activity, or Shopify discount). Requires `promotions:write`.
-   *
-   * `POST /api/v1/promotions/{promotionId}/sync`
-   */
-  sync(request, requestOptions) {
+     * Retry Marketplace Delivery
+     *
+     * Run marketplace delivery again after a failure, for example once a store is reconnected. Requires `promotions:write`.
+  
+  You do not need this to publish a promotion: creating or activating it, editing it while active or scheduled, and assigning products already deliver it, and pausing, ending, or archiving removes it. A retry brings each marketplace back in line with the promotion's current status.
+     *
+     * `POST /api/v1/promotions/{promotionId}/retry`
+     */
+  retry(request, requestOptions) {
     const { promotionId, organizationId, ...body } = request ?? {};
     return this._http.request({
       method: "POST",
-      path: `/api/v1/promotions/${encodePathParam("promotionId", promotionId)}/sync`,
+      path: `/api/v1/promotions/${encodePathParam("promotionId", promotionId)}/retry`,
       query: { organizationId },
       body,
       ...mergeRequestOptions(requestOptions)
@@ -2974,12 +3389,12 @@ var OmniGeneratedClient = class {
     this.agents = new AgentsClient(this._http);
     this.analytics = new AnalyticsClient(this._http);
     this.aop = new AopClient(this._http);
-    this.api = new ApiClient(this._http);
     this.campaigns = new CampaignsClient(this._http);
     this.catalog = new CatalogClient(this._http);
     this.checkoutSessions = new CheckoutSessionsClient(this._http);
     this.compare = new CompareClient(this._http);
     this.directory = new DirectoryClient(this._http);
+    this.documents = new DocumentsClient(this._http);
     this.evaluate = new EvaluateClient(this._http);
     this.feed = new FeedClient(this._http);
     this.images = new ImagesClient(this._http);
@@ -3010,12 +3425,12 @@ var OmniGeneratedClient = class {
   agents;
   analytics;
   aop;
-  api;
   campaigns;
   catalog;
   checkoutSessions;
   compare;
   directory;
+  documents;
   evaluate;
   feed;
   images;