@omni-commerce/sdk 0.5.0 → 0.6.0

package/dist/index.d.cts

@@ -583,6 +583,38 @@ interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/v1/brandsgateway/import": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Import BrandsGateway Products
+     * @description Requires catalog:write and a connected BrandsGateway account. Uses the same parameters and import service as the import_brandsgateway_products tool.
+     *
+     *     ### Selection
+     *
+     *     Choose catalogProductIds or importAllMatching with filters. maxProducts limits new imports to 1–50 across pages (default 50); already imported products are skipped. Numeric brandIds, vendorIds (supplier warehouses), categoryIds, and conditionIds arrays match any value within each field and all supplied fields together. Omit a field for no restriction; empty arrays and legacy singular/string filters are rejected. Brands accept at most 500 IDs; other filter arrays accept at most 50 each. Broad combinations may exceed the supplier request budget and return a failure asking you to narrow the filters.
+     *
+     *     ### Updated dates and enrichment
+     *
+     *     updatedAtMin and updatedAtMax map to the supplier updated_at_min and updated_at_max filters; dates use midnight UTC. There is no creation-date sorting. Products import as drafts. Connected marketplace selections and country apply to the entire import. Enrichment and taxonomy are queued according to the organization's BrandsGateway preferences; any AI usage is billed to that organization. This endpoint does not publish listings.
+     *
+     *     ### Result
+     *
+     *     Returns HTTP 200 when the import attempt finishes, including partial failures. Inspect ok, data.success, counts, results, and data.error; failed or partial imports have ok=false and status=failed. Enrichment may still be running when data.enrichmentQueued=true.
+     */
+    post: operations["post_v1_brandsgateway_import"];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/v1/campaigns": {
     parameters: {
       query?: never;
@@ -6687,6 +6719,163 @@ interface operations {
       };
     };
   };
+  post_v1_brandsgateway_import: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody: {
+      content: {
+        /**
+         * @example {
+         *       "importAllMatching": true,
+         *       "maxProducts": 10,
+         *       "filters": {
+         *         "categoryIds": [
+         *           71816
+         *         ],
+         *         "vendorIds": [
+         *           73680
+         *         ],
+         *         "brandIds": [
+         *           68571,
+         *           615
+         *         ],
+         *         "updatedAtMin": "2026-10-01"
+         *       }
+         *     }
+         */
+        "application/json": {
+          /** @description BrandsGateway catalog product IDs (supplier numbers, not Omni product IDs). Trimmed and de-duplicated while preserving order. Max 50. */
+          catalogProductIds?: number[];
+          /** @description Import up to maxProducts products matching filters instead of an explicit catalogProductIds list (defaults to 50). */
+          importAllMatching?: boolean;
+          /** @description Maximum products to import in this call (1–50, defaults to 50). Applied across all matching catalog pages. An explicit catalogProductIds selection cannot exceed this limit after deduplication. */
+          maxProducts?: number;
+          /** @description Catalog product IDs to skip when importAllMatching is true. */
+          excludedProductIds?: number[];
+          /** @description Listing filters when importAllMatching is true. Numeric ID arrays match any ID within each field, and all supplied fields must match. Omit a field to leave it unrestricted. */
+          filters?: {
+            q?: string;
+            /** @description Numeric brand IDs. Match any selected brand. Max 500; duplicates removed in first-requested order. */
+            brandIds?: number[];
+            /** @description Numeric warehouse/vendor IDs. Match any selected warehouse. Max 50; duplicates removed in first-requested order. */
+            vendorIds?: number[];
+            /** @description Numeric category IDs. Match any selected category. Max 50; duplicates removed in first-requested order. */
+            categoryIds?: number[];
+            /** @description Numeric product-condition IDs. Match any selected condition. Max 50; duplicates removed in first-requested order. */
+            conditionIds?: number[];
+            /** @constant */
+            stock?: "instock";
+            priceMin?: string;
+            priceMax?: string;
+            /** @enum {string} */
+            imported?: "not_imported" | "imported" | "all";
+            /** @description Supplier updated_at_min: only products last updated after this ISO date or date-time. Date-only values mean midnight UTC; offset date-times are converted to UTC. */
+            updatedAtMin?: string;
+            /** @description Supplier updated_at_max: only products last updated before this ISO date or date-time. Date-only values mean midnight UTC; offset date-times are converted to UTC. */
+            updatedAtMax?: string;
+          };
+          /** @description Connected marketplaces to assign on import. Taxonomy enrichment uses taxonomy-capable stores from this list. */
+          targetMarketplaces?: string[];
+          /** @description Connected store ID keyed by marketplace. */
+          marketplaceStoreSelections?: {
+            [key: string]: string;
+          };
+          /** @description Shared country for the selected import stores. */
+          country?: string;
+          /** @description Required for session auth; derived from the credential for bearer auth. */
+          organizationId?: string;
+        };
+      };
+    };
+    responses: {
+      /** @description Import attempt finished. Inspect success and per-product results, including partial failures. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": {
+            ok: boolean;
+            apiVersion: string;
+            operationId: string;
+            /** @enum {string} */
+            status: "completed" | "failed";
+            data: {
+              success: boolean;
+              catalogProductIds: number[];
+              importedProductIds: string[];
+              importAllMatching: boolean;
+              succeededCount: number;
+              failedCount: number;
+              skippedCount: number;
+              results: {
+                catalogProductId?: number;
+                productId?: string;
+                success: boolean;
+                skipped?: boolean;
+                error?: string;
+              }[];
+              runEnrichment: boolean;
+              /** @description True when this import queued listing enrichment and taxonomy for importedProductIds. Do not call product_enrichment_tool again for those ids. */
+              enrichmentQueued: boolean;
+              taxonomyAssignments: {
+                marketplace: string;
+                storeId: string;
+                storeName: string;
+                country: string;
+              }[];
+              error?: string;
+            };
+            error?: string;
+            links?: {
+              [key: string]: string;
+            };
+            warnings?: string[];
+            recommendations?: string[];
+          };
+        };
+      };
+      /** @description Invalid request, including nonnumeric IDs or an invalid quantity. */
+      400: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Missing or invalid credentials. */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Missing catalog:write scope, insufficient permission, organization mismatch, or inactive organization. */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Rate limit exceeded. */
+      429: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Unexpected import failure. */
+      500: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
   get_v1_campaigns: {
     parameters: {
       query?: {
@@ -19485,6 +19674,24 @@ declare class AopClient {
      */
     retry(request: OperationBody<operations["post_v1_aop_retry"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["post_v1_aop_retry"]>>;
 }
+declare class BrandsgatewayClient {
+    protected readonly _http: OmniHttp;
+    constructor(_http: OmniHttp);
+    /**
+     * Import BrandsGateway Products
+     *
+     * Requires catalog:write and a connected BrandsGateway account. Uses the same parameters and import service as the import_brandsgateway_products tool.
+  
+  ### Selection
+  
+  Choose catalogProductIds or importAllMatching with filters. maxProducts limits new imports to 1–50 across pages (default 50); already imported products are skipped. Numeric brandIds, vendorIds (supplier warehouses), categoryIds, and conditionIds arrays match any value within each field and all supplied fields together. Omit a field for no restriction; empty arrays and legacy singular/string filters are rejected. Brands accept at most 500 IDs; other filter arrays accept at most 50 each. Broad combinations may exceed the supplier request budget and return a failure asking you to narrow the filters.
+  
+  ### Updated dates and enrichme
+     *
+     * `POST /api/v1/brandsgateway/import`
+     */
+    importProducts(request: OperationBody<operations["post_v1_brandsgateway_import"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["post_v1_brandsgateway_import"]>>;
+}
 declare class CampaignsClient {
     protected readonly _http: OmniHttp;
     constructor(_http: OmniHttp);
@@ -20605,6 +20812,7 @@ declare class OmniGeneratedClient {
     readonly agents: AgentsClient;
     readonly analytics: AnalyticsClient;
     readonly aop: AopClient;
+    readonly brandsgateway: BrandsgatewayClient;
     readonly campaigns: CampaignsClient;
     readonly catalog: CatalogClient;
     readonly checkoutSessions: CheckoutSessionsClient;
@@ -20642,6 +20850,7 @@ type OmniResources = {
     agents: AgentsClient;
     analytics: AnalyticsClient;
     aop: AopClient;
+    brandsgateway: BrandsgatewayClient;
     campaigns: CampaignsClient;
     catalog: CatalogClient;
     checkoutSessions: CheckoutSessionsClient;
@@ -20716,7 +20925,7 @@ declare function constructEvent(payload: string | Uint8Array, headers: WebhookHe
     toleranceInSeconds?: number;
 }): Promise<ConstructedWebhookEvent>;
 
-declare const SDK_VERSION = "0.5.0";
+declare const SDK_VERSION = "0.6.0";
 
 type ProductCreatedWebhookEvent = components["schemas"]["ProductCreatedWebhookEvent"];
 type ProductUpdatedWebhookEvent = components["schemas"]["ProductUpdatedWebhookEvent"];

package/dist/index.d.ts

@@ -583,6 +583,38 @@ interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/v1/brandsgateway/import": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Import BrandsGateway Products
+     * @description Requires catalog:write and a connected BrandsGateway account. Uses the same parameters and import service as the import_brandsgateway_products tool.
+     *
+     *     ### Selection
+     *
+     *     Choose catalogProductIds or importAllMatching with filters. maxProducts limits new imports to 1–50 across pages (default 50); already imported products are skipped. Numeric brandIds, vendorIds (supplier warehouses), categoryIds, and conditionIds arrays match any value within each field and all supplied fields together. Omit a field for no restriction; empty arrays and legacy singular/string filters are rejected. Brands accept at most 500 IDs; other filter arrays accept at most 50 each. Broad combinations may exceed the supplier request budget and return a failure asking you to narrow the filters.
+     *
+     *     ### Updated dates and enrichment
+     *
+     *     updatedAtMin and updatedAtMax map to the supplier updated_at_min and updated_at_max filters; dates use midnight UTC. There is no creation-date sorting. Products import as drafts. Connected marketplace selections and country apply to the entire import. Enrichment and taxonomy are queued according to the organization's BrandsGateway preferences; any AI usage is billed to that organization. This endpoint does not publish listings.
+     *
+     *     ### Result
+     *
+     *     Returns HTTP 200 when the import attempt finishes, including partial failures. Inspect ok, data.success, counts, results, and data.error; failed or partial imports have ok=false and status=failed. Enrichment may still be running when data.enrichmentQueued=true.
+     */
+    post: operations["post_v1_brandsgateway_import"];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/v1/campaigns": {
     parameters: {
       query?: never;
@@ -6687,6 +6719,163 @@ interface operations {
       };
     };
   };
+  post_v1_brandsgateway_import: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody: {
+      content: {
+        /**
+         * @example {
+         *       "importAllMatching": true,
+         *       "maxProducts": 10,
+         *       "filters": {
+         *         "categoryIds": [
+         *           71816
+         *         ],
+         *         "vendorIds": [
+         *           73680
+         *         ],
+         *         "brandIds": [
+         *           68571,
+         *           615
+         *         ],
+         *         "updatedAtMin": "2026-10-01"
+         *       }
+         *     }
+         */
+        "application/json": {
+          /** @description BrandsGateway catalog product IDs (supplier numbers, not Omni product IDs). Trimmed and de-duplicated while preserving order. Max 50. */
+          catalogProductIds?: number[];
+          /** @description Import up to maxProducts products matching filters instead of an explicit catalogProductIds list (defaults to 50). */
+          importAllMatching?: boolean;
+          /** @description Maximum products to import in this call (1–50, defaults to 50). Applied across all matching catalog pages. An explicit catalogProductIds selection cannot exceed this limit after deduplication. */
+          maxProducts?: number;
+          /** @description Catalog product IDs to skip when importAllMatching is true. */
+          excludedProductIds?: number[];
+          /** @description Listing filters when importAllMatching is true. Numeric ID arrays match any ID within each field, and all supplied fields must match. Omit a field to leave it unrestricted. */
+          filters?: {
+            q?: string;
+            /** @description Numeric brand IDs. Match any selected brand. Max 500; duplicates removed in first-requested order. */
+            brandIds?: number[];
+            /** @description Numeric warehouse/vendor IDs. Match any selected warehouse. Max 50; duplicates removed in first-requested order. */
+            vendorIds?: number[];
+            /** @description Numeric category IDs. Match any selected category. Max 50; duplicates removed in first-requested order. */
+            categoryIds?: number[];
+            /** @description Numeric product-condition IDs. Match any selected condition. Max 50; duplicates removed in first-requested order. */
+            conditionIds?: number[];
+            /** @constant */
+            stock?: "instock";
+            priceMin?: string;
+            priceMax?: string;
+            /** @enum {string} */
+            imported?: "not_imported" | "imported" | "all";
+            /** @description Supplier updated_at_min: only products last updated after this ISO date or date-time. Date-only values mean midnight UTC; offset date-times are converted to UTC. */
+            updatedAtMin?: string;
+            /** @description Supplier updated_at_max: only products last updated before this ISO date or date-time. Date-only values mean midnight UTC; offset date-times are converted to UTC. */
+            updatedAtMax?: string;
+          };
+          /** @description Connected marketplaces to assign on import. Taxonomy enrichment uses taxonomy-capable stores from this list. */
+          targetMarketplaces?: string[];
+          /** @description Connected store ID keyed by marketplace. */
+          marketplaceStoreSelections?: {
+            [key: string]: string;
+          };
+          /** @description Shared country for the selected import stores. */
+          country?: string;
+          /** @description Required for session auth; derived from the credential for bearer auth. */
+          organizationId?: string;
+        };
+      };
+    };
+    responses: {
+      /** @description Import attempt finished. Inspect success and per-product results, including partial failures. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": {
+            ok: boolean;
+            apiVersion: string;
+            operationId: string;
+            /** @enum {string} */
+            status: "completed" | "failed";
+            data: {
+              success: boolean;
+              catalogProductIds: number[];
+              importedProductIds: string[];
+              importAllMatching: boolean;
+              succeededCount: number;
+              failedCount: number;
+              skippedCount: number;
+              results: {
+                catalogProductId?: number;
+                productId?: string;
+                success: boolean;
+                skipped?: boolean;
+                error?: string;
+              }[];
+              runEnrichment: boolean;
+              /** @description True when this import queued listing enrichment and taxonomy for importedProductIds. Do not call product_enrichment_tool again for those ids. */
+              enrichmentQueued: boolean;
+              taxonomyAssignments: {
+                marketplace: string;
+                storeId: string;
+                storeName: string;
+                country: string;
+              }[];
+              error?: string;
+            };
+            error?: string;
+            links?: {
+              [key: string]: string;
+            };
+            warnings?: string[];
+            recommendations?: string[];
+          };
+        };
+      };
+      /** @description Invalid request, including nonnumeric IDs or an invalid quantity. */
+      400: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Missing or invalid credentials. */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Missing catalog:write scope, insufficient permission, organization mismatch, or inactive organization. */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Rate limit exceeded. */
+      429: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Unexpected import failure. */
+      500: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
   get_v1_campaigns: {
     parameters: {
       query?: {
@@ -19485,6 +19674,24 @@ declare class AopClient {
      */
     retry(request: OperationBody<operations["post_v1_aop_retry"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["post_v1_aop_retry"]>>;
 }
+declare class BrandsgatewayClient {
+    protected readonly _http: OmniHttp;
+    constructor(_http: OmniHttp);
+    /**
+     * Import BrandsGateway Products
+     *
+     * Requires catalog:write and a connected BrandsGateway account. Uses the same parameters and import service as the import_brandsgateway_products tool.
+  
+  ### Selection
+  
+  Choose catalogProductIds or importAllMatching with filters. maxProducts limits new imports to 1–50 across pages (default 50); already imported products are skipped. Numeric brandIds, vendorIds (supplier warehouses), categoryIds, and conditionIds arrays match any value within each field and all supplied fields together. Omit a field for no restriction; empty arrays and legacy singular/string filters are rejected. Brands accept at most 500 IDs; other filter arrays accept at most 50 each. Broad combinations may exceed the supplier request budget and return a failure asking you to narrow the filters.
+  
+  ### Updated dates and enrichme
+     *
+     * `POST /api/v1/brandsgateway/import`
+     */
+    importProducts(request: OperationBody<operations["post_v1_brandsgateway_import"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["post_v1_brandsgateway_import"]>>;
+}
 declare class CampaignsClient {
     protected readonly _http: OmniHttp;
     constructor(_http: OmniHttp);
@@ -20605,6 +20812,7 @@ declare class OmniGeneratedClient {
     readonly agents: AgentsClient;
     readonly analytics: AnalyticsClient;
     readonly aop: AopClient;
+    readonly brandsgateway: BrandsgatewayClient;
     readonly campaigns: CampaignsClient;
     readonly catalog: CatalogClient;
     readonly checkoutSessions: CheckoutSessionsClient;
@@ -20642,6 +20850,7 @@ type OmniResources = {
     agents: AgentsClient;
     analytics: AnalyticsClient;
     aop: AopClient;
+    brandsgateway: BrandsgatewayClient;
     campaigns: CampaignsClient;
     catalog: CatalogClient;
     checkoutSessions: CheckoutSessionsClient;
@@ -20716,7 +20925,7 @@ declare function constructEvent(payload: string | Uint8Array, headers: WebhookHe
     toleranceInSeconds?: number;
 }): Promise<ConstructedWebhookEvent>;
 
-declare const SDK_VERSION = "0.5.0";
+declare const SDK_VERSION = "0.6.0";
 
 type ProductCreatedWebhookEvent = components["schemas"]["ProductCreatedWebhookEvent"];
 type ProductUpdatedWebhookEvent = components["schemas"]["ProductUpdatedWebhookEvent"];

package/dist/index.js

@@ -24,7 +24,7 @@ function normalizeClientOptions(options = {}) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.5.0";
+var SDK_VERSION = "0.6.0";
 var SDK_USER_AGENT = `omnicommerce-js/${SDK_VERSION}`;
 
 // src/environments.ts
@@ -1098,6 +1098,35 @@ var AopClient = class {
     });
   }
 };
+var BrandsgatewayClient = class {
+  constructor(_http) {
+    this._http = _http;
+  }
+  _http;
+  /**
+     * Import BrandsGateway Products
+     *
+     * Requires catalog:write and a connected BrandsGateway account. Uses the same parameters and import service as the import_brandsgateway_products tool.
+  
+  ### Selection
+  
+  Choose catalogProductIds or importAllMatching with filters. maxProducts limits new imports to 1–50 across pages (default 50); already imported products are skipped. Numeric brandIds, vendorIds (supplier warehouses), categoryIds, and conditionIds arrays match any value within each field and all supplied fields together. Omit a field for no restriction; empty arrays and legacy singular/string filters are rejected. Brands accept at most 500 IDs; other filter arrays accept at most 50 each. Broad combinations may exceed the supplier request budget and return a failure asking you to narrow the filters.
+  
+  ### Updated dates and enrichme
+     *
+     * `POST /api/v1/brandsgateway/import`
+     */
+  importProducts(request, requestOptions) {
+    const { ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: "/api/v1/brandsgateway/import",
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+};
 var CampaignsClient = class {
   constructor(_http) {
     this._http = _http;
@@ -3387,6 +3416,7 @@ var OmniGeneratedClient = class {
     this.agents = new AgentsClient(this._http);
     this.analytics = new AnalyticsClient(this._http);
     this.aop = new AopClient(this._http);
+    this.brandsgateway = new BrandsgatewayClient(this._http);
     this.campaigns = new CampaignsClient(this._http);
     this.catalog = new CatalogClient(this._http);
     this.checkoutSessions = new CheckoutSessionsClient(this._http);
@@ -3423,6 +3453,7 @@ var OmniGeneratedClient = class {
   agents;
   analytics;
   aop;
+  brandsgateway;
   campaigns;
   catalog;
   checkoutSessions;