chore(docs): Generated References (automated) (#9727)

Generated the following references: - `api_key` - `auth` - `cart` - `core_flows` - `currency` - `customer` - `dml` - `fulfillment` - `helper_steps` - `inventory_next` - `js_sdk` - `medusa` - `medusa_config` - `modules` - `modules_sdk` - `notification` - `order` - `order_models` - `payment` - `pricing` - `product` - `promotion` - `region` - `sales_channel` - `stock_location_next` - `store` - `tax` - `tax_provider` - `types` - `user` - `utils` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:41:14 +00:00
1 parent e196ad7659
commit 5deeae060a
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `addLineItemAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## addLineItemAdjustments(data): Promise&#60;[LineItemAdjustmentDTO](../../../interfaces/cart.LineItemAdjustmentDTO/page.mdx)[]&#62;

 This method adds line item adjustments to line items.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `addLineItemTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## addLineItemTaxLines(taxLines): Promise&#60;[LineItemTaxLineDTO](../../../interfaces/cart.LineItemTaxLineDTO/page.mdx)[]&#62;

 This method creates and adds line item tax lines.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `addLineItems` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## addLineItems(data): Promise&#60;[CartLineItemDTO](../../../interfaces/cart.CartLineItemDTO/page.mdx)[]&#62;

 This method adds a line item to a cart
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `addShippingMethodAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## addShippingMethodAdjustments(data): Promise&#60;[ShippingMethodAdjustmentDTO](../../../interfaces/cart.ShippingMethodAdjustmentDTO/page.mdx)[]&#62;

 This method adds shipping method adjustments to shipping methods.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `addShippingMethodTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## addShippingMethodTaxLines(taxLines): Promise&#60;[ShippingMethodTaxLineDTO](../../../interfaces/cart.ShippingMethodTaxLineDTO/page.mdx)[]&#62;

 This method creates and adds shipping method tax lines.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `addShippingMethods` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## addShippingMethods(data): Promise&#60;[CartShippingMethodDTO](../../../interfaces/cart.CartShippingMethodDTO/page.mdx)&#62;

 This method adds a shipping method to carts.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `createAddresses` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## createAddresses(data, sharedContext?): Promise&#60;[CartAddressDTO](../../../interfaces/cart.CartAddressDTO/page.mdx)[]&#62;

 This method creates addresses.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `createCarts` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## createCarts(data, sharedContext?): Promise&#60;[CartDTO](../../../interfaces/cart.CartDTO/page.mdx)[]&#62;

 This method creates carts.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteAddresses` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteAddresses(ids, sharedContext?): Promise&#60;void&#62;

 This method deletes addresses by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteCarts` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteCarts(cartIds, sharedContext?): Promise&#60;void&#62;

 This method deletes carts by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteLineItemAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteLineItemAdjustments(ids, sharedContext?): Promise&#60;void&#62;

 This method deletes line item adjustments by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteLineItemTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteLineItemTaxLines(ids, sharedContext?): Promise&#60;void&#62;

 This method deletes line item tax lines by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteLineItems` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteLineItems(ids, sharedContext?): Promise&#60;void&#62;

 This method deletes line items by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteShippingMethodAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteShippingMethodAdjustments(ids, sharedContext?): Promise&#60;void&#62;

 This method deletes shipping method adjustments by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteShippingMethodTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteShippingMethodTaxLines(ids, sharedContext?): Promise&#60;void&#62;

 This method deletes shipping method tax lines by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteShippingMethods` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteShippingMethods(ids, sharedContext?): Promise&#60;void&#62;

 This method deletes shipping methods by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listAddresses` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of addresses based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listAndCountCarts` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of carts along with the total count of available carts satisfying the provided filters.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listCarts` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of carts based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listLineItemAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of line item adjustments based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listLineItemTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of line item tax lines based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listLineItems` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of line items based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listShippingMethodAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of shipping method adjustments based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listShippingMethodTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of shipping method tax lines based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listShippingMethods` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of shipping methods based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restoreAddresses` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method restores soft deleted addresses by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restoreCarts` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method restores soft deleted carts by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restoreLineItemAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method restores soft deleted line item adjustments by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restoreLineItemTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method restores soft deleted line item tax lines by its IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restoreLineItems` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method restores soft deleted line items by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restoreShippingMethodAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method restores soft deleted shipping method adjustments by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restoreShippingMethodTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method restores soft deleted shipping method tax lines by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restoreShippingMethods` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method restores soft deleted shipping methods by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `retrieveCart` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a cart by its ID.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `retrieveLineItem` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a line item by its ID.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `setLineItemAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method set the line item adjustments of line items in a cart. The existing line item adjustments, except those
 included in the specified list, of an item are removed and replaced with the specified adjustments.

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `setLineItemTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method sets the line item tax lines in a cart. The existing line item tax lines,
 except those included in the specified list, are removed and replaced with the specified tax lines.

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `setShippingMethodAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method sets the shipping method adjustment of shipping methods in a cart. The existing shipping method adjustments,
 except those included in the specified list, of an item are removed and replaced with the specified adjustments.

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `setShippingMethodTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method sets the shipping item tax lines in a cart. The shipping line item tax lines,
 except those included in the specified list, are removed and replaced with the specified tax lines.

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeleteAddresses` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method soft deletes addresses by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeleteCarts` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method soft deletes carts by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeleteLineItemAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method soft deletes line item adjustments by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeleteLineItemTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method soft deletes line item tax lines by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeleteLineItems` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method soft deletes line items by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeleteShippingMethodAdjustments` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method soft deletes shipping method adjustments by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeleteShippingMethodTaxLines` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method soft deletes shipping method tax lines by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeleteShippingMethods` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method soft deletes shipping methods by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updateAddresses` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updateAddresses(data, sharedContext?): Promise&#60;[CartAddressDTO](../../../interfaces/cart.CartAddressDTO/page.mdx)[]&#62;

 This method updates existing addresses.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updateCarts` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updateCarts(data): Promise&#60;[CartDTO](../../../interfaces/cart.CartDTO/page.mdx)[]&#62;

 This method updates existing carts.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updateLineItems` method. This belongs to the Cart Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updateLineItems(data): Promise&#60;[CartLineItemDTO](../../../interfaces/cart.CartLineItemDTO/page.mdx)[]&#62;

 This method updates existing line items.