@teemill/website 0.30.3 → 0.31.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.30.3
+ * The version of the OpenAPI document: 0.31.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -875,6 +875,20 @@ export interface UpdateSearchRedirectRequest {
     'searchTerm'?: string;
     'destinationUrl'?: string;
 }
+export interface UpdateWebsiteProductRequest {
+    /**
+     * When true, the product is excluded from storefront search results.
+     */
+    'excludeFromSearch'?: boolean;
+    /**
+     * When provided, replaces collection membership for this product with this exclusive list of collection IDs. Any existing membership not in this list is removed.
+     */
+    'collectionIds'?: Array<string>;
+    /**
+     * When provided, replaces cross-sell links with these product IDs. Order is preserved.
+     */
+    'crossSellProductIds'?: Array<string>;
+}
 export interface Variant {
     /**
      * Unique object identifier
@@ -936,6 +950,33 @@ export interface Video {
     'createdAt'?: string;
     'updatedAt'?: string;
 }
+/**
+ * Website-specific settings for a product on the storefront (search visibility, cross-sells, and collection membership).
+ */
+export interface WebsiteProduct {
+    /**
+     * Unique object identifier
+     */
+    'id': string;
+    /**
+     * When true, the product is excluded from storefront search results.
+     */
+    'excludeFromSearch': boolean;
+    /**
+     * Products linked as cross-sells for this product, in display order.
+     */
+    'crossSellProducts': Array<Product>;
+    /**
+     * Collections this product belongs to.
+     */
+    'collections': Array<WebsiteProductCollectionsInner>;
+}
+export interface WebsiteProductCollectionsInner {
+    /**
+     * Unique object identifier
+     */
+    'id': string;
+}
 /**
  * BlogsApi - axios parameter creator
  */
@@ -1223,12 +1264,13 @@ export declare class BlogsApi extends BaseAPI {
  */
 export declare const CollectionsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     *
+     * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `collectionIds` instead.
      * @summary Update product collections
      * @param {string} project What project it is
      * @param {string} productId Product\&#39;s unique identifier
      * @param {UpdateProductCollectionsRequest} [updateProductCollectionsRequest]
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     updateProductCollections: (project: string, productId: string, updateProductCollectionsRequest?: UpdateProductCollectionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -1238,12 +1280,13 @@ export declare const CollectionsApiAxiosParamCreator: (configuration?: Configura
  */
 export declare const CollectionsApiFp: (configuration?: Configuration) => {
     /**
-     *
+     * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `collectionIds` instead.
      * @summary Update product collections
      * @param {string} project What project it is
      * @param {string} productId Product\&#39;s unique identifier
      * @param {UpdateProductCollectionsRequest} [updateProductCollectionsRequest]
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     updateProductCollections(project: string, productId: string, updateProductCollectionsRequest?: UpdateProductCollectionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
@@ -1253,10 +1296,11 @@ export declare const CollectionsApiFp: (configuration?: Configuration) => {
  */
 export declare const CollectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     *
+     * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `collectionIds` instead.
      * @summary Update product collections
      * @param {CollectionsApiUpdateProductCollectionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     updateProductCollections(requestParameters: CollectionsApiUpdateProductCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
@@ -1280,10 +1324,11 @@ export interface CollectionsApiUpdateProductCollectionsRequest {
  */
 export declare class CollectionsApi extends BaseAPI {
     /**
-     *
+     * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `collectionIds` instead.
      * @summary Update product collections
      * @param {CollectionsApiUpdateProductCollectionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     updateProductCollections(requestParameters: CollectionsApiUpdateProductCollectionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
@@ -1293,21 +1338,23 @@ export declare class CollectionsApi extends BaseAPI {
  */
 export declare const CrossSellApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Attaches a list of products to the given product as cross-sell products.
+     * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `crossSellProductIds` instead.  Attaches a list of products to the given product as cross-sell products.
      * @summary Attach cross-sell products
      * @param {string} project What project it is
      * @param {string} productId Product\&#39;s unique identifier
      * @param {AttachCrossSellProductsRequest} [attachCrossSellProductsRequest]
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     attachCrossSellProducts: (project: string, productId: string, attachCrossSellProductsRequest?: AttachCrossSellProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Deprecated. Please use `GET /v1/website/products/{productId}` with `crossSellProducts` instead.
      * @summary Get cross-sell products linked to a product
      * @param {string} project What project it is
      * @param {string} productId Product\&#39;s unique identifier
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     getCrossSellProducts: (project: string, productId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -1317,21 +1364,23 @@ export declare const CrossSellApiAxiosParamCreator: (configuration?: Configurati
  */
 export declare const CrossSellApiFp: (configuration?: Configuration) => {
     /**
-     * Attaches a list of products to the given product as cross-sell products.
+     * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `crossSellProductIds` instead.  Attaches a list of products to the given product as cross-sell products.
      * @summary Attach cross-sell products
      * @param {string} project What project it is
      * @param {string} productId Product\&#39;s unique identifier
      * @param {AttachCrossSellProductsRequest} [attachCrossSellProductsRequest]
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     attachCrossSellProducts(project: string, productId: string, attachCrossSellProductsRequest?: AttachCrossSellProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Product>>>;
     /**
-     *
+     * Deprecated. Please use `GET /v1/website/products/{productId}` with `crossSellProducts` instead.
      * @summary Get cross-sell products linked to a product
      * @param {string} project What project it is
      * @param {string} productId Product\&#39;s unique identifier
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     getCrossSellProducts(project: string, productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Product>>>;
@@ -1341,18 +1390,20 @@ export declare const CrossSellApiFp: (configuration?: Configuration) => {
  */
 export declare const CrossSellApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Attaches a list of products to the given product as cross-sell products.
+     * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `crossSellProductIds` instead.  Attaches a list of products to the given product as cross-sell products.
      * @summary Attach cross-sell products
      * @param {CrossSellApiAttachCrossSellProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     attachCrossSellProducts(requestParameters: CrossSellApiAttachCrossSellProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Product>>;
     /**
-     *
+     * Deprecated. Please use `GET /v1/website/products/{productId}` with `crossSellProducts` instead.
      * @summary Get cross-sell products linked to a product
      * @param {CrossSellApiGetCrossSellProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     getCrossSellProducts(requestParameters: CrossSellApiGetCrossSellProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Product>>;
@@ -1389,18 +1440,20 @@ export interface CrossSellApiGetCrossSellProductsRequest {
  */
 export declare class CrossSellApi extends BaseAPI {
     /**
-     * Attaches a list of products to the given product as cross-sell products.
+     * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `crossSellProductIds` instead.  Attaches a list of products to the given product as cross-sell products.
      * @summary Attach cross-sell products
      * @param {CrossSellApiAttachCrossSellProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     attachCrossSellProducts(requestParameters: CrossSellApiAttachCrossSellProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product[], any, {}>>;
     /**
-     *
+     * Deprecated. Please use `GET /v1/website/products/{productId}` with `crossSellProducts` instead.
      * @summary Get cross-sell products linked to a product
      * @param {CrossSellApiGetCrossSellProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      */
     getCrossSellProducts(requestParameters: CrossSellApiGetCrossSellProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product[], any, {}>>;
@@ -2324,6 +2377,126 @@ export declare class PaymentApi extends BaseAPI {
      */
     getStripePaymentAccount(requestParameters: PaymentApiGetStripePaymentAccountRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentAccount, any, {}>>;
 }
+/**
+ * ProductsApi - axios parameter creator
+ */
+export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns website-specific settings for a product, including storefront search visibility, cross-sell products, and collection membership.  The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
+     * @summary Get website product
+     * @param {string} project What project it is
+     * @param {string} productId Product\&#39;s unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWebsiteProduct: (project: string, productId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates website-specific settings for a product. Include only fields you want to change.  `excludeFromSearch` toggles storefront search visibility. When `collectionIds` is present, it replaces collection membership for this product with that exclusive list of collection IDs (same behaviour as the deprecated collections route). When `crossSellProductIds` is present, it replaces cross-sell links in the given order (same behaviour as the deprecated cross-sell route).  The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
+     * @summary Update website product
+     * @param {string} project What project it is
+     * @param {string} productId Product\&#39;s unique identifier
+     * @param {UpdateWebsiteProductRequest} [updateWebsiteProductRequest] Update website product settings
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWebsiteProduct: (project: string, productId: string, updateWebsiteProductRequest?: UpdateWebsiteProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProductsApi - functional programming interface
+ */
+export declare const ProductsApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns website-specific settings for a product, including storefront search visibility, cross-sell products, and collection membership.  The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
+     * @summary Get website product
+     * @param {string} project What project it is
+     * @param {string} productId Product\&#39;s unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWebsiteProduct(project: string, productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebsiteProduct>>;
+    /**
+     * Updates website-specific settings for a product. Include only fields you want to change.  `excludeFromSearch` toggles storefront search visibility. When `collectionIds` is present, it replaces collection membership for this product with that exclusive list of collection IDs (same behaviour as the deprecated collections route). When `crossSellProductIds` is present, it replaces cross-sell links in the given order (same behaviour as the deprecated cross-sell route).  The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
+     * @summary Update website product
+     * @param {string} project What project it is
+     * @param {string} productId Product\&#39;s unique identifier
+     * @param {UpdateWebsiteProductRequest} [updateWebsiteProductRequest] Update website product settings
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWebsiteProduct(project: string, productId: string, updateWebsiteProductRequest?: UpdateWebsiteProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebsiteProduct>>;
+};
+/**
+ * ProductsApi - factory interface
+ */
+export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns website-specific settings for a product, including storefront search visibility, cross-sell products, and collection membership.  The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
+     * @summary Get website product
+     * @param {ProductsApiGetWebsiteProductRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWebsiteProduct(requestParameters: ProductsApiGetWebsiteProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<WebsiteProduct>;
+    /**
+     * Updates website-specific settings for a product. Include only fields you want to change.  `excludeFromSearch` toggles storefront search visibility. When `collectionIds` is present, it replaces collection membership for this product with that exclusive list of collection IDs (same behaviour as the deprecated collections route). When `crossSellProductIds` is present, it replaces cross-sell links in the given order (same behaviour as the deprecated cross-sell route).  The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
+     * @summary Update website product
+     * @param {ProductsApiUpdateWebsiteProductRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWebsiteProduct(requestParameters: ProductsApiUpdateWebsiteProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<WebsiteProduct>;
+};
+/**
+ * Request parameters for getWebsiteProduct operation in ProductsApi.
+ */
+export interface ProductsApiGetWebsiteProductRequest {
+    /**
+     * What project it is
+     */
+    readonly project: string;
+    /**
+     * Product\&#39;s unique identifier
+     */
+    readonly productId: string;
+}
+/**
+ * Request parameters for updateWebsiteProduct operation in ProductsApi.
+ */
+export interface ProductsApiUpdateWebsiteProductRequest {
+    /**
+     * What project it is
+     */
+    readonly project: string;
+    /**
+     * Product\&#39;s unique identifier
+     */
+    readonly productId: string;
+    /**
+     * Update website product settings
+     */
+    readonly updateWebsiteProductRequest?: UpdateWebsiteProductRequest;
+}
+/**
+ * ProductsApi - object-oriented interface
+ */
+export declare class ProductsApi extends BaseAPI {
+    /**
+     * Returns website-specific settings for a product, including storefront search visibility, cross-sell products, and collection membership.  The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
+     * @summary Get website product
+     * @param {ProductsApiGetWebsiteProductRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWebsiteProduct(requestParameters: ProductsApiGetWebsiteProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebsiteProduct, any, {}>>;
+    /**
+     * Updates website-specific settings for a product. Include only fields you want to change.  `excludeFromSearch` toggles storefront search visibility. When `collectionIds` is present, it replaces collection membership for this product with that exclusive list of collection IDs (same behaviour as the deprecated collections route). When `crossSellProductIds` is present, it replaces cross-sell links in the given order (same behaviour as the deprecated cross-sell route).  The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
+     * @summary Update website product
+     * @param {ProductsApiUpdateWebsiteProductRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWebsiteProduct(requestParameters: ProductsApiUpdateWebsiteProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebsiteProduct, any, {}>>;
+}
 /**
  * ReviewsApi - axios parameter creator
  */