asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

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

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and GitHub committed 2025-10-21 11:56:37 +03:00
1 parent 0da4790081
commit 858b3e3b9b
1268 files changed
+213770 -194893
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/utils/Cart/variables/utils.Cart.CartWorkflowEvents/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
## Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when a cart is created.","optional":false,"defaultValue":"\"cart.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when a cart's details are updated.","optional":false,"defaultValue":"\"cart.updated\"","expandable":false,"children":[]},{"name":"CUSTOMER_UPDATED","type":"`string`","description":"Emitted when the customer in the cart is updated.","optional":false,"defaultValue":"\"cart.customer_updated\"","expandable":false,"children":[]},{"name":"REGION_UPDATED","type":"`string`","description":"Emitted when the cart's region is updated. This\nevent is emitted alongside the `cart.updated` event.","optional":false,"defaultValue":"\"cart.region_updated\"","expandable":false,"children":[]},{"name":"CUSTOMER_TRANSFERRED","type":"`string`","description":"Emitted when the customer in the cart is transferred.","optional":false,"defaultValue":"\"cart.customer_transferred\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CartWorkflowEvents"/>
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when a cart is created.","optional":false,"defaultValue":"\"cart.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when a cart's details are updated.","optional":false,"defaultValue":"\"cart.updated\"","expandable":false,"children":[]},{"name":"CUSTOMER_UPDATED","type":"`string`","description":"Emitted when the customer in the cart is updated.","optional":false,"defaultValue":"\"cart.customer_updated\"","expandable":false,"children":[]},{"name":"REGION_UPDATED","type":"`string`","description":"Emitted when the cart's region is updated. This\nevent is emitted alongside the `cart.updated` event.","optional":false,"defaultValue":"\"cart.region_updated\"","expandable":false,"children":[]},{"name":"CUSTOMER_TRANSFERRED","type":"`string`","description":"Emitted when the customer in the cart is transferred.","optional":false,"defaultValue":"\"cart.customer_transferred\"","expandable":false,"children":[],"since":"2.8.0"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CartWorkflowEvents"/>
www/apps/resources/references/utils/Fulfillment/variables/utils.Fulfillment.ShippingOptionTypeWorkflowEvents/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
## Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when shipping option types are updated.","optional":false,"defaultValue":"\"shipping-option-type.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when shipping option types are created.","optional":false,"defaultValue":"\"shipping-option-type.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when shipping option types are deleted.","optional":false,"defaultValue":"\"shipping-option-type.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ShippingOptionTypeWorkflowEvents"/>
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when shipping option types are updated.","optional":false,"defaultValue":"\"shipping-option-type.updated\"","expandable":false,"children":[],"since":"2.10.0"},{"name":"CREATED","type":"`string`","description":"Emitted when shipping option types are created.","optional":false,"defaultValue":"\"shipping-option-type.created\"","expandable":false,"children":[],"since":"2.10.0"},{"name":"DELETED","type":"`string`","description":"Emitted when shipping option types are deleted.","optional":false,"defaultValue":"\"shipping-option-type.deleted\"","expandable":false,"children":[],"since":"2.10.0"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ShippingOptionTypeWorkflowEvents"/>
www/apps/resources/references/utils/Order/variables/utils.Order.OrderEditWorkflowEvents/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
## Properties
<TypeList types={[{"name":"REQUESTED","type":"`string`","description":"Emitted when an order edit is requested.","optional":false,"defaultValue":"\"order-edit.requested\"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`string`","description":"Emitted when an order edit request is confirmed.","optional":false,"defaultValue":"\"order-edit.confirmed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"Emitted when an order edit request is canceled.","optional":false,"defaultValue":"\"order-edit.canceled\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderEditWorkflowEvents"/>
<TypeList types={[{"name":"REQUESTED","type":"`string`","description":"Emitted when an order edit is requested.","optional":false,"defaultValue":"\"order-edit.requested\"","expandable":false,"children":[],"since":"2.8.0"},{"name":"CONFIRMED","type":"`string`","description":"Emitted when an order edit request is confirmed.","optional":false,"defaultValue":"\"order-edit.confirmed\"","expandable":false,"children":[],"since":"2.8.0"},{"name":"CANCELED","type":"`string`","description":"Emitted when an order edit request is canceled.","optional":false,"defaultValue":"\"order-edit.canceled\"","expandable":false,"children":[],"since":"2.8.0"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderEditWorkflowEvents"/>
www/apps/resources/references/utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodAllocation/page.mdx
+4
View File
@@ -11,3 +11,7 @@ import { TypeList } from "docs-ui"
### ACROSS
**ACROSS** = `"across"`
### ONCE
**ONCE** = `"once"`
www/apps/resources/references/utils/PromotionUtils/enums/utils.PromotionUtils.CampaignBudgetType/page.mdx
+8
View File
@@ -11,3 +11,11 @@ import { TypeList } from "docs-ui"
### USAGE
**USAGE** = `"usage"`
### USE\_BY\_ATTRIBUTE
**USE\_BY\_ATTRIBUTE** = `"use_by_attribute"`
### SPEND\_BY\_ATTRIBUTE
**SPEND\_BY\_ATTRIBUTE** = `"spend_by_attribute"`
www/apps/resources/references/utils/types/utils.TargetMethodArgs/page.mdx
+9
View File
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# TargetMethodArgs
**TargetMethodArgs**: Target[PropertyKey & keyof Target] extends (...`args`: `any`[]) => `any` ? Parameters&#60;Target[PropertyKey & keyof Target]&#62; : `never`
## Type Parameters
<TypeList types={[{"name":"Target","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PropertyKey","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="TargetMethodArgs"/>
www/apps/resources/references/utils/utils.CachingUtils/page.mdx
+50
View File
@@ -0,0 +1,50 @@
import { TypeList } from "docs-ui"
# CachingUtils
## Functions
- [Cached](page.mdx#cached)
- [useCache](page.mdx#usecache)
## Functions
### Cached
This function is used to cache the result of a method call.
#### Type Parameters
<TypeList types={[{"name":"Target","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PropertyKey","type":"`string` \\| `number` \\| `symbol`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Cached"/>
#### Parameters
<TypeList types={[{"name":"options","type":"`object`","description":"The options for the cache.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx) \\| (`this`: Target) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string` \\| (`args`: [TargetMethodArgs](../types/utils.TargetMethodArgs/page.mdx)&#60;Target, PropertyKey&#62;, `cachingModule`: [ICachingModuleService](../../types/CachingTypes/interfaces/types.CachingTypes.ICachingModuleService/page.mdx)) => `string` \\| `any`[] \\| Promise&#60;any[]&#62; \\| Promise&#60;string&#62;","description":"The key to use for the cache.\nIf a function is provided, it will be called with the arguments as the first argument and the\ncontainer as the second argument.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enable","type":"`boolean` \\| (`args`: [TargetMethodArgs](../types/utils.TargetMethodArgs/page.mdx)&#60;Target, PropertyKey&#62;) => `undefined` \\| `boolean`","description":"Whether to enable the cache. This is only useful if you want to enable without providing any\nother options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string`[] \\| (`args`: [TargetMethodArgs](../types/utils.TargetMethodArgs/page.mdx)&#60;Target, PropertyKey&#62;) => `undefined` \\| `string`[]","description":"The tags to use for the cache.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ttl","type":"`number` \\| (`args`: [TargetMethodArgs](../types/utils.TargetMethodArgs/page.mdx)&#60;Target, PropertyKey&#62;) => `undefined` \\| `number`","description":"The time-to-live (TTL) value in seconds.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"autoInvalidate","type":"`boolean` \\| (`args`: [TargetMethodArgs](../types/utils.TargetMethodArgs/page.mdx)&#60;Target, PropertyKey&#62;) => `undefined` \\| `boolean`","description":"Whether to auto invalidate the cache whenever it is possible.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"providers","type":"`string`[] \\| (`args`: [TargetMethodArgs](../types/utils.TargetMethodArgs/page.mdx)&#60;Target, PropertyKey&#62;) => `undefined` \\| `string`[]","description":"The providers to use for the cache.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Cached"/>
#### Returns
<TypeList types={[{"name":"(target: Target, propertyKey: PropertyKey, descriptor: PropertyDescriptor) => PropertyDescriptor","type":"(`target`: Target, `propertyKey`: PropertyKey, `descriptor`: `PropertyDescriptor`) => `PropertyDescriptor`","optional":false,"defaultValue":"","description":"The original method with the cache applied.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Cached"/>
##### Parameters
<TypeList types={[{"name":"target","type":"Target","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"propertyKey","type":"PropertyKey","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"descriptor","type":"`PropertyDescriptor`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
##### Returns
<TypeList types={[{"name":"PropertyDescriptor","type":"`PropertyDescriptor`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
### useCache
This function is used to cache the result of a function call.
#### Type Parameters
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useCache"/>
#### Parameters
<TypeList types={[{"name":"cb","type":"(...`args`: `any`[]) => Promise&#60;T&#62;","description":"The callback to execute.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"The options for the cache.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string` \\| `any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"enable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ttl","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"autoInvalidate","type":"`boolean`","description":"Whethere the default strategy should auto invalidate the cache whenever it is possible.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"providers","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useCache"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;T&#62;","optional":false,"defaultValue":"","description":"The result of the callback.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useCache"/>
www/apps/resources/references/utils/utils.FulfillmentUtils/page.mdx
+1 -1
View File
@@ -21,4 +21,4 @@ ___
#### Properties
<TypeList types={[{"name":"FULFILLMENT_CREATED","type":"`\"fulfillment.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_SET_CREATED","type":"`\"fulfillment-set.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SERVICE_ZONE_CREATED","type":"`\"service-zone.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"GEO_ZONE_CREATED","type":"`\"geo-zone.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_CREATED","type":"`\"shipping-option.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_TYPE_CREATED","type":"`\"shipping-option-type.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_PROFILE_CREATED","type":"`\"shipping-profile.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_RULE_CREATED","type":"`\"shipping-option-rule.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ADDRESS_CREATED","type":"`\"fulfillment-address.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ITEM_CREATED","type":"`\"fulfillment-item.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_LABEL_CREATED","type":"`\"fulfillment-label.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_UPDATED","type":"`\"fulfillment.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_SET_UPDATED","type":"`\"fulfillment-set.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SERVICE_ZONE_UPDATED","type":"`\"service-zone.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"GEO_ZONE_UPDATED","type":"`\"geo-zone.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_UPDATED","type":"`\"shipping-option.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_TYPE_UPDATED","type":"`\"shipping-option-type.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_PROFILE_UPDATED","type":"`\"shipping-profile.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_RULE_UPDATED","type":"`\"shipping-option-rule.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ADDRESS_UPDATED","type":"`\"fulfillment-address.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ITEM_UPDATED","type":"`\"fulfillment-item.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_LABEL_UPDATED","type":"`\"fulfillment-label.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_DELETED","type":"`\"fulfillment.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_SET_DELETED","type":"`\"fulfillment-set.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SERVICE_ZONE_DELETED","type":"`\"service-zone.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"GEO_ZONE_DELETED","type":"`\"geo-zone.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_DELETED","type":"`\"shipping-option.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_TYPE_DELETED","type":"`\"shipping-option-type.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_PROFILE_DELETED","type":"`\"shipping-profile.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_RULE_DELETED","type":"`\"shipping-option-rule.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ADDRESS_DELETED","type":"`\"fulfillment-address.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ITEM_DELETED"Line truncated
<TypeList types={[{"name":"FULFILLMENT_CREATED","type":"`\"fulfillment.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_SET_CREATED","type":"`\"fulfillment-set.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SERVICE_ZONE_CREATED","type":"`\"service-zone.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"GEO_ZONE_CREATED","type":"`\"geo-zone.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_CREATED","type":"`\"shipping-option.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_TYPE_CREATED","type":"`\"shipping-option-type.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_PROFILE_CREATED","type":"`\"shipping-profile.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_RULE_CREATED","type":"`\"shipping-option-rule.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ADDRESS_CREATED","type":"`\"fulfillment-address.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ITEM_CREATED","type":"`\"fulfillment-item.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_LABEL_CREATED","type":"`\"fulfillment-label.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_UPDATED","type":"`\"fulfillment.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_SET_UPDATED","type":"`\"fulfillment-set.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SERVICE_ZONE_UPDATED","type":"`\"service-zone.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"GEO_ZONE_UPDATED","type":"`\"geo-zone.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_UPDATED","type":"`\"shipping-option.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_TYPE_UPDATED","type":"`\"shipping-option-type.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_PROFILE_UPDATED","type":"`\"shipping-profile.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_RULE_UPDATED","type":"`\"shipping-option-rule.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ADDRESS_UPDATED","type":"`\"fulfillment-address.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ITEM_UPDATED","type":"`\"fulfillment-item.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_LABEL_UPDATED","type":"`\"fulfillment-label.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_DELETED","type":"`\"fulfillment.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_SET_DELETED","type":"`\"fulfillment-set.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SERVICE_ZONE_DELETED","type":"`\"service-zone.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"GEO_ZONE_DELETED","type":"`\"geo-zone.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_DELETED","type":"`\"shipping-option.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_TYPE_DELETED","type":"`\"shipping-option-type.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_PROFILE_DELETED","type":"`\"shipping-profile.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPING_OPTION_RULE_DELETED","type":"`\"shipping-option-rule.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ADDRESS_DELETED","type":"`\"fulfillment-address.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLMENT_ITEM_DELETED"Line truncated
www/apps/resources/references/utils/utils.GraphQLUtils/page.mdx
+1 -1
View File
@@ -58,7 +58,7 @@ Generate a list of fields and fields relations for a given type with the request
#### Parameters
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`GraphQLSchema`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"outputDir","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filename","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"joinerConfigs","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"interfaceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlSchemaToTypes"/>
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`GraphQLSchema`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"outputDir","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filename","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"joinerConfigs","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idPrefixToEntityName","type":"`Record<string, string>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"interfaceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlSchemaToTypes"/>
#### Returns
www/apps/resources/references/utils/utils.ProductUtils/page.mdx
+1 -1
View File
@@ -45,7 +45,7 @@ Computes the total availability for a list of variants across all stock location
### getVariantAvailability
Computes the varaint availability for a list of variants in a given sales channel
Computes the variant availability for a list of variants in a given sales channel
The availability algorithm works as follows:
1. For each variant, we retrieve its inventory items.