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

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

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andkodiakhq authored and GitHub committed 2024-08-18 16:54:36 +02:00
1 parent 4980285317
commit fb0644b8f6
2734 files changed
+131045 -127334
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

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.LinkUtils/page.mdx
+5 -5
View File
@@ -10,7 +10,7 @@ import { TypeList } from "docs-ui"
#### Properties
<TypeList types={[{"name":"ProductVariantInventoryItem","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ProductVariantPriceSet","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ShippingOptionPriceSet","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"CartPaymentCollection","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"RegionPaymentProvider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"CartPromotion","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SalesChannelLocation","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"LocationFulfillmentSet","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderPromotion","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderCart","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderSalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"PublishableApiKeySalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ProductSalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderPaymentCollection","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderFulfillment","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="LINKS"/>
<TypeList types={[{"name":"ProductVariantInventoryItem","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ProductVariantPriceSet","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ShippingOptionPriceSet","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"CartPaymentCollection","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"RegionPaymentProvider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"CartPromotion","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"SalesChannelLocation","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"LocationFulfillmentSet","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderPromotion","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderCart","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderSalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"PublishableApiKeySalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ProductSalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderPaymentCollection","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"OrderFulfillment","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="LINKS"/>
___
@@ -20,18 +20,18 @@ ___
#### Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="composeLinkName"/>
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="composeLinkName"/>
#### Returns
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="composeLinkName"/>
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="composeLinkName"/>
### composeTableName
#### Parameters
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="composeTableName"/>
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="composeTableName"/>
#### Returns
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="composeTableName"/>
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="composeTableName"/>
www/apps/resources/references/utils/utils.OrderUtils/page.mdx
+1 -1
View File
@@ -23,4 +23,4 @@ ___
#### Properties
<TypeList types={[{"name":"PLACED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.placed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.canceled\"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.completed\"","expandable":false,"children":[]}]} sectionTitle="OrderEvents"/>
<TypeList types={[{"name":"PLACED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.placed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.canceled\"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.completed\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderEvents"/>
www/apps/resources/references/utils/utils.UserUtils/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
#### Properties
<TypeList types={[{"name":"USER_CREATED","type":"`\"user.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_CREATED","type":"`\"invite.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"USER_UPDATED","type":"`\"user.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_UPDATED","type":"`\"invite.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"USER_DELETED","type":"`\"user.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_DELETED","type":"`\"invite.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"USER_RESTORED","type":"`\"user.restored\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_RESTORED","type":"`\"invite.restored\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"USER_ATTACHED","type":"`\"user.attached\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_ATTACHED","type":"`\"invite.attached\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"USER_DETACHED","type":"`\"user.detached\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_DETACHED","type":"`\"invite.detached\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_TOKEN_GENERATED","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UserEvents"/>
<TypeList types={[{"name":"USER_CREATED","type":"`\"user.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_CREATED","type":"`\"invite.created\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"USER_UPDATED","type":"`\"user.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_UPDATED","type":"`\"invite.updated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"USER_DELETED","type":"`\"user.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_DELETED","type":"`\"invite.deleted\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"USER_RESTORED","type":"`\"user.restored\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_RESTORED","type":"`\"invite.restored\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"USER_ATTACHED","type":"`\"user.attached\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_ATTACHED","type":"`\"invite.attached\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"USER_DETACHED","type":"`\"user.detached\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_DETACHED","type":"`\"invite.detached\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVITE_TOKEN_GENERATED","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UserEvents"/>