chore(docs): Generated References (medusajs#5743)

Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <[email protected]>
Co-authored-by: Shahed Nasser <[email protected]>

Author: 3 people

packages/types/src/product/service.ts

@@ -1491,11 +1491,57 @@ export interface IProductModuleService {
     sharedContext?: Context
   ): Promise<ProductVariantDTO[]>
 
+  /**
+   * This method is used to update a product's variants.
+   * 
+   * @param {UpdateProductVariantDTO[]} data - The product variants to update.
+   * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+   * @returns {Promise<ProductVariantDTO[]>} The updated product variants's details.
+   * 
+   * @example
+   * import {
+   *   initialize as initializeProductModule,
+   * } from "@medusajs/product"
+   * import { 
+   *   UpdateProductVariantDTO
+   * } from "@medusajs/product/dist/types/services/product-variant"
+   * 
+   * async function updateProductVariants (items: UpdateProductVariantDTO[]) {
+   *   const productModule = await initializeProductModule()
+   * 
+   *   const productVariants = await productModule.updateVariants(items)
+   * 
+   *   // do something with the product variants or return them
+   * }
+   */
   updateVariants(
     data: UpdateProductVariantDTO[],
     sharedContext?: Context
   ): Promise<ProductVariantDTO[]>
 
+  /**
+   * This method is used to create variants for a product.
+   * 
+   * @param {CreateProductVariantDTO[]} data - The product variants to create.
+   * @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 variants' details.
+   * 
+   * @example
+   * import {
+   *   initialize as initializeProductModule,
+   * } from "@medusajs/product"
+   * 
+   * async function createProductVariants (items: {
+   *   product_id: string,
+   *   title: string
+   * }[]) {
+   *   const productModule = await initializeProductModule()
+   * 
+   *   const productVariants = await productModule.createVariants(items)
+   * 
+   *   // do something with the product variants or return them
+   * }
+   */
   createVariants(
     data: CreateProductVariantDTO[],
     sharedContext?: Context
@@ -2437,7 +2483,7 @@ export interface IProductModuleService {
    *
    * @param {string[]} productIds - The IDs of the products to restore.
    * @param {RestoreReturn<TReturnableLinkableKeys>} config -
-   * Configurations determining which relations to restore along with the each of the products. You can pass to its `returnLinkableKeys`
+   * 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>}
@@ -2466,6 +2512,32 @@ export interface IProductModuleService {
     sharedContext?: Context
   ): Promise<Record<string, string[]> | void>
 
+  /**
+   * This method is used to restore product varaints that were soft deleted. Product variants are soft deleted when they're not 
+   * provided in a product's details passed to the {@link update} 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 product variants. You can pass to its `returnLinkableKeys`
+   * property any of the product 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 product variant entity's relations 
+   * and its value is an array of strings, each being the ID of the record associated with the product variant through this relation.
+   *
+   * If there are no related records that were restored, the promise resolved to `void`.
+   *
+   * @example
+   * import {
+   *   initialize as initializeProductModule,
+   * } from "@medusajs/product"
+   *
+   * async function restoreProductVariants (ids: string[]) {
+   *   const productModule = await initializeProductModule()
+   *
+   *   await productModule.restoreVariants(ids)
+   * }
+   */
   restoreVariants<TReturnableLinkableKeys extends string = string>(
     variantIds: string[],
     config?: RestoreReturn<TReturnableLinkableKeys>,

www/apps/docs/content/references/entities/classes/MoneyAmount.mdx

@@ -332,7 +332,7 @@ A Money Amount represent a price amount, for example, a product variant's price
   },
   {
     "name": "region_id",
-    "type": "`string`",
+    "type": "`null` \\| `string`",
     "description": "The region's ID",
     "optional": false,
     "defaultValue": "",

www/apps/docs/content/references/entities/classes/PriceList.mdx

@@ -266,7 +266,7 @@ A Price List represents a set of prices that override the default price for one
       },
       {
         "name": "region_id",
-        "type": "`string`",
+        "type": "`null` \\| `string`",
         "description": "The region's ID",
         "optional": false,
         "defaultValue": "",

www/apps/docs/content/references/entities/classes/ProductVariant.mdx

@@ -437,7 +437,7 @@ A Product Variant represents a Product with a specific set of Product Option con
       },
       {
         "name": "region_id",
-        "type": "`string`",
+        "type": "`null` \\| `string`",
         "description": "The region's ID",
         "optional": false,
         "defaultValue": "",

www/apps/docs/content/references/entities/enums/AllocationType.mdx

@@ -10,15 +10,15 @@ The scope that the discount should apply to.
 
 ## Enumeration Members
 
-### ITEM
+#### ITEM
 
  **ITEM** = `"item"`
 
 The discount should be applied to applicable items in the cart.
 
 ___
 
-### TOTAL
+#### TOTAL
 
  **TOTAL** = `"total"`
 

www/apps/docs/content/references/entities/enums/BatchJobStatus.mdx

@@ -8,42 +8,42 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 ## Enumeration Members
 
-### CANCELED
+#### CANCELED
 
  **CANCELED** = `"canceled"`
 
 ___
 
-### COMPLETED
+#### COMPLETED
 
  **COMPLETED** = `"completed"`
 
 ___
 
-### CONFIRMED
+#### CONFIRMED
 
  **CONFIRMED** = `"confirmed"`
 
 ___
 
-### CREATED
+#### CREATED
 
  **CREATED** = `"created"`
 
 ___
 
-### FAILED
+#### FAILED
 
  **FAILED** = `"failed"`
 
 ___
 
-### PRE\_PROCESSED
+#### PRE\_PROCESSED
 
  **PRE\_PROCESSED** = `"pre_processed"`
 
 ___
 
-### PROCESSING
+#### PROCESSING
 
  **PROCESSING** = `"processing"`

www/apps/docs/content/references/entities/enums/CartType.mdx

@@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 ## Enumeration Members
 
-### CLAIM
+#### CLAIM
 
  **CLAIM** = `"claim"`
 
 ___
 
-### DEFAULT
+#### DEFAULT
 
  **DEFAULT** = `"default"`
 
 ___
 
-### DRAFT\_ORDER
+#### DRAFT\_ORDER
 
  **DRAFT\_ORDER** = `"draft_order"`
 
 ___
 
-### PAYMENT\_LINK
+#### PAYMENT\_LINK
 
  **PAYMENT\_LINK** = `"payment_link"`
 
 ___
 
-### SWAP
+#### SWAP
 
  **SWAP** = `"swap"`

www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx

@@ -10,71 +10,71 @@ The claim's fulfillment status.
 
 ## Enumeration Members
 
-### CANCELED
+#### CANCELED
 
  **CANCELED** = `"canceled"`
 
 The claim's fulfillments are canceled.
 
 ___
 
-### FULFILLED
+#### FULFILLED
 
  **FULFILLED** = `"fulfilled"`
 
 The claim's replacement items are fulfilled.
 
 ___
 
-### NOT\_FULFILLED
+#### NOT\_FULFILLED
 
  **NOT\_FULFILLED** = `"not_fulfilled"`
 
 The claim's replacement items are not fulfilled.
 
 ___
 
-### PARTIALLY\_FULFILLED
+#### PARTIALLY\_FULFILLED
 
  **PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
 
 Some of the claim's replacement items, but not all, are fulfilled.
 
 ___
 
-### PARTIALLY\_RETURNED
+#### PARTIALLY\_RETURNED
 
  **PARTIALLY\_RETURNED** = `"partially_returned"`
 
 Some of the claim's items, but not all, are returned.
 
 ___
 
-### PARTIALLY\_SHIPPED
+#### PARTIALLY\_SHIPPED
 
  **PARTIALLY\_SHIPPED** = `"partially_shipped"`
 
 Some of the claim's replacement items, but not all, are shipped.
 
 ___
 
-### REQUIRES\_ACTION
+#### REQUIRES\_ACTION
 
  **REQUIRES\_ACTION** = `"requires_action"`
 
 The claim's fulfillment requires action.
 
 ___
 
-### RETURNED
+#### RETURNED
 
  **RETURNED** = `"returned"`
 
 The claim's items are returned.
 
 ___
 
-### SHIPPED
+#### SHIPPED
 
  **SHIPPED** = `"shipped"`
 

www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx

@@ -10,23 +10,23 @@ The claim's payment status
 
 ## Enumeration Members
 
-### NA
+#### NA
 
  **NA** = `"na"`
 
 The payment status isn't set, which is typically used when the claim's type is `replace`.
 
 ___
 
-### NOT\_REFUNDED
+#### NOT\_REFUNDED
 
  **NOT\_REFUNDED** = `"not_refunded"`
 
 The payment isn't refunded.
 
 ___
 
-### REFUNDED
+#### REFUNDED
 
  **REFUNDED** = `"refunded"`
 

www/apps/docs/content/references/entities/enums/ClaimReason.mdx

@@ -8,24 +8,24 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 ## Enumeration Members
 
-### MISSING\_ITEM
+#### MISSING\_ITEM
 
  **MISSING\_ITEM** = `"missing_item"`
 
 ___
 
-### OTHER
+#### OTHER
 
  **OTHER** = `"other"`
 
 ___
 
-### PRODUCTION\_FAILURE
+#### PRODUCTION\_FAILURE
 
  **PRODUCTION\_FAILURE** = `"production_failure"`
 
 ___
 
-### WRONG\_ITEM
+#### WRONG\_ITEM
 
  **WRONG\_ITEM** = `"wrong_item"`