@etohq/types 1.0.0

package/dist/product/service.d.ts

@@ -0,0 +1,2220 @@
+import { RestoreReturn, SoftDeleteReturn } from "../dal";
+import { CreateProductCategoryDTO, CreateProductCollectionDTO, CreateProductDTO, CreateProductOptionDTO, CreateProductOptionValueDTO, CreateProductTagDTO, CreateProductTypeDTO, CreateProductVariantDTO, FilterableProductCategoryProps, FilterableProductCollectionProps, FilterableProductOptionProps, FilterableProductOptionValueProps, FilterableProductProps, FilterableProductTagProps, FilterableProductTypeProps, FilterableProductVariantProps, ProductCategoryDTO, ProductCollectionDTO, ProductDTO, ProductOptionDTO, ProductOptionValueDTO, ProductTagDTO, ProductTypeDTO, ProductVariantDTO, UpdateProductCategoryDTO, UpdateProductCollectionDTO, UpdateProductDTO, UpdateProductOptionDTO, UpdateProductOptionValueDTO, UpdateProductTagDTO, UpdateProductTypeDTO, UpdateProductVariantDTO, UpsertProductCategoryDTO, UpsertProductCollectionDTO, UpsertProductDTO, UpsertProductOptionDTO, UpsertProductTagDTO, UpsertProductTypeDTO, UpsertProductVariantDTO } from "./common";
+import { FindConfig } from "../common";
+import { IModuleService } from "../modules-sdk";
+import { Context } from "../shared-context";
+/**
+ * The main service interface for the Product Module.
+ */
+export interface IProductModuleService extends IModuleService {
+    /**
+     * This method is used to retrieve a product by its ID
+     *
+     * @param {string} productId - The ID of the product to retrieve.
+     * @param {FindConfig<ProductDTO>} config -
+     * The configurations determining how the product is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductDTO>} The retrieved product.
+     *
+     * @example
+     * A simple example that retrieves a product by its ID:
+     *
+     * ```ts
+     * const product =
+     *   await productModuleService.retrieveProduct("prod_123")
+     * ```
+     *
+     * To specify relations that should be retrieved:
+     *
+     * ```ts
+     * const product = await productModuleService.retrieveProduct(
+     *   "prod_123",
+     *   {
+     *     relations: ["categories"],
+     *   }
+     * )
+     * ```
+     */
+    retrieveProduct(productId: string, config?: FindConfig<ProductDTO>, sharedContext?: Context): Promise<ProductDTO>;
+    /**
+     * This method is used to retrieve a paginated list of products based on optional filters and configuration.
+     *
+     * @param {FilterableProductProps} filters - The filters to apply on the retrieved products.
+     * @param {FindConfig<ProductDTO>} config -
+     * The configurations determining how the products are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductDTO[]>} The list of products.
+     *
+     * @example
+     * To retrieve a list of products using their IDs:
+     *
+     * ```ts
+     * const products = await productModuleService.listProducts({
+     *   id: ["prod_123", "prod_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the products:
+     *
+     * ```ts
+     * const products = await productModuleService.listProducts(
+     *   {
+     *     id: ["prod_123", "prod_321"],
+     *   },
+     *   {
+     *     relations: ["categories"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const products = await productModuleService.listProducts(
+     *   {
+     *     id: ["prod_123", "prod_321"],
+     *   },
+     *   {
+     *     relations: ["categories"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
+    listProducts(filters?: FilterableProductProps, config?: FindConfig<ProductDTO>, sharedContext?: Context): Promise<ProductDTO[]>;
+    /**
+     * This method is used to retrieve a paginated list of products along with the total count of available products satisfying the provided filters.
+     *
+     * @param {FilterableProductProps} filters - The filters to apply on the retrieved products.
+     * @param {FindConfig<ProductDTO>} config -
+     * The configurations determining how the products are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductDTO[]>} The list of products along with the total count.
+     *
+     * @example
+     * To retrieve a list of products using their IDs:
+     *
+     * ```ts
+     * const [products, count] =
+     *   await productModuleService.listAndCountProducts({
+     *     id: ["prod_123", "prod_321"],
+     *   })
+     * ```
+     *
+     * To specify relations that should be retrieved within the products:
+     *
+     * ```ts
+     * const [products, count] =
+     *   await productModuleService.listAndCountProducts(
+     *     {
+     *       id: ["prod_123", "prod_321"],
+     *     },
+     *     {
+     *       relations: ["categories"],
+     *     }
+     *   )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [products, count] =
+     *   await productModuleService.listAndCountProducts(
+     *     {
+     *       id: ["prod_123", "prod_321"],
+     *     },
+     *     {
+     *       relations: ["categories"],
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listAndCountProducts(filters?: FilterableProductProps, config?: FindConfig<ProductDTO>, sharedContext?: Context): Promise<[ProductDTO[], number]>;
+    /**
+     * This method is used to create a list of products.
+     *
+     * @param {CreateProductDTO[]} data - The products to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductDTO[]>} The list of created products.
+     *
+     * @example
+     * const products = await productModuleService.createProducts([
+     *   {
+     *     title: "Shirt",
+     *   },
+     *   {
+     *     title: "Pants",
+     *     handle: "pants",
+     *   },
+     * ])
+     */
+    createProducts(data: CreateProductDTO[], sharedContext?: Context): Promise<ProductDTO[]>;
+    /**
+     * This method is used to create a product.
+     *
+     * @param {CreateProductDTO} data - The product to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductDTO>} The created product.
+     *
+     * @example
+     * const product = await productModuleService.createProducts({
+     *   title: "Shirt",
+     * })
+     */
+    createProducts(data: CreateProductDTO, sharedContext?: Context): Promise<ProductDTO>;
+    /**
+     * This method updates existing products, or creates new ones if they don't exist.
+     *
+     * @param {UpsertProductDTO[]} data - The attributes to update or create for each product.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductDTO[]>} The updated and created products.
+     *
+     * @example
+     * const products = await productModuleService.upsertProducts([
+     *   {
+     *     id: "prod_123",
+     *     handle: "pant",
+     *   },
+     *   {
+     *     title: "Shirt",
+     *   },
+     * ])
+     */
+    upsertProducts(data: UpsertProductDTO[], sharedContext?: Context): Promise<ProductDTO[]>;
+    /**
+     * This method updates the product if it exists, or creates a new ones if it doesn't.
+     *
+     * @param {UpsertProductDTO} data - The attributes to update or create for the new product.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductDTO>} The updated or created product.
+     *
+     * @example
+     * const product = await productModuleService.upsertProducts({
+     *   title: "Shirt",
+     * })
+     */
+    upsertProducts(data: UpsertProductDTO, sharedContext?: Context): Promise<ProductDTO>;
+    /**
+     * This method is used to update a product.
+     *
+     * @param {string} id - The ID of the product to be updated.
+     * @param {UpdateProductDTO} data - The attributes of the product to be updated
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductDTO>} The updated product.
+     *
+     * @example
+     * const product = await productModuleService.updateProducts(
+     *   "prod_123",
+     *   {
+     *     handle: "pant",
+     *   }
+     * )
+     */
+    updateProducts(id: string, data: UpdateProductDTO, sharedContext?: Context): Promise<ProductDTO>;
+    /**
+     * This method is used to update a list of products matching the specified filters.
+     *
+     * @param {FilterableProductProps} selector - The filters specifying which products to update.
+     * @param {UpdateProductDTO} data - The attributes to be updated on the selected products
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductDTO[]>} The updated products.
+     *
+     * @example
+     * const products = await productModuleService.updateProducts(
+     *   {
+     *     title: "Pant",
+     *   },
+     *   {
+     *     handle: "pant",
+     *   }
+     * )
+     */
+    updateProducts(selector: FilterableProductProps, data: UpdateProductDTO, sharedContext?: Context): Promise<ProductDTO[]>;
+    /**
+     * This method is used to delete products. Unlike the {@link softDelete} method, this method will completely remove the products and they can no longer be accessed or retrieved.
+     *
+     * @param {string[]} productIds - The IDs of the products to be deleted.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the products are successfully deleted.
+     *
+     * @example
+     * await productModuleService.deleteProducts(["prod_123", "prod_321"])
+     */
+    deleteProducts(productIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method is used to delete products. Unlike the {@link delete} method, this method won't completely remove the product. It can still be accessed or retrieved using methods like {@link retrieve} if you pass the `withDeleted` property to the `config` object parameter.
+     *
+     * The soft-deleted products can be restored using the {@link restore} method.
+     *
+     * @param {string[]} productIds - The IDs of the products to soft-delete.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to soft delete along with the each of the products. You can pass to its `returnLinkableKeys`
+     * property any of the product's relation attribute names, such as `variant_id`.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were also soft deleted, such as the ID of associated product variants. The object's keys are the ID attribute names of the product entity's relations, such as `variant_id`, and its value is an array of strings, each being the ID of a record associated with the product through this relation, such as the IDs of associated product variants.
+     *
+     * If there are no related records, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.softDeleteProducts([
+     *   "prod_123",
+     *   "prod_321",
+     * ])
+     */
+    softDeleteProducts<TReturnableLinkableKeys extends string = string>(productIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to restore products which were deleted using the {@link softDelete} method.
+     *
+     * @param {string[]} productIds - The IDs of the products to restore.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to restore along with each of the products. You can pass to its `returnLinkableKeys`
+     * property any of the product's relation attribute names, such as `variant_id`.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were restored, such as the ID of associated product variants. The object's keys are the ID attribute names of the product entity's relations, such as `variant_id`, and its value is an array of strings, each being the ID of the record associated with the product through this relation, such as the IDs of associated product variants.
+     *
+     * If there are no related records that were restored, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.restoreProducts(["prod_123", "prod_321"])
+     */
+    restoreProducts<TReturnableLinkableKeys extends string = string>(productIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to retrieve a tag by its ID.
+     *
+     * @param {string} tagId - The ID of the tag to retrieve.
+     * @param {FindConfig<ProductTagDTO>} config -
+     * The configurations determining how the product tag is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product tag.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTagDTO>} The retrieved product tag.
+     *
+     * @example
+     * A simple example that retrieves a product tag by its ID:
+     *
+     * ```ts
+     * const tag = await productModuleService.retrieveProductTag("ptag_123")
+     * ```
+     *
+     * To specify relations that should be retrieved:
+     *
+     * ```ts
+     * const tag = await productModuleService.retrieveProductTag(
+     *   "ptag_123",
+     *   {
+     *     relations: ["products"],
+     *   }
+     * )
+     * ```
+     */
+    retrieveProductTag(tagId: string, config?: FindConfig<ProductTagDTO>, sharedContext?: Context): Promise<ProductTagDTO>;
+    /**
+     * This method is used to retrieve a paginated list of tags based on optional filters and configuration.
+     *
+     * @param {FilterableProductTagProps} filters - The filters applied on the retrieved product tags.
+     * @param {FindConfig<ProductTagDTO>} config -
+     * The configurations determining how the product tags are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product tag.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTagDTO[]>} The list of product tags.
+     *
+     * @example
+     * To retrieve a list of product tags using their IDs:
+     *
+     * ```ts
+     * const tags = await productModuleService.listProductTags({
+     *   id: ["ptag_123", "ptag_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product tags:
+     *
+     * ```ts
+     * const tags = await productModuleService.listProductTags(
+     *   {
+     *     id: ["ptag_123", "ptag_321"],
+     *   },
+     *   {
+     *     relations: ["products"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const tags = await productModuleService.listProductTags(
+     *   {
+     *     id: ["ptag_123", "ptag_321"],
+     *   },
+     *   {
+     *     relations: ["products"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
+    listProductTags(filters?: FilterableProductTagProps, config?: FindConfig<ProductTagDTO>, sharedContext?: Context): Promise<ProductTagDTO[]>;
+    /**
+     * This method is used to retrieve a paginated list of product tags along with the total count of available product tags satisfying the provided filters.
+     *
+     * @param {FilterableProductTagProps} filters - The filters applied on the retrieved product tags.
+     * @param {FindConfig<ProductTagDTO>} config -
+     * The configurations determining how the product tags are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product tag.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[ProductTagDTO[], number]>} The list of product tags along with the total count.
+     *
+     * @example
+     * To retrieve a list of product tags using their IDs:
+     *
+     * ```ts
+     * const [tags, count] =
+     *   await productModuleService.listAndCountProductTags({
+     *     id: ["ptag_123", "ptag_321"],
+     *   })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product tags:
+     *
+     * ```ts
+     * const [tags, count] =
+     *   await productModuleService.listAndCountProductTags(
+     *     {
+     *       id: ["ptag_123", "ptag_321"],
+     *     },
+     *     {
+     *       relations: ["products"],
+     *     }
+     *   )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [tags, count] =
+     *   await productModuleService.listAndCountProductTags(
+     *     {
+     *       id: ["ptag_123", "ptag_321"],
+     *     },
+     *     {
+     *       relations: ["products"],
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listAndCountProductTags(filters?: FilterableProductTagProps, config?: FindConfig<ProductTagDTO>, sharedContext?: Context): Promise<[ProductTagDTO[], number]>;
+    /**
+     * This method is used to create a product tag.
+     *
+     * @param {CreateProductTagDTO[]} data - The product tags to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @return {Promise<ProductTagDTO[]>} The list of created product tags.
+     *
+     * @example
+     * const productTags = await productModuleService.createProductTags([
+     *   {
+     *     value: "digital",
+     *   },
+     * ])
+     */
+    createProductTags(data: CreateProductTagDTO[], sharedContext?: Context): Promise<ProductTagDTO[]>;
+    /**
+     * This method is used to create a product tag.
+     *
+     * @param {CreateProductTagDTO} data - The product tag to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTagDTO>} The created product tag.
+     *
+     * @example
+     * const productTag = await productModuleService.createProductTags({
+     *   value: "digital",
+     * })
+     *
+     */
+    createProductTags(data: CreateProductTagDTO, sharedContext?: Context): Promise<ProductTagDTO>;
+    /**
+     * This method updates existing tags, or creates new ones if they don't exist.
+     *
+     * @param {UpsertProductTagDTO[]} data - The attributes to update or create for each tag.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTagDTO[]>} The updated and created tags.
+     *
+     * @example
+     * const productTags = await productModuleService.upsertProductTags([
+     *   {
+     *     id: "ptag_123",
+     *     metadata: {
+     *       test: true,
+     *     },
+     *   },
+     *   {
+     *     value: "Digital",
+     *   },
+     * ])
+     */
+    upsertProductTags(data: UpsertProductTagDTO[], sharedContext?: Context): Promise<ProductTagDTO[]>;
+    /**
+     * This method updates an existing tag, or creates a new one if it doesn't exist.
+     *
+     * @param {UpsertProductTagDTO} data - The attributes to update or create for the tag.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTagDTO>} The updated or created tag.
+     *
+     * @example
+     * const productTag = await productModuleService.upsertProductTags({
+     *   id: "ptag_123",
+     *   metadata: {
+     *     test: true,
+     *   },
+     * })
+     */
+    upsertProductTags(data: UpsertProductTagDTO, sharedContext?: Context): Promise<ProductTagDTO>;
+    /**
+     * This method is used to update a tag.
+     *
+     * @param {string} id - The ID of the tag to be updated.
+     * @param {UpdateProductTagDTO} data - The attributes of the tag to be updated
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTagDTO>} The updated tag.
+     *
+     * @example
+     * const productTag = await productModuleService.updateProductTags(
+     *   "ptag_123",
+     *   {
+     *     value: "Digital",
+     *   }
+     * )
+     */
+    updateProductTags(id: string, data: UpdateProductTagDTO, sharedContext?: Context): Promise<ProductTagDTO>;
+    /**
+     * This method is used to update a list of tags matching the specified filters.
+     *
+     * @param {FilterableProductTagProps} selector - The filters specifying which tags to update.
+     * @param {UpdateProductTagDTO} data - The attributes to be updated on the selected tags
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTagDTO[]>} The updated tags.
+     *
+     * @example
+     * const productTags = await productModuleService.updateProductTags(
+     *   {
+     *     id: ["ptag_123", "ptag_321"],
+     *   },
+     *   {
+     *     value: "Digital",
+     *   }
+     * )
+     */
+    updateProductTags(selector: FilterableProductTagProps, data: UpdateProductTagDTO, sharedContext?: Context): Promise<ProductTagDTO[]>;
+    /**
+     * This method is used to delete product tags by their ID.
+     *
+     * @param {string[]} productTagIds - The IDs of the product tags to be deleted.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the product tags are successfully deleted.
+     *
+     * @example
+     * await productModuleService.deleteProductTags([
+     *   "ptag_123",
+     *   "ptag_321",
+     * ])
+     */
+    deleteProductTags(productTagIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method is used to delete tags. Unlike the {@link delete} method, this method won't completely remove the tag. It can still be accessed or retrieved using methods like {@link retrieve} if you pass the `withDeleted` property to the `config` object parameter.
+     *
+     * The soft-deleted tags can be restored using the {@link restore} method.
+     *
+     * @param {string[]} tagIds - The IDs of the tags to soft-delete.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to soft delete along with the each of the tags. You can pass to its `returnLinkableKeys`
+     * property any of the tag's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were also soft deleted. The object's keys are the ID attribute names of the tag entity's relations, and its value is an array of strings, each being the ID of a record associated with the tag through this relation.
+     *
+     * If there are no related records, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.softDeleteProductTags([
+     *   "ptag_123",
+     *   "ptag_321",
+     * ])
+     */
+    softDeleteProductTags<TReturnableLinkableKeys extends string = string>(tagIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to restore tags which were deleted using the {@link softDelete} method.
+     *
+     * @param {string[]} tagIds - The IDs of the tags to restore.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to restore along with each of the tags. You can pass to its `returnLinkableKeys`
+     * property any of the tag's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the tag entity's relations, and its value is an array of strings, each being the ID of the record associated with the tag through this relation.
+     *
+     * If there are no related records that were restored, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.restoreProductTags([
+     *   "ptag_123",
+     *   "ptag_321",
+     * ])
+     */
+    restoreProductTags<TReturnableLinkableKeys extends string = string>(tagIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to retrieve a product type by its ID.
+     *
+     * @param {string} typeId - The ID of the product type to retrieve.
+     * @param {FindConfig<ProductTypeDTO>} config -
+     * The configurations determining how the product type is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product type.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTypeDTO>} The retrieved product type.
+     *
+     * @example
+     * const productType =
+     *   await productModuleService.retrieveProductType("ptyp_123")
+     */
+    retrieveProductType(typeId: string, config?: FindConfig<ProductTypeDTO>, sharedContext?: Context): Promise<ProductTypeDTO>;
+    /**
+     * This method is used to retrieve a paginated list of product types based on optional filters and configuration.
+     *
+     * @param {FilterableProductTypeProps} filters - The filters to apply on the retrieved product types.
+     * @param {FindConfig<ProductTypeDTO>} config -
+     * The configurations determining how the product types are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product type.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTypeDTO[]>} The list of product types.
+     *
+     * @example
+     * To retrieve a list of product types using their IDs:
+     *
+     * ```ts
+     * const productTypes = await productModuleService.listProductTypes({
+     *   id: ["ptyp_123", "ptyp_321"],
+     * })
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const productTypes = await productModuleService.listProductTypes(
+     *   {
+     *     id: ["ptyp_123", "ptyp_321"],
+     *   },
+     *   {
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
+    listProductTypes(filters?: FilterableProductTypeProps, config?: FindConfig<ProductTypeDTO>, sharedContext?: Context): Promise<ProductTypeDTO[]>;
+    /**
+     * This method is used to retrieve a paginated list of product types along with the total count of available product types satisfying the provided filters.
+     *
+     * @param {FilterableProductTypeProps} filters - The filters to be applied on the retrieved product type.
+     * @param {FindConfig<ProductTypeDTO>} config -
+     * The configurations determining how the product types are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product type.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[ProductTypeDTO[], number]>} The list of product types along with their total count.
+     *
+     * @example
+     * To retrieve a list of product types using their IDs:
+     *
+     * ```ts
+     * const [productTypes, count] =
+     *   await productModuleService.listAndCountProductTypes({
+     *     id: ["ptyp_123", "ptyp_321"],
+     *   })
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [productTypes, count] =
+     *   await productModuleService.listAndCountProductTypes(
+     *     {
+     *       id: ["ptyp_123", "ptyp_321"],
+     *     },
+     *     {
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listAndCountProductTypes(filters?: FilterableProductTypeProps, config?: FindConfig<ProductTypeDTO>, sharedContext?: Context): Promise<[ProductTypeDTO[], number]>;
+    /**
+     * This method is used to create a product type.
+     *
+     * @param {CreateProductTypeDTO[]} data - The product types to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @return {Promise<ProductTypeDTO[]>} The list of created product types.
+     *
+     * @example
+     * const productTypes = await productModuleService.createProductTypes([
+     *   {
+     *     value: "digital",
+     *   },
+     * ])
+     */
+    createProductTypes(data: CreateProductTypeDTO[], sharedContext?: Context): Promise<ProductTypeDTO[]>;
+    /**
+     * This method is used to create a product type.
+     *
+     * @param {CreateProductTypeDTO} data - The product type to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTypeDTO>} The created product type.
+     *
+     * @example
+     * const productType = await productModuleService.createProductTypes({
+     *   value: "digital",
+     * })
+     *
+     */
+    createProductTypes(data: CreateProductTypeDTO, sharedContext?: Context): Promise<ProductTypeDTO>;
+    /**
+     * This method updates existing types, or creates new ones if they don't exist.
+     *
+     * @param {UpsertProductTypeDTO[]} data - The attributes to update or create for each type.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTypeDTO[]>} The updated and created types.
+     *
+     * @example
+     * const productTypes = await productModuleService.upsertProductTypes([
+     *   {
+     *     id: "ptyp_123",
+     *     metadata: {
+     *       test: true,
+     *     },
+     *   },
+     *   {
+     *     value: "Digital",
+     *   },
+     * ])
+     */
+    upsertProductTypes(data: UpsertProductTypeDTO[], sharedContext?: Context): Promise<ProductTypeDTO[]>;
+    /**
+     * This method updates an existing type, or creates a new one if it doesn't exist.
+     *
+     * @param {UpsertProductTypeDTO} data - The attributes to update or create for the type.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTypeDTO>} The updated or created type.
+     *
+     * @example
+     * const productType = await productModuleService.upsertProductTypes({
+     *   id: "ptyp_123",
+     *   metadata: {
+     *     test: true,
+     *   },
+     * })
+     */
+    upsertProductTypes(data: UpsertProductTypeDTO, sharedContext?: Context): Promise<ProductTypeDTO>;
+    /**
+     * This method is used to update a type.
+     *
+     * @param {string} id - The ID of the type to be updated.
+     * @param {UpdateProductTypeDTO} data - The attributes of the type to be updated
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTypeDTO>} The updated type.
+     *
+     * @example
+     * const productType = await productModuleService.updateProductTypes(
+     *   "ptyp_123",
+     *   {
+     *     value: "Digital",
+     *   }
+     * )
+     */
+    updateProductTypes(id: string, data: UpdateProductTypeDTO, sharedContext?: Context): Promise<ProductTypeDTO>;
+    /**
+     * This method is used to update a list of types matching the specified filters.
+     *
+     * @param {FilterableProductTypeProps} selector - The filters specifying which types to update.
+     * @param {UpdateProductTypeDTO} data - The attributes to be updated on the selected types
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductTypeDTO[]>} The updated types.
+     *
+     * @example
+     * const productTypes = await productModuleService.updateProductTypes(
+     *   {
+     *     id: ["ptyp_123", "ptyp_321"],
+     *   },
+     *   {
+     *     value: "Digital",
+     *   }
+     * )
+     */
+    updateProductTypes(selector: FilterableProductTypeProps, data: UpdateProductTypeDTO, sharedContext?: Context): Promise<ProductTypeDTO[]>;
+    /**
+     * This method is used to delete a product type.
+     *
+     * @param {string[]} productTypeIds - The IDs of the product types to be deleted.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the product types are successfully deleted.
+     *
+     * @example
+     * await productModuleService.deleteProductTypes([
+     *   "ptyp_123",
+     *   "ptyp_321",
+     * ])
+     */
+    deleteProductTypes(productTypeIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method is used to delete types. Unlike the {@link delete} method, this method won't completely remove the type. It can still be accessed or retrieved using methods like {@link retrieve} if you pass the `withDeleted` property to the `config` object parameter.
+     *
+     * The soft-deleted types can be restored using the {@link restore} method.
+     *
+     * @param {string[]} typeIds - The IDs of the types to soft-delete.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to soft delete along with the each of the types. You can pass to its `returnLinkableKeys`
+     * property any of the type's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were also soft deleted. The object's keys are the ID attribute names of the type entity's relations, and its value is an array of strings, each being the ID of a record associated with the type through this relation.
+     *
+     * If there are no related records, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.softDeleteProductTypes([
+     *   "ptyp_123",
+     *   "ptyp_321",
+     * ])
+     */
+    softDeleteProductTypes<TReturnableLinkableKeys extends string = string>(typeIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to restore types which were deleted using the {@link softDelete} method.
+     *
+     * @param {string[]} typeIds - The IDs of the types to restore.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to restore along with each of the types. You can pass to its `returnLinkableKeys`
+     * property any of the type's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the type entity's relations, and its value is an array of strings, each being the ID of the record associated with the type through this relation.
+     *
+     * If there are no related records that were restored, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.restoreProductTypes([
+     *   "ptyp_123",
+     *   "ptyp_321",
+     * ])
+     */
+    restoreProductTypes<TReturnableLinkableKeys extends string = string>(typeIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to retrieve a product option by its ID.
+     *
+     * @param {string} optionId - The ID of the product option to retrieve.
+     * @param {FindConfig<ProductOptionDTO>} config -
+     * The configurations determining how the product option is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product option.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionDTO>} The retrieved product option.
+     *
+     * @example
+     * A simple example that retrieves a product option by its ID:
+     *
+     * ```ts
+     * const option =
+     *   await productModuleService.retrieveProductOption("opt_123")
+     * ```
+     *
+     * To specify relations that should be retrieved:
+     *
+     * ```ts
+     * const option = await productModuleService.retrieveProductOption(
+     *   "opt_123",
+     *   {
+     *     relations: ["product"],
+     *   }
+     * )
+     * ```
+     */
+    retrieveProductOption(optionId: string, config?: FindConfig<ProductOptionDTO>, sharedContext?: Context): Promise<ProductOptionDTO>;
+    /**
+     * This method is used to retrieve a paginated list of product options based on optional filters and configuration.
+     *
+     * @param {FilterableProductOptionProps} filters - The filters applied on the retrieved product options.
+     * @param {FindConfig<ProductOptionDTO>} config -
+     * The configurations determining how the product options are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product option.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionDTO[]>} The list of product options.
+     *
+     * @example
+     * To retrieve a list of product options using their IDs:
+     *
+     * ```ts
+     * const options = await productModuleService.listProductOptions({
+      id: ["opt_123", "opt_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product options:
+     *
+     * ```ts
+     * const options = await productModuleService.listProductOptions(
+     *   {
+     *     id: ["opt_123", "opt_321"],
+     *   },
+     *   {
+     *     relations: ["product"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const options = await productModuleService.listProductOptions(
+     *   {
+     *     id: ["opt_123", "opt_321"],
+     *   },
+     *   {
+     *     relations: ["product"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     *
+     */
+    listProductOptions(filters?: FilterableProductOptionProps, config?: FindConfig<ProductOptionDTO>, sharedContext?: Context): Promise<ProductOptionDTO[]>;
+    /**
+     * This method is used to retrieve a paginated list of product options along with the total count of available product options satisfying the provided filters.
+     *
+     * @param {FilterableProductOptionProps} filters - The filters applied on the retrieved product options.
+     * @param {FindConfig<ProductOptionDTO>} config -
+     * The configurations determining how the product options are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product option.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[ProductOptionDTO[], number]>} The list of product options along with the total count.
+     *
+     * @example
+     * To retrieve a list of product options using their IDs:
+     *
+     * ```ts
+     * const [options, count] =
+     *   await productModuleService.listAndCountProductOptions({
+     *     id: ["opt_123", "opt_321"],
+     *   })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product types:
+     *
+     * ```ts
+     * const [options, count] =
+     *   await productModuleService.listAndCountProductOptions(
+     *     {
+     *       id: ["opt_123", "opt_321"],
+     *     },
+     *     {
+     *       relations: ["product"],
+     *     }
+     *   )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [options, count] =
+     *   await productModuleService.listAndCountProductOptions(
+     *     {
+     *       id: ["opt_123", "opt_321"],
+     *     },
+     *     {
+     *       relations: ["product"],
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listAndCountProductOptions(filters?: FilterableProductOptionProps, config?: FindConfig<ProductOptionDTO>, sharedContext?: Context): Promise<[ProductOptionDTO[], number]>;
+    /**
+     * This method is used to create product options.
+     *
+     * @param {CreateProductOptionDTO[]} data - The product options to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionDTO[]>} The list of created product options.
+     *
+     * @example
+     * const options = await productModuleService.createProductOptions([
+     *   {
+     *     title: "Color",
+     *     values: ["Blue", "Green"],
+     *     product_id: "prod_123",
+     *   },
+     *   {
+     *     title: "Size",
+     *     values: ["Small", "Medium"],
+     *     product_id: "prod_321",
+     *   },
+     * ])
+     *
+     */
+    createProductOptions(data: CreateProductOptionDTO[], sharedContext?: Context): Promise<ProductOptionDTO[]>;
+    /**
+     * This method is used to create a product option.
+     *
+     * @param {CreateProductOptionDTO} data - The product option to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionDTO>} The created product option.
+     *
+     * @example
+     * const option = await productModuleService.createProductOptions({
+     *   title: "Color",
+     *   values: ["Blue", "Green"],
+     *   product_id: "prod_123",
+     * })
+     *
+     */
+    createProductOptions(data: CreateProductOptionDTO, sharedContext?: Context): Promise<ProductOptionDTO>;
+    /**
+     * This method updates existing options, or creates new ones if they don't exist.
+     *
+     * @param {UpsertProductOptionDTO[]} data - The attributes to update or create for each option.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionDTO[]>} The updated and created options.
+     *
+     * @example
+     * const options = await productModuleService.upsertProductOptions([
+     *   {
+     *     id: "opt_123",
+     *     title: "Color",
+     *   },
+     *   {
+     *     title: "Color",
+     *     values: ["Blue", "Green"],
+     *     product_id: "prod_123",
+     *   },
+     * ])
+     */
+    upsertProductOptions(data: UpsertProductOptionDTO[], sharedContext?: Context): Promise<ProductOptionDTO[]>;
+    /**
+     * This method updates an existing option, or creates a new one if it doesn't exist.
+     *
+     * @param {UpsertProductOptionDTO} data - The attributes to update or create for the option.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionDTO>} The updated or created option.
+     *
+     * @example
+     * const option = await productModuleService.upsertProductOptions({
+     *   id: "opt_123",
+     *   title: "Color",
+     * })
+     */
+    upsertProductOptions(data: UpsertProductOptionDTO, sharedContext?: Context): Promise<ProductOptionDTO>;
+    /**
+     * This method is used to update a option.
+     *
+     * @param {string} id - The ID of the option to be updated.
+     * @param {UpdateProductOptionDTO} data - The attributes of the option to be updated
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionDTO>} The updated option.
+     *
+     * @example
+     * const option = await productModuleService.updateProductOptions(
+     *   "opt_123",
+     *   {
+     *     title: "Color",
+     *   }
+     * )
+     */
+    updateProductOptions(id: string, data: UpdateProductOptionDTO, sharedContext?: Context): Promise<ProductOptionDTO>;
+    /**
+     * This method is used to update a list of options matching the specified filters.
+     *
+     * @param {FilterableProductOptionProps} selector - The filters specifying which options to update.
+     * @param {UpdateProductOptionDTO} data - The attributes to be updated on the selected options
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionDTO[]>} The updated options.
+     *
+     * @example
+     * const options = await productModuleService.updateProductOptions(
+     *   {
+     *     title: "Color",
+     *   },
+     *   {
+     *     values: ["Blue", "Green"],
+     *   }
+     * )
+     */
+    updateProductOptions(selector: FilterableProductOptionProps, data: UpdateProductOptionDTO, sharedContext?: Context): Promise<ProductOptionDTO[]>;
+    /**
+     * This method is used to delete a product option.
+     *
+     * @param {string[]} productOptionIds - The IDs of the product options to delete.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the product options are successfully deleted.
+     *
+     * @example
+     * await productModuleService.deleteProductOptions([
+     *   "opt_123",
+     *   "opt_321",
+     * ])
+     */
+    deleteProductOptions(productOptionIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method is used to delete options. Unlike the {@link delete} method, this method won't completely remove the option. It can still be accessed or retrieved using methods like {@link retrieve} if you pass the `withDeleted` property to the `config` object parameter.
+     *
+     * The soft-deleted options can be restored using the {@link restore} method.
+     *
+     * @param {string[]} optionIds - The IDs of the options to soft-delete.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to soft delete along with the each of the options. You can pass to its `returnLinkableKeys`
+     * property any of the option's relation attribute names, such as `option_value_id`.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were also soft deleted. The object's keys are the ID attribute names of the option entity's relations, and its value is an array of strings, each being the ID of a record associated with the option through this relation.
+     *
+     * If there are no related records, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.softDeleteProductOptions([
+     *   "opt_123",
+     *   "opt_321",
+     * ])
+     */
+    softDeleteProductOptions<TReturnableLinkableKeys extends string = string>(optionIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to restore options which were deleted using the {@link softDelete} method.
+     *
+     * @param {string[]} optionIds - The IDs of the options to restore.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to restore along with each of the options. You can pass to its `returnLinkableKeys`
+     * property any of the option's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the option entity's relations, and its value is an array of strings, each being the ID of the record associated with the option through this relation.
+     *
+     * If there are no related records that were restored, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.restoreProductOptions([
+     *   "opt_123",
+     *   "opt_321",
+     * ])
+     */
+    restoreProductOptions<TReturnableLinkableKeys extends string = string>(optionIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to retrieve a paginated list of product option values based on optional filters and configuration.
+     *
+     * @param {FilterableProductOptionValueProps} filters - The filters applied on the retrieved product option values.
+     * @param {FindConfig<ProductOptionValueDTO>} config -
+     * The configurations determining how the product option values are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product option.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionValueDTO[]>} The list of product option values.
+     *
+     * @example
+     * To retrieve a list of product option values using their IDs:
+     *
+     * ```ts
+     * const options = await productModuleService.listProductOptionValues({
+      id: ["optval_123", "optval_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product option values:
+     *
+     * ```ts
+     * const options = await productModuleService.listProductOptionValues(
+     *   {
+     *     id: ["optval_123", "optval_321"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const options = await productModuleService.listProductOptionValues(
+     *   {
+     *     id: ["optval_123", "optval_321"],
+     *   },
+     *   {
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     *
+     */
+    listProductOptionValues(filters?: FilterableProductOptionValueProps, config?: FindConfig<ProductOptionValueDTO>, sharedContext?: Context): Promise<ProductOptionValueDTO[]>;
+    /**
+     * This method is used to retrieve a paginated list of product option values along with the total count of available product option values satisfying the provided filters.
+     *
+     * @param {FilterableProductOptionValueProps} filters - The filters applied on the retrieved product option values.
+     * @param {FindConfig<ProductOptionValueDTO>} config -
+     * The configurations determining how the product option values are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product option.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[ProductOptionValueDTO[], number]>} The list of product option values along with the total count.
+     *
+     * @example
+     * To retrieve a list of product option values using their IDs:
+     *
+     * ```ts
+     * const [options, count] =
+     *   await productModuleService.listAndCountProductOptionValues({
+     *     id: ["optval_123", "optval_321"],
+     *   })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product types:
+     *
+     * ```ts
+     * const [options, count] =
+     *   await productModuleService.listAndCountProductOptionValues(
+     *     {
+     *       id: ["optval_123", "optval_321"],
+     *     }
+     *   )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [options, count] =
+     *   await productModuleService.listAndCountProductOptionValues(
+     *     {
+     *       id: ["optval_123", "optval_321"],
+     *     },
+     *     {
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listAndCountProductOptionValues(filters?: FilterableProductOptionValueProps, config?: FindConfig<ProductOptionValueDTO>, sharedContext?: Context): Promise<[ProductOptionValueDTO[], number]>;
+    /**
+     * This method is used to create product option values.
+     *
+     * @param {CreateProductOptionValueDTO[]} data - The product option values to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionValueDTO[]>} The list of created product option values.
+     *
+     * @example
+     * const options = await productModuleService.createProductOptionValues([
+     *   {
+     *     value: "Blue",
+     *     option_id: "opt_123",
+     *   },
+     *   {
+     *     value: "Green",
+     *     option_id: "opt_123",
+     *   },
+     * ])
+     *
+     */
+    createProductOptionValues(data: CreateProductOptionValueDTO[], sharedContext?: Context): Promise<ProductOptionValueDTO[]>;
+    /**
+     * This method is used to create a product option.
+     *
+     * @param {CreateProductOptionValueDTO} data - The product option to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionValueDTO>} The created product option.
+     *
+     * @example
+     * const option = await productModuleService.createProductOptionValues({
+     *   value: "Blue",
+     *   option_id: "opt_123",
+     * })
+     *
+     */
+    createProductOptionValues(data: CreateProductOptionValueDTO, sharedContext?: Context): Promise<ProductOptionValueDTO>;
+    /**
+     * This method is used to update a option.
+     *
+     * @param {string} id - The ID of the option to be updated.
+     * @param {UpdateProductOptionValueDTO} data - The attributes of the option to be updated
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionValueDTO>} The updated option.
+     *
+     * @example
+     * const option = await productModuleService.updateProductOptionValues(
+     *   "optval_123",
+     *   {
+     *     value: "Green",
+     *   }
+     * )
+     */
+    updateProductOptionValues(id: string, data: UpdateProductOptionValueDTO, sharedContext?: Context): Promise<ProductOptionValueDTO>;
+    /**
+     * This method is used to update a list of options matching the specified filters.
+     *
+     * @param {FilterableProductOptionValueProps} selector - The filters specifying which options to update.
+     * @param {UpdateProductOptionValueDTO} data - The attributes to be updated on the selected options
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductOptionValueDTO[]>} The updated options.
+     *
+     * @example
+     * const options = await productModuleService.updateProductOptionValues(
+     *   {
+     *     value: "Green",
+     *   },
+     *   {
+     *     value: ["Red"],
+     *   }
+     * )
+     */
+    updateProductOptionValues(selector: FilterableProductOptionValueProps, data: UpdateProductOptionValueDTO, sharedContext?: Context): Promise<ProductOptionValueDTO[]>;
+    /**
+     * This method is used to delete a product option.
+     *
+     * @param {string[]} productOptionValueIds - The IDs of the product option values to delete.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the product option values are successfully deleted.
+     *
+     * @example
+     * await productModuleService.deleteProductOptionValues([
+     *   "optval_123",
+     *   "optval_321",
+     * ])
+     */
+    deleteProductOptionValues(productOptionValueIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method is used to delete options. Unlike the {@link delete} method, this method won't completely remove the option. It can still be accessed or retrieved using methods like {@link retrieve} if you pass the `withDeleted` property to the `config` object parameter.
+     *
+     * The soft-deleted options can be restored using the {@link restore} method.
+     *
+     * @param {string[]} optionIds - The IDs of the options to soft-delete.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to soft delete along with the each of the options. You can pass to its `returnLinkableKeys`
+     * property any of the option's relation attribute names, such as `option_value_id`.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were also soft deleted. The object's keys are the ID attribute names of the option entity's relations, and its value is an array of strings, each being the ID of a record associated with the option through this relation.
+     *
+     * If there are no related records, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.softDeleteProductOptionValues([
+     *   "optval_123",
+     *   "optval_321",
+     * ])
+     */
+    softDeleteProductOptionValues<TReturnableLinkableKeys extends string = string>(optionIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to restore options which were deleted using the {@link softDelete} method.
+     *
+     * @param {string[]} optionIds - The IDs of the options to restore.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to restore along with each of the options. You can pass to its `returnLinkableKeys`
+     * property any of the option's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the option entity's relations, and its value is an array of strings, each being the ID of the record associated with the option through this relation.
+     *
+     * If there are no related records that were restored, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.restoreProductOptionValues([
+     *   "optval_123",
+     *   "optval_321",
+     * ])
+     */
+    restoreProductOptionValues<TReturnableLinkableKeys extends string = string>(optionIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to retrieve a product variant by its ID.
+     *
+     * @param {string} productVariantId - The ID of the product variant to retrieve.
+     * @param {FindConfig<ProductVariantDTO>} config -
+     * The configurations determining how the product variant is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product variant.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductVariantDTO>} The retrieved product variant.
+     *
+     * @example
+     * A simple example that retrieves a product variant by its ID:
+     *
+     * ```ts
+     * const variant =
+     *   await productModuleService.retrieveProductVariant("variant_123")
+     * ```
+     *
+     * To specify relations that should be retrieved:
+     *
+     * ```ts
+     * const variant = await productModuleService.retrieveProductVariant(
+     *   "variant_123",
+     *   {
+     *     relations: ["options"],
+     *   }
+     * )
+     * ```
+     */
+    retrieveProductVariant(productVariantId: string, config?: FindConfig<ProductVariantDTO>, sharedContext?: Context): Promise<ProductVariantDTO>;
+    /**
+     * This method is used to retrieve a paginated list of product variants based on optional filters and configuration.
+     *
+     * @param {FilterableProductVariantProps} filters - The filters applied on the retrieved product variants.
+     * @param {FindConfig<ProductVariantDTO>} config -
+     * The configurations determining how the product variants are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product variant.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductVariantDTO[]>} The list of product variants.
+     *
+     * @example
+     * To retrieve a list of product variants using their IDs:
+     *
+     * ```ts
+     * const variants = await productModuleService.listProductVariants({
+     *   id: ["variant_123", "variant_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product variants:
+     *
+     * ```ts
+     * const variants = await productModuleService.listProductVariants(
+     *   {
+     *     id: ["variant_123", "variant_321"],
+     *   },
+     *   {
+     *     relations: ["options"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const variants = await productModuleService.listProductVariants(
+     *   {
+     *     id: ["variant_123", "variant_321"],
+     *   },
+     *   {
+     *     relations: ["options"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
+    listProductVariants(filters?: FilterableProductVariantProps, config?: FindConfig<ProductVariantDTO>, sharedContext?: Context): Promise<ProductVariantDTO[]>;
+    /**
+     * This method is used to retrieve a paginated list of product variants along with the total count of available product variants satisfying the provided filters.
+     *
+     * @param {FilterableProductVariantProps} filters - The filters applied on the retrieved product variants.
+     * @param {FindConfig<ProductVariantDTO>} config -
+     * The configurations determining how the product variants are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product variant.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[ProductVariantDTO[], number]>} The list of product variants along with their total count.
+     *
+     * @example
+     * To retrieve a list of product variants using their IDs:
+     *
+     * ```ts
+     * const [variants, count] =
+     *   await productModuleService.listAndCountProductVariants({
+     *     id: ["variant_123", "variant_321"],
+     *   })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product variants:
+     *
+     * ```ts
+     * const [variants, count] =
+     *   await productModuleService.listAndCountProductVariants(
+     *     {
+     *       id: ["variant_123", "variant_321"],
+     *     },
+     *     {
+     *       relations: ["options"],
+     *     }
+     *   )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [variants, count] =
+     *   await productModuleService.listAndCountProductVariants(
+     *     {
+     *       id: ["variant_123", "variant_321"],
+     *     },
+     *     {
+     *       relations: ["options"],
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listAndCountProductVariants(filters?: FilterableProductVariantProps, config?: FindConfig<ProductVariantDTO>, sharedContext?: Context): Promise<[ProductVariantDTO[], number]>;
+    /**
+     * This method is used to create product variants.
+     *
+     * @param {CreateProductVariantDTO[]} data - The product variants to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductVariantDTO[]>} The list of created product variants.
+     *
+     * @example
+     * const variants = await productModuleService.createProductVariants([
+     *   {
+     *     title: "Blue Shirt",
+     *     product_id: "prod_123",
+     *     options: {
+     *       Color: "Blue",
+     *     },
+     *   },
+     *   {
+     *     title: "Green Shirt",
+     *     product_id: "prod_321",
+     *     options: {
+     *       Color: "Green",
+     *     },
+     *   },
+     * ])
+     *
+     */
+    createProductVariants(data: CreateProductVariantDTO[], sharedContext?: Context): Promise<ProductVariantDTO[]>;
+    /**
+     * This method is used to create a product variant.
+     *
+     * @param {CreateProductVariantDTO} data - The product variant to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductVariantDTO>} The created product variant.
+     *
+     * @example
+     * const variant = await productModuleService.createProductVariants({
+     *   title: "Blue Shirt",
+     *   product_id: "prod_123",
+     *   options: {
+     *     Color: "Blue",
+     *   },
+     * })
+     *
+     */
+    createProductVariants(data: CreateProductVariantDTO, sharedContext?: Context): Promise<ProductVariantDTO>;
+    /**
+     * This method updates existing variants, or creates new ones if they don't exist.
+     *
+     * @param {UpsertProductVariantDTO[]} data - The attributes to update or create for each variant.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductVariantDTO[]>} The updated and created variants.
+     *
+     * @example
+     * const variants = await productModuleService.upsertProductVariants([
+     *   {
+     *     id: "variant_123",
+     *     title: "Green Shirt",
+     *   },
+     *   {
+     *     title: "Blue Shirt",
+     *     options: {
+     *       Color: "Blue",
+     *     },
+     *   },
+     * ])
+     */
+    upsertProductVariants(data: UpsertProductVariantDTO[], sharedContext?: Context): Promise<ProductVariantDTO[]>;
+    /**
+     * This method updates an existing variant, or creates a new one if it doesn't exist.
+     *
+     * @param {UpsertProductVariantDTO} data - The attributes to update or create for the variant.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductVariantDTO>} The updated or created variant.
+     *
+     * @example
+     * const variant = await productModuleService.upsertProductVariants({
+     *   id: "variant_123",
+     *   title: "Green Shirt",
+     * })
+     */
+    upsertProductVariants(data: UpsertProductVariantDTO, sharedContext?: Context): Promise<ProductVariantDTO>;
+    /**
+     * This method is used to update a variant.
+     *
+     * @param {string} id - The ID of the variant to be updated.
+     * @param {UpdateProductVariantDTO} data - The attributes of the variant to be updated
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductVariantDTO>} The updated variant.
+     *
+     * @example
+     * const variant = await productModuleService.updateProductVariants(
+     *   "variant_123",
+     *   {
+     *     title: "Blue Shirt",
+     *   }
+     * )
+     */
+    updateProductVariants(id: string, data: UpdateProductVariantDTO, sharedContext?: Context): Promise<ProductVariantDTO>;
+    /**
+     * This method is used to update a list of variants matching the specified filters.
+     *
+     * @param {FilterableProductVariantProps} selector - The filters specifying which variants to update.
+     * @param {UpdateProductVariantDTO} data - The attributes to be updated on the selected variants
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductVariantDTO[]>} The updated variants.
+     *
+     * @example
+     * const variants = await productModuleService.updateProductVariants(
+     *   {
+     *     id: ["variant_123", "variant_321"],
+     *   },
+     *   {
+     *     title: "Blue Shirt",
+     *   }
+     * )
+     */
+    updateProductVariants(selector: FilterableProductVariantProps, data: UpdateProductVariantDTO, sharedContext?: Context): Promise<ProductVariantDTO[]>;
+    /**
+     * This method is used to delete ProductVariant. This method will completely remove the ProductVariant and they can no longer be accessed or retrieved.
+     *
+     * @param {string[]} productVariantIds - The IDs of the ProductVariant to be deleted.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the ProductVariant are successfully deleted.
+     *
+     * @example
+     * await productModuleService.deleteProductVariants([
+     *   "variant_123",
+     *   "variant_321",
+     * ])
+     */
+    deleteProductVariants(productVariantIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method is used to delete variants. Unlike the {@link delete} method, this method won't completely remove the variant. It can still be accessed or retrieved using methods like {@link retrieve} if you pass the `withDeleted` property to the `config` object parameter.
+     *
+     * The soft-deleted variants can be restored using the {@link restore} method.
+     *
+     * @param {string[]} variantIds - The IDs of the variants to soft-delete.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to soft delete along with the each of the variants. You can pass to its `returnLinkableKeys`
+     * property any of the variant's relation attribute names, such as `option_value_id`.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were also soft deleted. The object's keys are the ID attribute names of the variant entity's relations, and its value is an array of strings, each being the ID of a record associated with the variant through this relation.
+     *
+     * If there are no related records, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.softDeleteProductVariants([
+     *   "variant_123",
+     *   "variant_321",
+     * ])
+     */
+    softDeleteProductVariants<TReturnableLinkableKeys extends string = string>(variantIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to restore variants which were deleted using the {@link softDelete} method.
+     *
+     * @param {string[]} variantIds - The IDs of the variants to restore.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to restore along with each of the variants. You can pass to its `returnLinkableKeys`
+     * property any of the variant's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the variant entity's relations, and its value is an array of strings, each being the ID of the record associated with the variant through this relation.
+     *
+     * If there are no related records that were restored, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.restoreProductVariants([
+     *   "variant_123",
+     *   "variant_321",
+     * ])
+     */
+    restoreProductVariants<TReturnableLinkableKeys extends string = string>(variantIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to retrieve a product collection by its ID.
+     *
+     * @param {string} productCollectionId - The ID of the product collection to retrieve.
+     * @param {FindConfig<ProductCollectionDTO>} config -
+     * The configurations determining how the product collection is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product collection.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCollectionDTO>} The retrieved product collection.
+     *
+     * @example
+     * A simple example that retrieves a product collection by its ID:
+     *
+     * ```ts
+     * const collection =
+     *   await productModuleService.retrieveProductCollection("pcol_123")
+     * ```
+     *
+     * To specify relations that should be retrieved:
+     *
+     * ```ts
+     * const collection =
+     *   await productModuleService.retrieveProductCollection("pcol_123", {
+     *     relations: ["products"],
+     *   })
+     * ```
+     */
+    retrieveProductCollection(productCollectionId: string, config?: FindConfig<ProductCollectionDTO>, sharedContext?: Context): Promise<ProductCollectionDTO>;
+    /**
+     * This method is used to retrieve a paginated list of product collections based on optional filters and configuration.
+     *
+     * @param {FilterableProductCollectionProps} filters - The filters applied on the retrieved product collections.
+     * @param {FindConfig<ProductCollectionDTO>} config -
+     * The configurations determining how the product collections are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product collection.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCollectionDTO[]>} The list of product collections.
+     *
+     * @example
+     * To retrieve a list of product collections using their IDs:
+     *
+     * ```ts
+     * const collections =
+     *   await productModuleService.listProductCollections({
+     *     id: ["pcol_123", "pcol_321"],
+     *   })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product collections:
+     *
+     * ```ts
+     * const collections =
+     *   await productModuleService.listProductCollections(
+     *     {
+     *       id: ["pcol_123", "pcol_321"],
+     *     },
+     *     {
+     *       relations: ["products"],
+     *     }
+     *   )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const collections =
+     *   await productModuleService.listProductCollections(
+     *     {
+     *       id: ["pcol_123", "pcol_321"],
+     *     },
+     *     {
+     *       relations: ["products"],
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listProductCollections(filters?: FilterableProductCollectionProps, config?: FindConfig<ProductCollectionDTO>, sharedContext?: Context): Promise<ProductCollectionDTO[]>;
+    /**
+     * This method is used to retrieve a paginated list of product collections along with the total count of available product collections satisfying the provided filters.
+     *
+     * @param {FilterableProductCollectionProps} filters - The filters applied on the retrieved product collections.
+     * @param {FindConfig<ProductCollectionDTO>} config -
+     * The configurations determining how the product collections are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product collection.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[ProductCollectionDTO[], number]>} The list of product collections along with the total count.
+     *
+     * @example
+     * To retrieve a list of product collections using their IDs:
+     *
+     * ```ts
+     * const [collections, count] =
+     *   await productModuleService.listAndCountProductCollections({
+     *     id: ["pcol_123", "pcol_321"],
+     *   })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product collections:
+     *
+     * ```ts
+     * const [collections, count] =
+     *   await productModuleService.listAndCountProductCollections(
+     *     {
+     *       id: ["pcol_123", "pcol_321"],
+     *     },
+     *     {
+     *       relations: ["products"],
+     *     }
+     *   )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [collections, count] =
+     *   await productModuleService.listAndCountProductCollections(
+     *     {
+     *       id: ["pcol_123", "pcol_321"],
+     *     },
+     *     {
+     *       relations: ["products"],
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listAndCountProductCollections(filters?: FilterableProductCollectionProps, config?: FindConfig<ProductCollectionDTO>, sharedContext?: Context): Promise<[ProductCollectionDTO[], number]>;
+    /**
+     * This method is used to create product collections.
+     *
+     * @param {CreateProductCollectionDTO[]} data - The product collections to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCollectionDTO[]>} The list of created product collections.
+     *
+     * @example
+     * const collections =
+     *   await productModuleService.createProductCollections([
+     *     {
+     *       title: "Summer Collection",
+     *     },
+     *     {
+     *       title: "Winter Collection",
+     *     },
+     *   ])
+     *
+     */
+    createProductCollections(data: CreateProductCollectionDTO[], sharedContext?: Context): Promise<ProductCollectionDTO[]>;
+    /**
+     * This method is used to create a product collection.
+     *
+     * @param {CreateProductCollectionDTO} data - The product collection to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCollectionDTO>} The created product collection.
+     *
+     * @example
+     * const collection =
+     *   await productModuleService.createProductCollections({
+     *     title: "Summer Collection",
+     *   })
+     *
+     */
+    createProductCollections(data: CreateProductCollectionDTO, sharedContext?: Context): Promise<ProductCollectionDTO>;
+    /**
+     * This method updates existing collections, or creates new ones if they don't exist.
+     *
+     * @param {UpsertProductCollectionDTO[]} data - The attributes to update or create for each collection.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCollectionDTO[]>} The updated and created collections.
+     *
+     * @example
+     * const collections =
+     *   await productModuleService.upsertProductCollections([
+     *     {
+     *       id: "pcol_123",
+     *       title: "Winter Collection",
+     *     },
+     *     {
+     *       title: "Summer Collection",
+     *     },
+     *   ])
+     */
+    upsertProductCollections(data: UpsertProductCollectionDTO[], sharedContext?: Context): Promise<ProductCollectionDTO[]>;
+    /**
+     * This method updates an existing collection, or creates a new one if it doesn't exist.
+     *
+     * @param {UpsertProductCollectionDTO} data - The attributes to update or create for the collection.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCollectionDTO>} The updated or created collection.
+     *
+     * @example
+     * const collection =
+     *   await productModuleService.upsertProductCollections({
+     *     id: "pcol_123",
+     *     title: "Winter Collection",
+     *   })
+     */
+    upsertProductCollections(data: UpsertProductCollectionDTO, sharedContext?: Context): Promise<ProductCollectionDTO>;
+    /**
+     * This method is used to update a collection.
+     *
+     * @param {string} id - The ID of the collection to be updated.
+     * @param {UpdateProductCollectionDTO} data - The attributes of the collection to be updated
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCollectionDTO>} The updated collection.
+     *
+     * @example
+     * const collection =
+     *   await productModuleService.updateProductCollections("pcol_123", {
+     *     title: "Summer Collection",
+     *   })
+     */
+    updateProductCollections(id: string, data: UpdateProductCollectionDTO, sharedContext?: Context): Promise<ProductCollectionDTO>;
+    /**
+     * This method is used to update a list of collections matching the specified filters.
+     *
+     * @param {FilterableProductCollectionProps} selector - The filters specifying which collections to update.
+     * @param {UpdateProductCollectionDTO} data - The attributes to be updated on the selected collections
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCollectionDTO[]>} The updated collections.
+     *
+     * @example
+     * const collections =
+     *   await productModuleService.updateProductCollections(
+     *     {
+     *       id: ["pcol_123", "pcol_321"],
+     *     },
+     *     {
+     *       title: "Summer Collection",
+     *     }
+     *   )
+     */
+    updateProductCollections(selector: FilterableProductCollectionProps, data: UpdateProductCollectionDTO, sharedContext?: Context): Promise<ProductCollectionDTO[]>;
+    /**
+     * This method is used to delete collections by their ID.
+     *
+     * @param {string[]} productCollectionIds - The IDs of the product collections to be updated.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the product options are successfully deleted.
+     *
+     * @example
+     * await productModuleService.deleteProductCollections([
+     *   "pcol_123",
+     *   "pcol_321",
+     * ])
+     *
+     */
+    deleteProductCollections(productCollectionIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method is used to delete product collections. Unlike the {@link deleteCollections} method, this method won't completely remove the collection. It can still be accessed or retrieved using methods like {@link retrieveCollections} if you pass the `withDeleted` property to the `config` object parameter.
+     *
+     * The soft-deleted collections can be restored using the {@link restoreCollections} method.
+     *
+     * @param {string[]} collectionIds - The IDs of the collections to soft-delete.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to soft delete along with the each of the collections. You can pass to its `returnLinkableKeys`
+     * property any of the collection's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were also soft deleted. The object's keys are the ID attribute names of the collection entity's relations.
+     *
+     * If there are no related records, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.softDeleteProductCollections([
+     *   "pcol_123",
+     *   "pcol_321",
+     * ])
+     */
+    softDeleteProductCollections<TReturnableLinkableKeys extends string = string>(collectionIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to restore collections which were deleted using the {@link softDelete} method.
+     *
+     * @param {string[]} collectionIds - The IDs of the collections to restore.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to restore along with each of the collections. You can pass to its `returnLinkableKeys`
+     * property any of the collection's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the product entity's relations.
+     *
+     * If there are no related records that were restored, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.restoreProductCollections([
+     *   "pcol_123",
+     *   "pcol_321",
+     * ])
+     */
+    restoreProductCollections<TReturnableLinkableKeys extends string = string>(collectionIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to retrieve a product category by its ID.
+     *
+     * @param {string} productCategoryId - The ID of the product category to retrieve.
+     * @param {FindConfig<ProductCategoryDTO>} config -
+     * The configurations determining how the product category is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product category.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCategoryDTO>} The retrieved product category.
+     *
+     * @example
+     * A simple example that retrieves a product category by its ID:
+     *
+     * ```ts
+     * const category =
+     *   await productModuleService.retrieveProductCategory("pcat_123")
+     * ```
+     *
+     * To specify relations that should be retrieved:
+     *
+     * ```ts
+     * const category = await productModuleService.retrieveProductCategory(
+     *   "pcat_123",
+     *   {
+     *     relations: ["products"],
+     *   }
+     * )
+     * ```
+     */
+    retrieveProductCategory(productCategoryId: string, config?: FindConfig<ProductCategoryDTO>, sharedContext?: Context): Promise<ProductCategoryDTO>;
+    /**
+     * This method is used to retrieve a paginated list of product categories based on optional filters and configuration.
+     *
+     * @param {FilterableProductCategoryProps} filters - The filters to be applied on the retrieved product categories.
+     * @param {FindConfig<ProductCategoryDTO>} config -
+     * The configurations determining how the product categories are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product category.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCategoryDTO[]>} The list of product categories.
+     *
+     * @example
+     * To retrieve a list of product categories using their IDs:
+     *
+     * ```ts
+     * const categories = await productModuleService.listProductCategories({
+     *   id: ["pcat_123", "pcat_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product categories:
+     *
+     * ```ts
+     * const categories = await productModuleService.listProductCategories(
+     *   {
+     *     id: ["pcat_123", "pcat_321"],
+     *   },
+     *   {
+     *     relations: ["products"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const categories = await productModuleService.listProductCategories(
+     *   {
+     *     id: ["pcat_123", "pcat_321"],
+     *   },
+     *   {
+     *     relations: ["products"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
+    listProductCategories(filters?: FilterableProductCategoryProps, config?: FindConfig<ProductCategoryDTO>, sharedContext?: Context): Promise<ProductCategoryDTO[]>;
+    /**
+     * This method is used to retrieve a paginated list of product categories along with the total count of available product categories satisfying the provided filters.
+     *
+     * @param {FilterableProductCategoryProps} filters - The filters to apply on the retrieved product categories.
+     * @param {FindConfig<ProductCategoryDTO>} config -
+     * The configurations determining how the product categories are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a product category.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[ProductCategoryDTO[], number]>} The list of product categories along with their total count.
+     *
+     * @example
+     * To retrieve a list of product categories using their IDs:
+     *
+     * ```ts
+     * const [categories, count] =
+     *   await productModuleService.listAndCountProductCategories({
+     *     id: ["pcat_123", "pcat_321"],
+     *   })
+     * ```
+     *
+     * To specify relations that should be retrieved within the product categories:
+     *
+     * ```ts
+     * const [categories, count] =
+     *   await productModuleService.listAndCountProductCategories(
+     *     {
+     *       id: ["pcat_123", "pcat_321"],
+     *     },
+     *     {
+     *       relations: ["products"],
+     *     }
+     *   )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [categories, count] =
+     *   await productModuleService.listAndCountProductCategories(
+     *     {
+     *       id: ["pcat_123", "pcat_321"],
+     *     },
+     *     {
+     *       relations: ["products"],
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listAndCountProductCategories(filters?: FilterableProductCategoryProps, config?: FindConfig<ProductCategoryDTO>, sharedContext?: Context): Promise<[ProductCategoryDTO[], number]>;
+    /**
+     * This method is used to create product categories.
+     *
+     * @param {CreateProductCategoryDTO[]} data - The product categories to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCategoryDTO[]>} The list of created product categories.
+     *
+     * @example
+     * const categories =
+     *   await productModuleService.createProductCategories([
+     *     {
+     *       name: "Tools",
+     *     },
+     *     {
+     *       name: "Clothing",
+     *     },
+     *   ])
+     *
+     */
+    createProductCategories(data: CreateProductCategoryDTO[], sharedContext?: Context): Promise<ProductCategoryDTO[]>;
+    /**
+     * This method is used to create a product category.
+     *
+     * @param {CreateProductCategoryDTO} data - The product category to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCategoryDTO>} The created product category.
+     *
+     * @example
+     * const category =
+     *   await productModuleService.createProductCategories({
+     *     name: "Tools",
+     *   })
+     *
+     */
+    createProductCategories(data: CreateProductCategoryDTO, sharedContext?: Context): Promise<ProductCategoryDTO>;
+    /**
+     * This method updates existing categories, or creates new ones if they don't exist.
+     *
+     * @param {UpsertProductCategoryDTO[]} data - The attributes to update or create for each category.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCategoryDTO[]>} The updated and created categories.
+     *
+     * @example
+     * const categories =
+     *   await productModuleService.upsertProductCategories([
+     *     {
+     *       id: "pcat_123",
+     *       name: "Clothing",
+     *     },
+     *     {
+     *       name: "Tools",
+     *     },
+     *   ])
+     */
+    upsertProductCategories(data: UpsertProductCategoryDTO[], sharedContext?: Context): Promise<ProductCategoryDTO[]>;
+    /**
+     * This method updates an existing category, or creates a new one if it doesn't exist.
+     *
+     * @param {UpsertProductCategoryDTO} data - The attributes to update or create for the category.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCategoryDTO>} The updated or created category.
+     *
+     * @example
+     * const category =
+     *   await productModuleService.upsertProductCategories({
+     *     id: "pcat_123",
+     *     name: "Clothing",
+     *   })
+     */
+    upsertProductCategories(data: UpsertProductCategoryDTO, sharedContext?: Context): Promise<ProductCategoryDTO>;
+    /**
+     * This method is used to update a category.
+     *
+     * @param {string} id - The ID of the category to be updated.
+     * @param {UpdateProductCategoryDTO} data - The attributes of the category to be updated
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCategoryDTO>} The updated category.
+     *
+     * @example
+     * const category =
+     *   await productModuleService.updateProductCategories("pcat_123", {
+     *     title: "Tools",
+     *   })
+     */
+    updateProductCategories(id: string, data: UpdateProductCategoryDTO, sharedContext?: Context): Promise<ProductCategoryDTO>;
+    /**
+     * This method is used to update a list of categories matching the specified filters.
+     *
+     * @param {FilterableProductCategoryProps} selector - The filters specifying which categories to update.
+     * @param {UpdateProductCategoryDTO} data - The attributes to be updated on the selected categories
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProductCategoryDTO[]>} The updated categories.
+     *
+     * @example
+     * const categories =
+     *   await productModuleService.updateProductCategories(
+     *     {
+     *       id: ["pcat_123", "pcat_321"],
+     *     },
+     *     {
+     *       title: "Tools",
+     *     }
+     *   )
+     */
+    updateProductCategories(selector: FilterableProductCategoryProps, data: UpdateProductCategoryDTO, sharedContext?: Context): Promise<ProductCategoryDTO[]>;
+    /**
+     * This method is used to delete categories by their ID.
+     *
+     * @param {string[]} productCategoryIds - The IDs of the product categories to be updated.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the product options are successfully deleted.
+     *
+     * @example
+     * await productModuleService.deleteProductCategories([
+     *   "pcat_123",
+     *   "pcat_321",
+     * ])
+     *
+     */
+    deleteProductCategories(productCategoryIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method is used to delete product categories. Unlike the {@link deleteCategories} method, this method won't completely remove the category. It can still be accessed or retrieved using methods like {@link retrieveCategories} if you pass the `withDeleted` property to the `config` object parameter.
+     *
+     * The soft-deleted categories can be restored using the {@link restoreCategories} method.
+     *
+     * @param {string[]} categoryIds - The IDs of the categories to soft-delete.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to soft delete along with the each of the categories. You can pass to its `returnLinkableKeys`
+     * property any of the category's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were also soft deleted. The object's keys are the ID attribute names of the category entity's relations.
+     *
+     * If there are no related records, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.softDeleteProductCategories([
+     *   "pcat_123",
+     *   "pcat_321",
+     * ])
+     */
+    softDeleteProductCategories<TReturnableLinkableKeys extends string = string>(categoryIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method is used to restore categories which were deleted using the {@link softDelete} method.
+     *
+     * @param {string[]} categoryIds - The IDs of the categories to restore.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config -
+     * Configurations determining which relations to restore along with each of the categories. You can pass to its `returnLinkableKeys`
+     * property any of the category's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Record<string, string[]> | void>}
+     * An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the product entity's relations.
+     *
+     * If there are no related records that were restored, the promise resolved to `void`.
+     *
+     * @example
+     * await productModuleService.restoreProductCategories([
+     *   "pcat_123",
+     *   "pcat_321",
+     * ])
+     */
+    restoreProductCategories<TReturnableLinkableKeys extends string = string>(categoryIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+}
+//# sourceMappingURL=service.d.ts.map