@omni-commerce/sdk 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -125,7 +125,11 @@ type OperationBody<Op> = RequestBodyContent<Op> extends never ? undefined : Requ
     "application/x-www-form-urlencoded": infer U;
 } ? U : RequestBodyContent<Op> extends {
     "multipart/form-data": infer M;
-} ? M | FormData : undefined;
+} ? MultipartFields<M> : undefined;
+/** Multipart fields: a binary (string) field also takes a Blob or File. */
+type MultipartFields<T> = {
+    [K in keyof T]: T[K] extends string ? T[K] | Blob : T[K];
+};
 type FlattenedRequest<Op> = OperationPath<Op> & OperationQuery<Op> & (OperationBody<Op> extends undefined ? Record<string, never> : OperationBody<Op>);
 
 declare class OmniError extends Error {
@@ -857,6 +861,48 @@ interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/v1/documents": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Upload Document
+     * @description 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: operations["post_v1_documents"];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/v1/documents/{documentId}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get Document
+     * @description Read one knowledge base document and its indexing status. Requires `documents:read`.
+     */
+    get: operations["get_v1_documents_by_documentid"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/v1/evaluate": {
     parameters: {
       query?: never;
@@ -1547,6 +1593,28 @@ interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/v1/products/{productId}/images": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Upload Product Image
+     * @description 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: operations["post_v1_products_by_productid_images"];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/v1/products/{productId}/inventory": {
     parameters: {
       query?: never;
@@ -1814,7 +1882,7 @@ interface paths {
     patch?: never;
     trace?: never;
   };
-  "/api/v1/promotions/{promotionId}/sync": {
+  "/api/v1/promotions/{promotionId}/retry": {
     parameters: {
       query?: never;
       header?: never;
@@ -1824,10 +1892,12 @@ interface paths {
     get?: never;
     put?: never;
     /**
-     * Sync Promotion to Marketplaces
-     * @description Queue marketplace push for assigned products (Shopee promotion, Lazada Store Flash Sale/voucher/Flexicombo, TikTok activity, or Shopify discount). Requires `promotions:write`.
+     * Retry Marketplace Delivery
+     * @description 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: operations["post_v1_promotions_by_promotionid_sync"];
+    post: operations["post_v1_promotions_by_promotionid_retry"];
     delete?: never;
     options?: never;
     head?: never;
@@ -9495,6 +9565,296 @@ interface operations {
       };
     };
   };
+  post_v1_documents: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody: {
+      content: {
+        "multipart/form-data": {
+          /**
+           * Format: binary
+           * @description The file to upload.
+           */
+          file: string;
+          /** @description Required for session auth. API keys already belong to one organization. */
+          organizationId?: string;
+          /**
+           * @description What the document is. `bank_statement` is never shown to AI.
+           * @default other
+           * @enum {string}
+           */
+          documentType?:
+            | "datasheet"
+            | "invoice"
+            | "packing_list"
+            | "compliance_certificate"
+            | "test_report"
+            | "sds"
+            | "manual"
+            | "warranty"
+            | "authorization_letter"
+            | "shipping_doc"
+            | "regulation"
+            | "policy"
+            | "bank_statement"
+            | "other";
+          /**
+           * Format: uuid
+           * @description Attach the document to one product instead of the whole organization.
+           */
+          productId?: string;
+          /** @description File name to store. Defaults to the uploaded file's name. */
+          fileName?: string;
+        };
+      };
+    };
+    responses: {
+      /** @description The document was stored; indexing is queued. */
+      202: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": {
+            ok: boolean;
+            /** @constant */
+            apiVersion: "developer_v1";
+            operationId: string;
+            /** @enum {string} */
+            status: "accepted" | "completed" | "failed";
+            jobId?: string;
+            productId?: string;
+            warnings: string[];
+            recommendations: string[];
+            links: {
+              [key: string]: string;
+            };
+            data: {
+              document: {
+                id: string;
+                title: string;
+                fileName: string;
+                mimeType: string;
+                sizeBytes: number;
+                /** @enum {string} */
+                documentType:
+                  | "datasheet"
+                  | "invoice"
+                  | "packing_list"
+                  | "compliance_certificate"
+                  | "test_report"
+                  | "sds"
+                  | "manual"
+                  | "warranty"
+                  | "authorization_letter"
+                  | "shipping_doc"
+                  | "regulation"
+                  | "policy"
+                  | "bank_statement"
+                  | "other";
+                productId: string | null;
+                /**
+                 * @description `pending` and `processing` while indexing; `completed` when agents can search it.
+                 * @enum {string}
+                 */
+                status:
+                  | "pending"
+                  | "processing"
+                  | "completed"
+                  | "completed_with_warnings"
+                  | "failed";
+                /** @description Searchable chunks. CSV and Excel are stored for reading but not indexed, so this is 0. */
+                indexedChunkCount: number | null;
+                pageCount: number | null;
+                errorMessage: string | null;
+                createdAt: string;
+                updatedAt: string;
+              };
+              /** @description Indexing was queued. */
+              queued: boolean;
+              warning?: string;
+            };
+          };
+        };
+      };
+      /** @description Invalid request */
+      400: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Unauthorized */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Missing the `documents:write` scope */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Product not found */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description The request body is not multipart or is too large */
+      413: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Rate limit exceeded */
+      429: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Internal Server Error */
+      500: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  get_v1_documents_by_documentid: {
+    parameters: {
+      query?: {
+        /** @description Required for session auth. API keys already belong to one organization. */
+        organizationId?: string;
+      };
+      header?: never;
+      path: {
+        documentId: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description The document. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": {
+            ok: boolean;
+            /** @constant */
+            apiVersion: "developer_v1";
+            operationId: string;
+            /** @enum {string} */
+            status: "accepted" | "completed" | "failed";
+            jobId?: string;
+            productId?: string;
+            warnings: string[];
+            recommendations: string[];
+            links: {
+              [key: string]: string;
+            };
+            data: {
+              document: {
+                id: string;
+                title: string;
+                fileName: string;
+                mimeType: string;
+                sizeBytes: number;
+                /** @enum {string} */
+                documentType:
+                  | "datasheet"
+                  | "invoice"
+                  | "packing_list"
+                  | "compliance_certificate"
+                  | "test_report"
+                  | "sds"
+                  | "manual"
+                  | "warranty"
+                  | "authorization_letter"
+                  | "shipping_doc"
+                  | "regulation"
+                  | "policy"
+                  | "bank_statement"
+                  | "other";
+                productId: string | null;
+                /**
+                 * @description `pending` and `processing` while indexing; `completed` when agents can search it.
+                 * @enum {string}
+                 */
+                status:
+                  | "pending"
+                  | "processing"
+                  | "completed"
+                  | "completed_with_warnings"
+                  | "failed";
+                /** @description Searchable chunks. CSV and Excel are stored for reading but not indexed, so this is 0. */
+                indexedChunkCount: number | null;
+                pageCount: number | null;
+                errorMessage: string | null;
+                createdAt: string;
+                updatedAt: string;
+              };
+            };
+          };
+        };
+      };
+      /** @description Invalid request */
+      400: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Unauthorized */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Missing the `documents:read` scope */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Document not found */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Rate limit exceeded */
+      429: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Internal Server Error */
+      500: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
   post_v1_evaluate: {
     parameters: {
       query?: never;
@@ -13570,6 +13930,117 @@ interface operations {
       };
     };
   };
+  post_v1_products_by_productid_images: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        productId: string;
+      };
+      cookie?: never;
+    };
+    requestBody: {
+      content: {
+        "multipart/form-data": {
+          /**
+           * Format: binary
+           * @description The image file.
+           */
+          file: string;
+          /** @description Required for session auth. API keys already belong to one organization. */
+          organizationId?: string;
+          /** @description Zero-based place in the gallery; 0 makes it the main image. Defaults to the end. */
+          position?: number;
+        };
+      };
+    };
+    responses: {
+      /** @description The image was added to the gallery. */
+      201: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": {
+            ok: boolean;
+            /** @constant */
+            apiVersion: "developer_v1";
+            operationId: string;
+            /** @enum {string} */
+            status: "accepted" | "completed" | "failed";
+            jobId?: string;
+            productId?: string;
+            warnings: string[];
+            recommendations: string[];
+            links: {
+              [key: string]: string;
+            };
+            data: {
+              image: {
+                /** @description Public URL of the stored image. */
+                url: string;
+                position: number;
+              };
+              /** @description The product's gallery after the upload, in order. */
+              images: {
+                url: string;
+                position: number;
+              }[];
+            };
+          };
+        };
+      };
+      /** @description Invalid request */
+      400: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Unauthorized */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Missing the `catalog:write` scope */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Product not found */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description The request body is not multipart or is too large */
+      413: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Rate limit exceeded */
+      429: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Internal Server Error */
+      500: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
   patch_v1_products_by_productid_inventory: {
     parameters: {
       query?: never;
@@ -15503,7 +15974,7 @@ interface operations {
       };
     };
   };
-  post_v1_promotions_by_promotionid_sync: {
+  post_v1_promotions_by_promotionid_retry: {
     parameters: {
       query?: {
         /** @description Optional organization scope for session-authenticated calls. OAuth client credentials resolve the organization from the token. */
@@ -15525,7 +15996,7 @@ interface operations {
         "application/json": {
           organizationId?: string;
           /**
-           * @description Optional single marketplace. When omitted, syncs all promotion marketplaces.
+           * @description Retry one marketplace. When omitted, retries every promotion marketplace.
            * @enum {string}
            */
           marketplace?:
@@ -15536,13 +16007,13 @@ interface operations {
             | "amazon"
             | "zalora"
             | "ebay";
-          /** @description Optional product subset. When omitted, syncs all assigned products. */
+          /** @description Retry only these products. When omitted, retries every assigned product. */
           productIds?: string[];
         };
       };
     };
     responses: {
-      /** @description Sync queued. */
+      /** @description Delivery queued again. */
       202: {
         headers: {
           [name: string]: unknown;
@@ -19172,6 +19643,28 @@ declare class DirectoryClient {
      */
     list(requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["get_v1_directory"]>>;
 }
+declare class DocumentsClient {
+    protected readonly _http: OmniHttp;
+    constructor(_http: OmniHttp);
+    /**
+     * 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: OperationBody<operations["post_v1_documents"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["post_v1_documents"]>>;
+    /**
+     * Get Document
+     *
+     * Read one knowledge base document and its indexing status. Requires `documents:read`.
+     *
+     * `GET /api/v1/documents/{documentId}`
+     */
+    get(request: OperationPath<operations["get_v1_documents_by_documentid"]> & OperationQuery<operations["get_v1_documents_by_documentid"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["get_v1_documents_by_documentid"]>>;
+}
 declare class EvaluateClient {
     protected readonly _http: OmniHttp;
     constructor(_http: OmniHttp);
@@ -19633,6 +20126,16 @@ declare class ProductsClient {
      * `POST /api/v1/products/{productId}/delist`
      */
     delist(request: OperationPath<operations["post_v1_products_by_productid_delist"]> & OperationBody<operations["post_v1_products_by_productid_delist"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["post_v1_products_by_productid_delist"]>>;
+    /**
+     * 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: OperationPath<operations["post_v1_products_by_productid_images"]> & OperationBody<operations["post_v1_products_by_productid_images"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["post_v1_products_by_productid_images"]>>;
     /**
      * Update Product Inventory
      *
@@ -19805,13 +20308,15 @@ declare class PromotionsClient {
      */
     addProducts(request: OperationPath<operations["post_v1_promotions_by_promotionid_products"]> & OperationQuery<operations["post_v1_promotions_by_promotionid_products"]> & OperationBody<operations["post_v1_promotions_by_promotionid_products"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["post_v1_promotions_by_promotionid_products"]>>;
     /**
-     * Sync Promotion to Marketplaces
+     * Retry Marketplace Delivery
      *
-     * Queue marketplace push for assigned products (Shopee promotion, Lazada Store Flash Sale/voucher/Flexicombo, TikTok activity, or Shopify discount). Requires `promotions:write`.
+     * 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}/sync`
+     * `POST /api/v1/promotions/{promotionId}/retry`
      */
-    sync(request: OperationPath<operations["post_v1_promotions_by_promotionid_sync"]> & OperationQuery<operations["post_v1_promotions_by_promotionid_sync"]> & OperationBody<operations["post_v1_promotions_by_promotionid_sync"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["post_v1_promotions_by_promotionid_sync"]>>;
+    retry(request: OperationPath<operations["post_v1_promotions_by_promotionid_retry"]> & OperationQuery<operations["post_v1_promotions_by_promotionid_retry"]> & OperationBody<operations["post_v1_promotions_by_promotionid_retry"]>, requestOptions?: BaseRequestOptions): HttpResponsePromise<SuccessData<operations["post_v1_promotions_by_promotionid_retry"]>>;
 }
 declare class ReturnsClient {
     protected readonly _http: OmniHttp;
@@ -20105,6 +20610,7 @@ declare class OmniGeneratedClient {
     readonly checkoutSessions: CheckoutSessionsClient;
     readonly compare: CompareClient;
     readonly directory: DirectoryClient;
+    readonly documents: DocumentsClient;
     readonly evaluate: EvaluateClient;
     readonly feed: FeedClient;
     readonly images: ImagesClient;
@@ -20141,6 +20647,7 @@ type OmniResources = {
     checkoutSessions: CheckoutSessionsClient;
     compare: CompareClient;
     directory: DirectoryClient;
+    documents: DocumentsClient;
     evaluate: EvaluateClient;
     feed: FeedClient;
     images: ImagesClient;
@@ -20209,7 +20716,7 @@ declare function constructEvent(payload: string | Uint8Array, headers: WebhookHe
     toleranceInSeconds?: number;
 }): Promise<ConstructedWebhookEvent>;
 
-declare const SDK_VERSION = "0.4.0";
+declare const SDK_VERSION = "0.5.0";
 
 type ProductCreatedWebhookEvent = components["schemas"]["ProductCreatedWebhookEvent"];
 type ProductUpdatedWebhookEvent = components["schemas"]["ProductUpdatedWebhookEvent"];