vviinn-widgets 2.40.2 → 2.40.3

package/dist/types/interfaces/generated.d.ts

@@ -0,0 +1,869 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+  "/products": {
+    /** Returns all products which has at least one image */
+    get: operations["GetProducts"];
+  };
+  "/category-tree": {
+    /** Save or publish the categoryTree */
+    put: operations["SaveCategoryTree"];
+  };
+  "/product/{product-id}/annotation": {
+    /** Save or publish the product */
+    put: operations["SaveProduct"];
+  };
+  "/product/{product-id}/similar-products": {
+    /** Return most similar products to input one */
+    get: operations["GetSimilarProductsToInputImage"];
+  };
+  "/product/{product-id}/similar-products/{category}": {
+    /** Return most similar products to input one in specific category */
+    get: operations["GetSimilarProductsToInputImageInSpecificCategory"];
+  };
+  "/product/{product-id}/cross-selling-products": {
+    /** Return cross selling products to input one */
+    get: operations["GetCrossSellingProductsToInputImage"];
+  };
+  "/product/{product-id}/cross-selling-products/{category}": {
+    /** Return cross selling products to input one in specific category */
+    get: operations["GetCrossSellingProductsToInputImageInSpecificCategory"];
+  };
+  "/image/{image-id}": {
+    /** Deletes all images from a site on a given image id */
+    delete: operations["DeleteImageById"];
+  };
+  "/product/{product-id}/full": {
+    /** Deletes product and its images from a site on a given product id */
+    delete: operations["DeleteFullProduct"];
+    parameters: {
+      path: {
+        "product-id": string;
+      };
+    };
+  };
+  "/product/{product-id}": {
+    /** Deletes all images from a site on a given product id */
+    delete: operations["DeleteImageByProductId"];
+    parameters: {
+      path: {
+        "product-id": string;
+      };
+    };
+  };
+  "/product/{product-id}/image/{image-id}": {
+    /** Upload image directly to catalog and trigger feature extraction */
+    put: operations["AddImage"];
+    /** Deletes all images from a site on given product and image ids */
+    delete: operations["DeleteImageByImageIdAndProductId"];
+  };
+  "/search/session": {
+    /** Starts a reusable search session for a one image. */
+    post: operations["CreateSearchSession"];
+  };
+  "/search/session/{search-id}": {
+    /** Starts a search in existing session. */
+    get: operations["SearchInExistingSession"];
+  };
+  "/search/session/{search-id}/category/{category}": {
+    /** Starts a search in existing session in specific category. */
+    get: operations["SearchInExistingSessionWithCategory"];
+  };
+  "/search/session/{search-id}/detect-objects": {
+    /** Get detected objects of image in existing session. */
+    get: operations["DetectObjectsOfImageInExistingSession"];
+  };
+  "/search/session/{search-id}/upload-image": {
+    /** Upload high resolution image to existing session. */
+    put: operations["UploadHighResolutionImageToExistingSession"];
+  };
+}
+export interface components {
+  schemas: {
+    "ion-detected-object-rectangle": {
+      left?: number;
+      top?: number;
+      width?: number;
+      height?: number;
+    };
+    "ion-detected-object-value": {
+      classId?: number;
+      class?: string;
+      score?: number;
+      rectangle?: components["schemas"]["ion-detected-object-rectangle"];
+    };
+    "ion-detected-object": {
+      value?: components["schemas"]["ion-detected-object-value"];
+      links?: {
+        [key: string]: components["schemas"]["ion-link"];
+      };
+    };
+    "ion-detected-objects": {
+      value?: components["schemas"]["ion-detected-object"][];
+    };
+    "delete-image-by-productId-and-imageId-404-error": {
+      "site-id"?: number;
+      "product-id"?: string;
+      "image-id"?: string;
+    };
+    "delete-image-by-productId-and-imageId-400-error": {
+      siteId?: number;
+      imageCode?: string;
+      productCode?: string;
+    };
+    "delete-image-error": {
+      "site-id"?: number;
+      "image-id"?: string;
+    };
+    "delete-image-by-imageId": {
+      "site-id"?: number;
+      "number-of-products"?: number;
+      "image-id"?: string;
+    };
+    "image-by-productId-and-imageId": {
+      "site-id"?: number;
+      "product-id"?: string;
+      "image-id"?: string;
+      url?: string;
+    };
+    "delete-product-images-by-productId": {
+      "site-id"?: number;
+      "product-id"?: string;
+      "image-ids"?: unknown[];
+    };
+    "product-data": {
+      title: string;
+      description?: string;
+      link?: string;
+      availability?: "in_stock" | "out_of_stock" | "preorder" | "backorder";
+      availability_date?: string;
+      cost_of_goods_sold?: string;
+      expiration_date?: string;
+      price?: number;
+      sale_price?: number;
+      sale_price_effective_date?: string;
+      unit_pricing_measure?: string;
+      unit_pricing_base_measure?: string;
+      installment?: string;
+      subscription_cost?: string;
+      loyalty_points?: string;
+      google_product_category?: string;
+      product_type?: string;
+      brand?: string;
+      gtin?: string;
+      mpn?: string;
+      identifier_exists?: boolean;
+      condition?: "new" | "refurbished" | "used";
+      adult?: boolean;
+      multipack?: number;
+      is_bundle?: boolean;
+      energy_efficiency_class?: "A+++" | "A++" | "A+" | "A" | "B" | "C" | "D" | "E" | "F" | "G";
+      min_energy_efficiency_class?: "A+++" | "A++" | "A+" | "A" | "B" | "C" | "D" | "E" | "F" | "G";
+      max_energy_efficiency_class?: "A+++" | "A++" | "A+" | "A" | "B" | "C" | "D" | "E" | "F" | "G";
+      age_group?: "newborn" | "infant" | "toddler" | "kids" | "adult";
+      color?: string;
+      gender?: "male" | "female" | "unisex";
+      material?: string;
+      pattern?: string;
+      size?: string;
+      size_type?: "regular" | "petite" | "tall" | "plus" | "big" | "maternity";
+      size_system?: "AU" | "BR" | "CN" | "DE" | "EU" | "FR" | "IT" | "JP" | "MEX" | "UK" | "US";
+      item_group_id?: string;
+      ads_redirect?: string;
+      custom_label_0?: string;
+      custom_label_1?: string;
+      custom_label_2?: string;
+      custom_label_3?: string;
+      custom_label_4?: string;
+      promotion_id?: string;
+      excluded_destination?: "Shopping_ads" | "Buy_on_Google_listings" | "Display_ads" | "Local_inventory_ads" | "Free_listings" | "Free_local_listings";
+      included_destination?: "Shopping_ads" | "Buy_on_Google_listings" | "Display_ads" | "Local_inventory_ads" | "Free_listings" | "Free_local_listings";
+      shipping?: string;
+      shipping_label?: string;
+      shipping_weight?: string;
+      shipping_length?: string;
+      shipping_width?: string;
+      shipping_height?: string;
+      transit_time_label?: string;
+      max_handling_time?: string;
+      min_handling_time?: string;
+      tax?: string;
+      tax_category?: string;
+      product_detail?: string;
+      shopping_ads_excluded_country?: string;
+      product_highlight?: string;
+      categories?: unknown[];
+    };
+    product: {
+      "site-id"?: number;
+      "product-id"?: string;
+      data?: components["schemas"]["product-data"];
+    };
+    "product-annotation": {
+      message: string;
+      data: components["schemas"]["product"];
+    }[];
+    "product-annotation-images": {
+      url?: string;
+    };
+    "product-annotation-error": {
+      message: string;
+      data: components["schemas"]["product"];
+      debug?: string;
+    }[];
+    "category-tree": {
+      id: string;
+      title: string;
+      parentId: string;
+    }[];
+    products: {
+      productIds?: unknown[];
+    };
+    "visual-product-search-object": {
+      groupId?: string | null;
+      productId?: string;
+      title?: string;
+      /** link to the product detail page */
+      deeplink?: string | null;
+      brand?: string | null;
+      productType?: string | null;
+      image?: {
+        original?: string;
+        thumbnail?: string | null;
+      };
+      price?: {
+        actual?: number | null;
+        sale?: number | null;
+      };
+    };
+    "category-filter": components["schemas"]["ion-link"] & {
+      name: string;
+    };
+    "name-value-item": {
+      name: string;
+      value: string;
+    };
+    "ion-link": {
+      method: string;
+      href: string;
+    };
+    "search-area": components["schemas"]["ion-link"] & {
+      rel: string[];
+      value: components["schemas"]["name-value-item"][];
+    };
+    "upload-high-resolution-image": components["schemas"]["ion-link"] & {
+      rel: string[];
+      value: components["schemas"]["name-value-item"][];
+    };
+    "visual-product-search": components["schemas"]["visual-product-search-object"][];
+    "ion-visual-product-search": {
+      value?: components["schemas"]["visual-product-search-object"][];
+      type?: string;
+      searchArea?: components["schemas"]["search-area"];
+      uploadHighResolutionImage?: components["schemas"]["upload-high-resolution-image"];
+      filters?: {
+        type?: string;
+        value?: {
+          categories?: components["schemas"]["category-filter"][];
+        };
+      };
+      links?: {
+        [key: string]: components["schemas"]["ion-link"];
+      };
+      detectedObjects?: components["schemas"]["ion-detected-object"][];
+    };
+    "visual-product-recommendations": {
+      bestFits?: string[];
+      extended?: components["schemas"]["visual-product-search"][];
+    };
+  };
+  responses: {
+    /** detected objects response */
+    "ion-detected-objects": {
+      content: {
+        "application/json": components["schemas"]["ion-detected-objects"];
+      };
+    };
+    /** success */
+    "visual-product-search": {
+      content: {
+        "application/json": components["schemas"]["visual-product-search"];
+      };
+    };
+    /** success */
+    "ion-visual-product-search": {
+      content: {
+        "application/json": components["schemas"]["ion-visual-product-search"];
+      };
+    };
+    /** success */
+    "visual-product-recommendation": {
+      content: {
+        "application/json": components["schemas"]["visual-product-recommendations"];
+      };
+    };
+    /** Authentication Error */
+    "authentication-error": {
+      content: {
+        "application/json": unknown;
+      };
+    };
+    /** Authorization Error */
+    "authorization-error": {
+      content: {
+        "application/json": unknown;
+      };
+    };
+  };
+  parameters: {
+    "campaign-id": number;
+    campaigns: string;
+    "image-code": string;
+  };
+  requestBodies: {
+    /** Product data object */
+    "product-annotation": {
+      content: {
+        "application/json": {
+          data?: components["schemas"]["product-data"];
+          images?: components["schemas"]["product-annotation-images"][];
+        };
+      };
+    };
+  };
+}
+export interface operations {
+  /** Returns all products which has at least one image */
+  GetProducts: {
+    responses: {
+      /** success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["products"];
+        };
+      };
+      /** An exception occurred on products */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+    };
+  };
+  /** Save or publish the categoryTree */
+  SaveCategoryTree: {
+    responses: {
+      /** success */
+      200: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      /** Could not save or publish the category */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+      /** Invalid structure passed to endpoint */
+      422: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+    };
+    /** List of category objects */
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["category-tree"];
+      };
+    };
+  };
+  /** Save or publish the product */
+  SaveProduct: {
+    parameters: {
+      path: {
+        "product-id": string;
+      };
+    };
+    responses: {
+      /** success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["product-annotation"];
+        };
+      };
+      /** Could not save or publish the product */
+      400: {
+        content: {
+          "application/json": components["schemas"]["product-annotation-error"];
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+    };
+    requestBody: components["requestBodies"]["product-annotation"];
+  };
+  /** Return most similar products to input one */
+  GetSimilarProductsToInputImage: {
+    parameters: {
+      path: {
+        "product-id": string;
+      };
+      query: {
+        "similar-products-count"?: number;
+        campaigns?: components["parameters"]["campaigns"];
+        "image-code"?: components["parameters"]["image-code"];
+      };
+    };
+    responses: {
+      200: components["responses"]["visual-product-recommendation"];
+      /** An exception occurred on load similar products */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+      /** Wait timeout exception occured on load similar products */
+      504: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+    };
+  };
+  /** Return most similar products to input one in specific category */
+  GetSimilarProductsToInputImageInSpecificCategory: {
+    parameters: {
+      path: {
+        "product-id": string;
+        category: string;
+      };
+      query: {
+        "similar-products-count": number;
+        campaigns?: components["parameters"]["campaigns"];
+        "image-code"?: components["parameters"]["image-code"];
+      };
+    };
+    responses: {
+      200: components["responses"]["visual-product-recommendation"];
+      /** An exception occurred on load similar products */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+      /** Wait timeout exception occured on load similar products */
+      504: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+    };
+  };
+  /** Return cross selling products to input one */
+  GetCrossSellingProductsToInputImage: {
+    parameters: {
+      path: {
+        "product-id": string;
+      };
+      query: {
+        "cross-selling-products-count"?: number;
+        campaigns?: components["parameters"]["campaigns"];
+        "image-code"?: components["parameters"]["image-code"];
+      };
+    };
+    responses: {
+      200: components["responses"]["visual-product-search"];
+      /** An exception occurred on load similar products */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+      /** Wait timeout exception occured on load similar products */
+      504: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+    };
+  };
+  /** Return cross selling products to input one in specific category */
+  GetCrossSellingProductsToInputImageInSpecificCategory: {
+    parameters: {
+      path: {
+        "product-id": string;
+        category: string;
+      };
+      query: {
+        "cross-selling-products-count": number;
+        campaigns?: components["parameters"]["campaigns"];
+        "image-code"?: components["parameters"]["image-code"];
+      };
+    };
+    responses: {
+      200: components["responses"]["visual-product-search"];
+      /** An exception occurred on load similar products */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+      /** Wait timeout exception occured on load similar products */
+      504: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+    };
+  };
+  /** Deletes all images from a site on a given image id */
+  DeleteImageById: {
+    parameters: {
+      path: {
+        "image-id": string;
+      };
+    };
+    responses: {
+      /** success */
+      200: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-image-by-imageId"];
+          };
+        };
+      };
+      /** Could not delete the image */
+      400: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-image-error"];
+            debug?: string;
+          };
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+      /** Unable to find any matching image */
+      404: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-image-error"];
+          };
+        };
+      };
+    };
+  };
+  /** Deletes product and its images from a site on a given product id */
+  DeleteFullProduct: {
+    parameters: {
+      path: {
+        "product-id": string;
+      };
+    };
+    responses: {
+      /** success */
+      200: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-product-images-by-productId"];
+          };
+        };
+      };
+      /** Could not delete the image */
+      400: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-image-error"];
+            debug?: string;
+          };
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+      /** Unable to find any image of the product */
+      404: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-image-error"];
+          };
+        };
+      };
+    };
+  };
+  /** Deletes all images from a site on a given product id */
+  DeleteImageByProductId: {
+    parameters: {
+      path: {
+        "product-id": string;
+      };
+    };
+    responses: {
+      /** success */
+      200: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-product-images-by-productId"];
+          };
+        };
+      };
+      /** Could not delete the image */
+      400: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-image-error"];
+            debug?: string;
+          };
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+      /** Unable to find any image of the product */
+      404: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-image-error"];
+          };
+        };
+      };
+    };
+  };
+  /** Upload image directly to catalog and trigger feature extraction */
+  AddImage: {
+    parameters: {
+      path: {
+        "product-id": string;
+        "image-id": string;
+      };
+    };
+    responses: {
+      /** success */
+      200: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["image-by-productId-and-imageId"];
+          };
+        };
+      };
+      /** Could not save or publish the image */
+      400: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["image-by-productId-and-imageId"];
+            debug?: string;
+          };
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+      /** Unable to find product to add this image to */
+      404: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["image-by-productId-and-imageId"];
+          };
+        };
+      };
+    };
+    /** Image url */
+    requestBody: {
+      content: {
+        "application/x-www-form-urlencoded": {
+          "image-url": string;
+        };
+      };
+    };
+  };
+  /** Deletes all images from a site on given product and image ids */
+  DeleteImageByImageIdAndProductId: {
+    parameters: {
+      path: {
+        "product-id": string;
+        "image-id": string;
+      };
+    };
+    responses: {
+      /** success */
+      200: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["image-by-productId-and-imageId"];
+          };
+        };
+      };
+      /** Could not delete the image */
+      400: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-image-by-productId-and-imageId-400-error"];
+            debug?: string;
+          };
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+      /** Unable to find image. */
+      404: {
+        content: {
+          "application/json": {
+            message?: string;
+            data?: components["schemas"]["delete-image-by-productId-and-imageId-404-error"];
+          };
+        };
+      };
+    };
+  };
+  /** Starts a reusable search session for a one image. */
+  CreateSearchSession: {
+    parameters: {
+      query: {
+        "campaign-id"?: components["parameters"]["campaign-id"];
+      };
+    };
+    responses: {
+      200: components["responses"]["ion-visual-product-search"];
+      /** ProductSearch exception */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+    };
+    requestBody: {
+      content: {
+        "multipart/form-data": {
+          image: string;
+        };
+      };
+    };
+  };
+  /** Starts a search in existing session. */
+  SearchInExistingSession: {
+    parameters: {
+      path: {
+        "search-id": string;
+      };
+      query: {
+        "campaign-id"?: components["parameters"]["campaign-id"];
+      };
+    };
+    responses: {
+      200: components["responses"]["ion-visual-product-search"];
+      /** ProductSearch exception */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+    };
+  };
+  /** Starts a search in existing session in specific category. */
+  SearchInExistingSessionWithCategory: {
+    parameters: {
+      path: {
+        "search-id": string;
+        category: string;
+      };
+      query: {
+        "campaign-id"?: components["parameters"]["campaign-id"];
+      };
+    };
+    responses: {
+      200: components["responses"]["ion-visual-product-search"];
+      /** ProductSearch exception */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+    };
+  };
+  /** Get detected objects of image in existing session. */
+  DetectObjectsOfImageInExistingSession: {
+    parameters: {
+      path: {
+        "search-id": string;
+      };
+      query: {
+        "campaign-id"?: components["parameters"]["campaign-id"];
+      };
+    };
+    responses: {
+      200: components["responses"]["ion-detected-objects"];
+      /** ProductSearch exception */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+    };
+  };
+  /** Upload high resolution image to existing session. */
+  UploadHighResolutionImageToExistingSession: {
+    parameters: {
+      path: {
+        "search-id": string;
+      };
+      query: {
+        "campaign-id"?: components["parameters"]["campaign-id"];
+      };
+    };
+    responses: {
+      /** success */
+      200: {
+        content: {
+          "application/json": {
+            message?: string;
+          };
+        };
+      };
+      /** ProductSearch exception */
+      400: {
+        content: {
+          "application/json": unknown;
+        };
+      };
+      401: components["responses"]["authentication-error"];
+      403: components["responses"]["authorization-error"];
+    };
+  };
+}
+export interface external {
+}