@omni-commerce/sdk 0.2.0 → 0.4.0

package/dist/index.js

@@ -24,7 +24,7 @@ function normalizeClientOptions(options = {}) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.2.0";
+var SDK_VERSION = "0.4.0";
 var SDK_USER_AGENT = `omnicommerce-js/${SDK_VERSION}`;
 
 // src/environments.ts
@@ -574,6 +574,427 @@ var AgentsClient = class {
   _http;
   general;
 };
+var AnalyticsClient = class {
+  constructor(_http) {
+    this._http = _http;
+  }
+  _http;
+  /**
+     * 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
+     *
+     * 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/profit`
+     */
+  getProfit(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      timeZone,
+      marketplace,
+      country,
+      store,
+      currency,
+      sku
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/profit",
+      query: {
+        organizationId,
+        from,
+        to,
+        timeZone,
+        marketplace,
+        country,
+        store,
+        currency,
+        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)
+    });
+  }
+};
 var AopClient = class {
   constructor(_http) {
     this._http = _http;
@@ -665,44 +1086,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;
@@ -1534,6 +1917,63 @@ var OrdersClient = class {
       ...mergeRequestOptions(requestOptions)
     });
   }
+  /**
+     * Get Order Action Options
+     *
+     * Ask the marketplace which choices an action needs, such as pickup or drop-off for `ship`. Requires `orders:write`.
+  
+  Send the chosen choice's `payload` with `POST /api/v1/orders/{orderId}/actions`.
+     *
+     * `GET /api/v1/orders/{orderId}/action-options`
+     */
+  getActionOptions(request, requestOptions) {
+    const { orderId, organizationId, action } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/orders/${encodePathParam("orderId", orderId)}/action-options`,
+      query: { organizationId, action },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * List Order Actions
+     *
+     * The order's 20 most recent action jobs, newest first, plus its latest successful label job. Requires `orders:read`.
+  
+  Poll this after queueing an action. A succeeded `labels` job lists its label files in `labels`.
+     *
+     * `GET /api/v1/orders/{orderId}/actions`
+     */
+  listActions(request, requestOptions) {
+    const { orderId, organizationId } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/orders/${encodePathParam("orderId", orderId)}/actions`,
+      query: { organizationId },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Queue Order Action
+     *
+     * Ship, cancel, generate shipping labels for, or update tracking on a marketplace order. Requires `orders:write`.
+  
+  The marketplace call runs in the background: the response is `202` with `jobId`; poll `GET /api/v1/orders/{orderId}/actions`. A repeated `idempotencyKey` returns `200` with the original job.
+     *
+     * `POST /api/v1/orders/{orderId}/actions`
+     */
+  queueAction(request, requestOptions) {
+    const { orderId, ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: `/api/v1/orders/${encodePathParam("orderId", orderId)}/actions`,
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
 };
 var OrganizationsClient = class {
   constructor(_http) {
@@ -1701,7 +2141,9 @@ var ProductsClient = class {
      *
      * List products for the authenticated organization with optional filters and pagination. Authenticate with an API key or OAuth bearer token. The organization is taken from that credential; do not send `organizationId`.
   
-  Rows are in `items`. Read catalog stock from `items[].stockQuantity`: parent rows already aggregate their non-deleted variants, and virtual bundles use component availability with any manual cap. Null means unknown, not zero. List rows do not contain `inventoryQuantity`, `inventory.quantity`, or an embedded `variants` array.
+  ### Stock and variants
+  
+  Rows are in `items`. Read catalog stock from `items[].stockQuantity`: parent rows already aggregate their non-deleted variants, and virtual bundles use component availability with any manual cap. Null means unknown, not zero. A row with `variantCount` above 0 has variants; fetch them from `GET /api/v1/products/{productId}`. List rows do not contain `inventoryQuantity`, `inventory.quantity`, or an embedded `variants` array.
      *
      * `GET /api/v1/products`
      */
@@ -1795,6 +2237,8 @@ var ProductsClient = class {
   - Localization content and cultural notes
   - Intent queries and signals
   - Sources and claims
+  
+  A parent product returns its variants in `variants`, with each variant's option values, price, stock, image, and marketplace listings.
      *
      * `GET /api/v1/products/{productId}`
      */
@@ -1888,6 +2332,25 @@ var ProductsClient = class {
       ...mergeRequestOptions(requestOptions)
     });
   }
+  /**
+     * Get Product Listings
+     *
+     * Where a product is listed: each marketplace's store, live or delisted state, item id, buyer-facing URL, and the latest publish attempt with any rejection details. Requires `catalog:read`.
+  
+  Poll after `POST /api/v1/products/{productId}/publish`.
+     *
+     * `GET /api/v1/products/{productId}/listings`
+     */
+  getListings(request, requestOptions) {
+    const { productId, organizationId } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/products/${encodePathParam("productId", productId)}/listings`,
+      query: { organizationId },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
   /**
      * Update Product Price
      *
@@ -2246,6 +2709,108 @@ var ReturnsClient = class {
     });
   }
 };
+var ReviewsClient = class {
+  constructor(_http) {
+    this._http = _http;
+  }
+  _http;
+  /**
+     * List Reviews
+     *
+     * List marketplace product reviews, newest first unless `sortBy` says otherwise. Requires `reviews:read`.
+  
+  Use `priority=unreplied` for a reply queue. `replyRestriction` is null when a reply will be accepted.
+     *
+     * `GET /api/v1/reviews`
+     */
+  list(request = {}, requestOptions) {
+    const {
+      organizationId,
+      q,
+      marketplace,
+      status,
+      priority,
+      store,
+      productId,
+      sortBy,
+      limit,
+      offset
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/reviews",
+      query: {
+        organizationId,
+        q,
+        marketplace,
+        status,
+        priority,
+        store,
+        productId,
+        sortBy,
+        limit,
+        offset
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Get Review
+   *
+   * Read one review by its OmniCommerce UUID. Requires `reviews:read`.
+   *
+   * `GET /api/v1/reviews/{reviewId}`
+   */
+  get(request, requestOptions) {
+    const { reviewId, organizationId } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/reviews/${encodePathParam("reviewId", reviewId)}`,
+      query: { organizationId },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Draft Review Reply
+     *
+     * Draft a reply with AI from the review, the product, recent replies, and the brand kit. Uses AI credits. Requires `reviews:write`.
+  
+  Nothing is posted; send the text with `POST /api/v1/reviews/actions`.
+     *
+     * `POST /api/v1/reviews/{reviewId}/draft-reply`
+     */
+  draftReply(request, requestOptions) {
+    const { reviewId, organizationId, ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: `/api/v1/reviews/${encodePathParam("reviewId", reviewId)}/draft-reply`,
+      query: { organizationId },
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Act on Reviews
+     *
+     * Reply to up to 50 reviews, or send Amazon review requests for solicitation rows. Requires `reviews:write`.
+  
+  Each target succeeds or fails on its own; read `data.results`. `ok` is true only when every target succeeds.
+     *
+     * `POST /api/v1/reviews/actions`
+     */
+  actions(request, requestOptions) {
+    const { ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: "/api/v1/reviews/actions",
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+};
 var SearchClient = class {
   constructor(_http) {
     this._http = _http;
@@ -2745,8 +3310,8 @@ var OmniGeneratedClient = class {
   constructor(_http) {
     this._http = _http;
     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);
@@ -2768,6 +3333,7 @@ var OmniGeneratedClient = class {
     this.products = new ProductsClient(this._http);
     this.promotions = new PromotionsClient(this._http);
     this.returns = new ReturnsClient(this._http);
+    this.reviews = new ReviewsClient(this._http);
     this.search = new SearchClient(this._http);
     this.settlements = new SettlementsClient(this._http);
     this.sync = new SyncClient(this._http);
@@ -2779,8 +3345,8 @@ var OmniGeneratedClient = class {
   }
   _http;
   agents;
+  analytics;
   aop;
-  api;
   campaigns;
   catalog;
   checkoutSessions;
@@ -2802,6 +3368,7 @@ var OmniGeneratedClient = class {
   products;
   promotions;
   returns;
+  reviews;
   search;
   settlements;
   sync;