@omni-commerce/sdk 0.1.0 → 0.1.1

package/dist/index.d.cts

@@ -918,13 +918,15 @@ interface paths {
     };
     /**
      * List Price Book Rules
-     * @description List marketplace price book rules for the authenticated organization. Rules apply markup percent to canonical list price at publish/catalog time by platform (and optional store/country). Requires `price_books:read`.
+     * @description List marketplace price book rules for the authenticated organization. A rule applies either a buyer formula or a markup percent to the catalog price at publish time, by platform and optional store/country. Requires `price_books:read`.
      */
     get: operations["get_v1_price_books"];
     put?: never;
     /**
      * Create Price Book Rule
-     * @description Create a marketplace price book rule for a platform (optional store, country, and source). A markup percent applies to list price. When `steps` is present it replaces that percent: the formula can start from list price or cost, convert, add fees or shipping, and round. Catalog prices stay unchanged. A payout formula is calculated and is not published as the customer price. Requires `price_books:write`.
+     * @description Create a marketplace price book rule for a platform (optional store and country). Does not change Omni product prices. Requires `price_books:write`.
+     *
+     *     `expression` is the buyer formula and replaces markup percent. `price` in that formula is the catalog price, not cost price. Without an expression, `marginValue` is the markup percent.
      */
     post: operations["post_v1_price_books"];
     delete?: never;
@@ -956,7 +958,7 @@ interface paths {
     head?: never;
     /**
      * Update Price Book Rule
-     * @description Update store, country, source, markup, formula steps, rounding, currency, or enabled flag for a price book rule. Platform cannot be changed; create a new rule instead. Requires `price_books:write`.
+     * @description Update store, country, markup, buyer formula, rounding, currency, or enabled flag for a price book rule. Platform cannot be changed; create a new rule instead. Requires `price_books:write`.
      */
     patch: operations["patch_v1_price_books_by_ruleid"];
     trace?: never;
@@ -991,6 +993,8 @@ interface paths {
     /**
      * List Products
      * @description 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.
      */
     get: operations["get_v1_products"];
     put?: never;
@@ -1086,7 +1090,9 @@ interface paths {
     put?: never;
     /**
      * Delist Product
-     * @description Queue delist for one product on the marketplaces you name. `marketplaces` accepts one or more of shopee, lazada, tiktok, shopify, whatsapp, zalora, amazon, and ebay. Each named marketplace must already have a listing; other channels are left untouched. Omit `marketplaces` to delist every existing listing. This does not delete the OmniCommerce product. Poll GET /api/v1/jobs/{jobId} until data.status is succeeded, partial, or failed. Accepted means the job was queued, not that the marketplace has removed the listing.
+     * @description Queue delist for one product on the marketplaces you name. `marketplaces` accepts one or more of shopee, lazada, tiktok, shopify, whatsapp, zalora, amazon, and ebay. Each named marketplace must already have a listing; other channels are left untouched. Omit `marketplaces` to delist every existing listing. This does not delete the OmniCommerce product.
+     *
+     *     Poll GET /api/v1/jobs/{jobId} until data.status is succeeded, partial, or failed. Accepted means the job was queued, not that the marketplace has removed the listing.
      */
     post: operations["post_v1_products_by_productid_delist"];
     delete?: never;
@@ -2087,6 +2093,33 @@ interface components {
     } & {
       [key: string]: unknown;
     };
+    ReviewWebhookSnapshot: {
+      id: string;
+      organizationId: string;
+      platform: string;
+      accountId: string | null;
+      productId: string | null;
+      orderId: string | null;
+      externalItemId: string | null;
+      externalReviewId: string;
+      externalOrderId: string | null;
+      /** @enum {string} */
+      kind: "product_review" | "solicitation";
+      /** @enum {string} */
+      status:
+        | "open"
+        | "replied"
+        | "hidden"
+        | "handoff"
+        | "solicited"
+        | "ineligible";
+      rating: number | null;
+      comment: string | null;
+      sellerReply: string | null;
+      canReply: boolean;
+      /** Format: date-time */
+      reviewedAt: string | null;
+    };
     ProductCreatedWebhookEvent: {
       /** @description Stable event ID and recipient idempotency key. */
       eventId: string;
@@ -2297,6 +2330,72 @@ interface components {
     } & {
       [key: string]: unknown;
     };
+    ReviewCreatedWebhookEvent: {
+      /** @description Stable event ID and recipient idempotency key. */
+      eventId: string;
+      /** @constant */
+      eventType: "review.created";
+      organizationId: string;
+      reviewId: string;
+      productId: string | null;
+      previousStatus?: string | null;
+      changedFields: string[];
+      /** Format: date-time */
+      occurredAt: string;
+      /** @description Internal OmniCommerce workflow provenance when supplied. */
+      source?: string | null;
+      data: {
+        review: components["schemas"]["ReviewWebhookSnapshot"];
+      } & {
+        [key: string]: unknown;
+      };
+    } & {
+      [key: string]: unknown;
+    };
+    ReviewUpdatedWebhookEvent: {
+      /** @description Stable event ID and recipient idempotency key. */
+      eventId: string;
+      /** @constant */
+      eventType: "review.updated";
+      organizationId: string;
+      reviewId: string;
+      productId: string | null;
+      previousStatus?: string | null;
+      changedFields: string[];
+      /** Format: date-time */
+      occurredAt: string;
+      /** @description Internal OmniCommerce workflow provenance when supplied. */
+      source?: string | null;
+      data: {
+        review: components["schemas"]["ReviewWebhookSnapshot"];
+      } & {
+        [key: string]: unknown;
+      };
+    } & {
+      [key: string]: unknown;
+    };
+    ReviewStatusChangedWebhookEvent: {
+      /** @description Stable event ID and recipient idempotency key. */
+      eventId: string;
+      /** @constant */
+      eventType: "review.status.changed";
+      organizationId: string;
+      reviewId: string;
+      productId: string | null;
+      previousStatus?: string | null;
+      changedFields: string[];
+      /** Format: date-time */
+      occurredAt: string;
+      /** @description Internal OmniCommerce workflow provenance when supplied. */
+      source?: string | null;
+      data: {
+        review: components["schemas"]["ReviewWebhookSnapshot"];
+      } & {
+        [key: string]: unknown;
+      };
+    } & {
+      [key: string]: unknown;
+    };
     WebhookMoney: {
       /** @description Decimal monetary amount encoded as a JSON string. */
       amount: string;
@@ -6742,28 +6841,16 @@ interface operations {
           storeId?: string | null;
           /** @description Optional country scope (name or code). Null/omit applies to all countries. */
           country?: string | null;
-          /** @description Optional product source key. Null/omit matches every product. Compared case-insensitively. */
-          sourceKey?: string | null;
-          /**
-           * @description Starting amount for a formula. Ignored when `steps` is empty. Defaults to `list_price`.
-           * @enum {string}
-           */
-          base?: "list_price" | "cost";
-          /**
-           * @description `list_price` rewrites the shelf price. `payout` is calculated and not published. Defaults to `list_price`.
-           * @enum {string}
-           */
-          application?: "list_price" | "payout";
-          /** @description Ordered formula steps. When non-empty, these replace the percent markup. */
-          steps?: Record<string, never>[];
-          /** @description Markup percent applied to canonical list price. Ignored when `steps` is non-empty. */
+          /** @description Markup percent applied to the catalog price. Ignored when `expression` is set. */
           marginValue: number;
+          /** @description Buyer formula. `price` is the catalog price. Supports arithmetic, percentages, CEILING, IF, and CURRENCY(rate, "USD"). Replaces markup percent. */
+          expression?: string | null;
           /**
            * @description Defaults to `currency_minor` when omitted.
            * @enum {string}
            */
           rounding?: "none" | "currency_minor" | "nearest_0_05" | "nearest_1";
-          /** @description ISO 4217 currency. For a percent rule this selects minor-unit rounding. For a formula this is the starting currency. */
+          /** @description Optional ISO 4217 currency for `currency_minor` rounding. */
           currency?: string | null;
           /**
            * @description Whether the rule is active. Defaults to true.
@@ -6956,17 +7043,12 @@ interface operations {
           organizationId?: string;
           storeId?: string | null;
           country?: string | null;
-          sourceKey?: string | null;
-          /** @enum {string} */
-          base?: "list_price" | "cost";
-          /** @enum {string} */
-          application?: "list_price" | "payout";
-          /** @description Ordered formula steps. When non-empty, these replace the percent markup. */
-          steps?: Record<string, never>[];
           marginValue?: number;
           /** @enum {string} */
           rounding?: "none" | "currency_minor" | "nearest_0_05" | "nearest_1";
           currency?: string | null;
+          /** @description Buyer formula. `price` is the catalog price. Null clears the formula and markup percent applies again. */
+          expression?: string | null;
           enabled?: boolean;
         };
       };
@@ -7050,16 +7132,8 @@ interface operations {
             | "zalora"
             | "amazon"
             | "ebay";
-          /** @description Canonical list price, or the list-price starting amount for a formula. */
+          /** @description Canonical list price to mark up. */
           listPrice: number;
-          /** @description Cost used when the matching formula starts from cost. */
-          costPrice?: number;
-          costCurrency?: string | null;
-          sourceKey?: string | null;
-          /** @description Pricing category used by a shipping rate step. */
-          categoryKey?: string | null;
-          /** @enum {string} */
-          application?: "list_price" | "payout";
           storeId?: string | null;
           country?: string | null;
           currency?: string | null;
@@ -7085,12 +7159,18 @@ interface operations {
             /** @enum {string} */
             source: "price_book" | "canonical";
             markupPercent?: number;
+            /** @description Listed currency when known. A buyer formula with CURRENCY sets it. */
+            currency?: string;
+            /** @description Present and true when the buyer formula lists below the catalog price in the same currency. This is usually a payout formula, price * (1 - fees), used where the gross-up, price / (1 - fees), was meant. */
+            belowCatalogPrice?: boolean;
+            /** @description Set when the matched buyer formula cannot price this list price. Publish fails for that listing instead of using the catalog price. */
+            formulaError?: string;
             rule?: Record<string, never> | null;
             message?: string;
           };
         };
       };
-      /** @description Bad Request */
+      /** @description Bad Request, or the forced `ruleId` has a buyer formula that cannot price this list price */
       400: {
         headers: {
           [name: string]: unknown;
@@ -7172,6 +7252,18 @@ interface operations {
         content: {
           "application/json": {
             items?: {
+              /** Format: uuid */
+              id: string;
+              name: string;
+              sku: string | null;
+              /** Format: uuid */
+              parentId: string | null;
+              isVariant: boolean;
+              /** @description Catalog stock in whole units, matching the Products page. Parent rows aggregate non-deleted variants in the same organization; virtual bundles derive stock from components and any manual cap. Null means unknown: never substitute zero for missing or null stock. This is not a sum of marketplace inventory mirrors or a per-location available-to-promise balance. */
+              stockQuantity: number | null;
+              /** @description Whether the product has variants. The list row's stockQuantity already includes their stock; variants are not embedded in this response. */
+              hasVariants: boolean;
+              variantCount: number;
               status?: string;
               /** @description Read-only product-wide state. Lifecycle status and derived quality/error signals are independent; this field is recalculated from current product, marketplace QC, and review flags. */
               statusFacets?: {
@@ -7194,8 +7286,12 @@ interface operations {
             hasMore?: boolean;
             nextOffset?: number;
             summary?: {
+              /** @description All-tab count under the other filters, before applying the selected status. Use pagination.total for the matching result count. */
               totalCount?: number;
-              statusCounts?: Record<string, never>;
+              /** @description Counts by product status under the other selected filters. */
+              statusCounts?: {
+                [key: string]: number;
+              };
             };
             /** @description Echoes the offset/limit actually applied to the query (after clamping) plus discovery metadata for paging. */
             pagination?: {
@@ -8784,8 +8880,8 @@ interface operations {
             | "fail_job";
           autoApproveThreshold?: number | null;
           spendCeilingUsd?: number | null;
-          /** @description Connected store ID for each target marketplace. One store per marketplace, not an array of store IDs. */
-          marketplaceStoreSelections?: {
+          /** @description Required: select at least one connected store. One store per marketplace, not an array of store IDs. */
+          marketplaceStoreSelections: {
             /** @description Connected shopee store ID. */
             shopee?: string;
             /** @description Connected lazada store ID. */
@@ -8856,7 +8952,7 @@ interface operations {
           /** @description JSON object mapping CSV headers to import fields, e.g. `{"sku":"SKU","title":"Product Name"}`. */
           fieldMapping?: string;
           /** @description Connected store ID for each target marketplace. JSON requests send an object; multipart may send that object as a JSON string. */
-          marketplaceStoreSelections?:
+          marketplaceStoreSelections:
             | {
                 /** @description Connected shopee store ID. */
                 shopee?: string;
@@ -9904,6 +10000,12 @@ interface operations {
           variantSku?: string | null;
           /** @default 0 */
           priority?: number;
+          /** @description Optional per-product discount for product discounts and flash sales. Uses the campaign discount type. Null restores the shared discount. Shopee and TikTok publish the resulting price. Lazada vouchers and Shopify fail sync while any product has its own discount. */
+          productDiscounts?: {
+            /** Format: uuid */
+            productId: string;
+            discountValue: number | null;
+          }[];
         };
       };
     };
@@ -10990,6 +11092,9 @@ interface operations {
             | "order.status.changed"
             | "look.created"
             | "look.deleted"
+            | "review.created"
+            | "review.updated"
+            | "review.status.changed"
             | "settlement.created"
             | "settlement.updated"
             | "settlement.status.changed"
@@ -12444,6 +12549,90 @@ interface operations {
       };
     };
   };
+  review_created_webhook: {
+    parameters: {
+      query?: never;
+      header: {
+        "X-Omni-Event-Id": string;
+        "X-Omni-Event-Type": "review.created";
+        "X-Omni-Timestamp": string;
+        /** @description Hex HMAC-SHA256 of `{timestamp}.{rawBody}` using the subscription secret. */
+        "X-Omni-Signature": string;
+      };
+      path?: never;
+      cookie?: never;
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["ReviewCreatedWebhookEvent"];
+      };
+    };
+    responses: {
+      /** @description Event accepted. */
+      "2XX": {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  review_updated_webhook: {
+    parameters: {
+      query?: never;
+      header: {
+        "X-Omni-Event-Id": string;
+        "X-Omni-Event-Type": "review.updated";
+        "X-Omni-Timestamp": string;
+        /** @description Hex HMAC-SHA256 of `{timestamp}.{rawBody}` using the subscription secret. */
+        "X-Omni-Signature": string;
+      };
+      path?: never;
+      cookie?: never;
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["ReviewUpdatedWebhookEvent"];
+      };
+    };
+    responses: {
+      /** @description Event accepted. */
+      "2XX": {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  review_status_changed_webhook: {
+    parameters: {
+      query?: never;
+      header: {
+        "X-Omni-Event-Id": string;
+        "X-Omni-Event-Type": "review.status.changed";
+        "X-Omni-Timestamp": string;
+        /** @description Hex HMAC-SHA256 of `{timestamp}.{rawBody}` using the subscription secret. */
+        "X-Omni-Signature": string;
+      };
+      path?: never;
+      cookie?: never;
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["ReviewStatusChangedWebhookEvent"];
+      };
+    };
+    responses: {
+      /** @description Event accepted. */
+      "2XX": {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
   order_created_webhook: {
     parameters: {
       query?: never;
@@ -13260,6 +13449,8 @@ declare class ProductsClient {
      * List Products
      *
      * 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.
      *
      * `GET /api/v1/products`
      */
@@ -13329,7 +13520,9 @@ declare class ProductsClient {
     /**
      * Delist Product
      *
-     * Queue delist for one product on the marketplaces you name. `marketplaces` accepts one or more of shopee, lazada, tiktok, shopify, whatsapp, zalora, amazon, and ebay. Each named marketplace must already have a listing; other channels are left untouched. Omit `marketplaces` to delist every existing listing. This does not delete the OmniCommerce product. Poll GET /api/v1/jobs/{jobId} until data.status is succeeded, partial, or failed. Accepted means the job was queued, not that the marketplace has removed the listing.
+     * Queue delist for one product on the marketplaces you name. `marketplaces` accepts one or more of shopee, lazada, tiktok, shopify, whatsapp, zalora, amazon, and ebay. Each named marketplace must already have a listing; other channels are left untouched. Omit `marketplaces` to delist every existing listing. This does not delete the OmniCommerce product.
+  
+  Poll GET /api/v1/jobs/{jobId} until data.status is succeeded, partial, or failed. Accepted means the job was queued, not that the marketplace has removed the listing.
      *
      * `POST /api/v1/products/{productId}/delist`
      */
@@ -13852,7 +14045,7 @@ declare function constructEvent(payload: string | Uint8Array, headers: WebhookHe
     toleranceInSeconds?: number;
 }): Promise<ConstructedWebhookEvent>;
 
-declare const SDK_VERSION = "0.1.0";
+declare const SDK_VERSION = "0.1.1";
 
 type ProductCreatedWebhookEvent = components["schemas"]["ProductCreatedWebhookEvent"];
 type ProductUpdatedWebhookEvent = components["schemas"]["ProductUpdatedWebhookEvent"];