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 `addPriceListPrices` method. This belongs to the Pricing 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 is used to add prices to price lists.

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

 This documentation provides a reference to the `addPrices` method. This belongs to the Pricing Module.

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

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

 This documentation provides a reference to the `calculatePrices` method. This belongs to the Pricing 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 is used to calculate prices based on the provided filters and context.

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

 This documentation provides a reference to the `createPriceLists` method. This belongs to the Pricing 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 is used to create price lists.

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

 This documentation provides a reference to the `createPricePreferences` method. This belongs to the Pricing Module.

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

 This method is used to create a new price preference.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `createPriceRules` method. This belongs to the Pricing 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 is used to create new price rules based on the provided data.

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

 This documentation provides a reference to the `createPriceSets` method. This belongs to the Pricing Module.

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

 This method is used to create a new price set.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deletePriceListRules` method. This belongs to the Pricing 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 is used to delete price list rules.

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

 This documentation provides a reference to the `deletePriceLists` method. This belongs to the Pricing 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 is used to delete price lists.

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

 This documentation provides a reference to the `deletePricePreferences` method. This belongs to the Pricing 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 deletes price preferences by their IDs.

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

 This documentation provides a reference to the `deletePriceRules` method. This belongs to the Pricing 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 is used to delete price rules based on the specified IDs.

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

 This documentation provides a reference to the `deletePriceSets` method. This belongs to the Pricing 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 deletes price sets by their IDs.

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

 This documentation provides a reference to the `listAndCountPriceListRules` method. This belongs to the Pricing 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 is used to retrieve a paginated list of price list ruless along with the total count of available price list ruless satisfying the provided filters.

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

 This documentation provides a reference to the `listAndCountPriceLists` method. This belongs to the Pricing 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 is used to retrieve a paginated list of price lists along with the total count of available price lists satisfying the provided filters.

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

 This documentation provides a reference to the `listAndCountPriceRules` method. This belongs to the Pricing 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 is used to retrieve a paginated list of price rules along with the total count of available price rules satisfying the provided filters.

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

 This documentation provides a reference to the `listAndCountPriceSets` method. This belongs to the Pricing 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 is used to retrieve a paginated list of price sets along with the total count of available price sets satisfying the provided filters.

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

 This documentation provides a reference to the `listAndCountPrices` method. This belongs to the Pricing 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 is used to retrieve a paginated list of prices along with the total count of
 available prices satisfying the provided filters.

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

 This documentation provides a reference to the `listPriceListRules` method. This belongs to the Pricing 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 is used to retrieve a paginated list of price list rules based on optional filters and configuration.

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

 This documentation provides a reference to the `listPriceLists` method. This belongs to the Pricing 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 is used to retrieve a paginated list of price lists based on optional filters and configuration.

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

 This documentation provides a reference to the `listPricePreferences` method. This belongs to the Pricing 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 is used to retrieve a paginated list of price preferences based on optional filters and configuration.

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

 This documentation provides a reference to the `listPriceRules` method. This belongs to the Pricing 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 is used to retrieve a paginated list of price rules based on optional filters and configuration.

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

 This documentation provides a reference to the `listPriceSets` method. This belongs to the Pricing 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 is used to retrieve a paginated list of price sets based on optional filters and configuration.

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

 This documentation provides a reference to the `listPrices` method. This belongs to the Pricing 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 is used to retrieve a paginated list of prices based on optional filters and configuration.

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

 This documentation provides a reference to the `removePriceListRules` method. This belongs to the Pricing 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 is used to remove rules from a price list.

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

 This documentation provides a reference to the `removePrices` method. This belongs to the Pricing 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 deletes prices by their IDs.

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

 This documentation provides a reference to the `restorePriceLists` method. This belongs to the Pricing 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 a soft deleted price lists by its IDs.

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

 This documentation provides a reference to the `restorePricePreferences` method. This belongs to the Pricing 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 price preferences by their IDs.

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

 This documentation provides a reference to the `restorePrices` method. This belongs to the Pricing 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 prices by their IDs.

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

 This documentation provides a reference to the `retrievePriceList` method. This belongs to the Pricing 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 is used to retrieve a price list by its ID.

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

 This documentation provides a reference to the `retrievePriceListRule` method. This belongs to the Pricing 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 is used to retrieve a price list rule by its ID.

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

 This documentation provides a reference to the `retrievePricePreference` method. This belongs to the Pricing 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 is used to retrieve a price preference by its ID.

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

 This documentation provides a reference to the `retrievePriceRule` method. This belongs to the Pricing 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 is used to retrieve a price rule by its ID.

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

 This documentation provides a reference to the `retrievePriceSet` method. This belongs to the Pricing 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 is used to retrieve a price set by its ID.

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

 This documentation provides a reference to the `setPriceListRules` method. This belongs to the Pricing 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 is used to set the rules of a price list. Previous rules are removed.

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

 This documentation provides a reference to the `softDeletePriceLists` method. This belongs to the Pricing 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 price lists by their IDs.

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

 This documentation provides a reference to the `softDeletePricePreferences` method. This belongs to the Pricing 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 price preferences by their IDs.

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

 This documentation provides a reference to the `softDeletePrices` method. This belongs to the Pricing 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 prices by their IDs.

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

 This documentation provides a reference to the `updatePriceListPrices` method. This belongs to the Pricing 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 updates existing price list's prices.

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

 This documentation provides a reference to the `updatePriceLists` method. This belongs to the Pricing 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 is used to update price lists.

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

 This documentation provides a reference to the `updatePricePreferences` method. This belongs to the Pricing Module.

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

 This method is used to update a price preference.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updatePriceRules` method. This belongs to the Pricing 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 is used to update price rules, each with their provided data.

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

 This documentation provides a reference to the `updatePriceSets` method. This belongs to the Pricing Module.

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

 This method is used to update a price set.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `upsertPricePreferences` method. This belongs to the Pricing Module.

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

 This method updates existing price preferences, or creates new ones if they don't exist.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `upsertPriceSets` method. This belongs to the Pricing Module.

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

 This method updates existing price sets, or creates new ones if they don't exist.
@@ -9,6 +9,12 @@ import { TypeList } from "docs-ui"

 This section of the documentation provides a reference to the `IPricingModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Pricing Module.

+<Note>
+
+You should only use the methods in this reference when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 The main service interface for the Pricing Module.

 ## Methods
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"

 **BigNumberRawValue**: `Object`

-## Properties
-
 <TypeList types={[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="BigNumberRawValue"/>
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"

 **Event**: `Object`

-## Properties
-
 <TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../pricing.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Event"/>
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"

 **JoinerRelationship**: `Object`

-## Properties
-
 <TypeList types={[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="JoinerRelationship"/>
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"

 **OperatorMap**: `Object`

-## Properties
-
 <TypeList types={[{"name":"$and","type":"[Query](../pricing.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../pricing.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../pricing.ExpandScalar/page.mdx)&#60;T&#62; \\| [ExpandScalar](../pricing.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../pricing.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../pricing.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../pricing.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../pricing.Query/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../pricing.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../pricing.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../pricing.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../pricing.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OperatorMap"/>
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"

 **RawMessageFormat**: `Object`

-## Properties
-
 <TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"source","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Pick&#60;[Context](../../interfaces/pricing.Context/page.mdx), \"eventGroupId\"&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RawMessageFormat"/>