chore(docs): Generated References (automated) (#13921)
* chore(docs): Generated References (automated) * fix error + generate references --------- Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
892 files changed
+327091
-318256
No files matched your search
@@ -74,6 +74,8 @@ import { TypeList } from "docs-ui"
|
||||
- [AddShippingMethodToCartWorkflowInput](../../core_flows/interfaces/core_flows.AddShippingMethodToCartWorkflowInput/page.mdx)
|
||||
- [AssociateLocationsWithSalesChannelsStepInput](../../core_flows/interfaces/core_flows.AssociateLocationsWithSalesChannelsStepInput/page.mdx)
|
||||
- [AssociateProductsWithSalesChannelsStepInput](../../core_flows/interfaces/core_flows.AssociateProductsWithSalesChannelsStepInput/page.mdx)
|
||||
- [BatchImageVariantsWorkflowInput](../../core_flows/interfaces/core_flows.BatchImageVariantsWorkflowInput/page.mdx)
|
||||
- [BatchImageVariantsWorkflowOutput](../../core_flows/interfaces/core_flows.BatchImageVariantsWorkflowOutput/page.mdx)
|
||||
- [BatchInventoryItemLevelsWorkflowInput](../../core_flows/interfaces/core_flows.BatchInventoryItemLevelsWorkflowInput/page.mdx)
|
||||
- [BatchInventoryItemLevelsWorkflowOutput](../../core_flows/interfaces/core_flows.BatchInventoryItemLevelsWorkflowOutput/page.mdx)
|
||||
- [BatchProductVariantsWorkflowInput](../../core_flows/interfaces/core_flows.BatchProductVariantsWorkflowInput/page.mdx)
|
||||
@@ -83,6 +85,8 @@ import { TypeList } from "docs-ui"
|
||||
- [BatchPromotionRulesWorkflowOutput](../../core_flows/interfaces/core_flows.BatchPromotionRulesWorkflowOutput/page.mdx)
|
||||
- [BatchShippingOptionRulesInput](../../core_flows/interfaces/core_flows.BatchShippingOptionRulesInput/page.mdx)
|
||||
- [BatchShippingOptionRulesOutput](../../core_flows/interfaces/core_flows.BatchShippingOptionRulesOutput/page.mdx)
|
||||
- [BatchVariantImagesWorkflowInput](../../core_flows/interfaces/core_flows.BatchVariantImagesWorkflowInput/page.mdx)
|
||||
- [BatchVariantImagesWorkflowOutput](../../core_flows/interfaces/core_flows.BatchVariantImagesWorkflowOutput/page.mdx)
|
||||
- [BulkCreateDeleteLevelsWorkflowInput](../../core_flows/interfaces/core_flows.BulkCreateDeleteLevelsWorkflowInput/page.mdx)
|
||||
- [CancelDraftOrderEditWorkflowInput](../../core_flows/interfaces/core_flows.CancelDraftOrderEditWorkflowInput/page.mdx)
|
||||
- [ConfirmDraftOrderEditWorkflowInput](../../core_flows/interfaces/core_flows.ConfirmDraftOrderEditWorkflowInput/page.mdx)
|
||||
@@ -609,7 +613,6 @@ import { TypeList } from "docs-ui"
|
||||
- [ValidateInventoryLocationsStepInput](../../core_flows/types/core_flows.ValidateInventoryLocationsStepInput/page.mdx)
|
||||
- [ValidatePaymentsRefundStepInput](../../core_flows/types/core_flows.ValidatePaymentsRefundStepInput/page.mdx)
|
||||
- [ValidatePriceListsStepInput](../../core_flows/types/core_flows.ValidatePriceListsStepInput/page.mdx)
|
||||
- [ValidateRefundStepInput](../../core_flows/types/core_flows.ValidateRefundStepInput/page.mdx)
|
||||
- [ValidateShipmentStepInput](../../core_flows/types/core_flows.ValidateShipmentStepInput/page.mdx)
|
||||
- [ValidateShippingInput](../../core_flows/types/core_flows.ValidateShippingInput/page.mdx)
|
||||
- [ValidateShippingMethodsDataInput](../../core_flows/types/core_flows.ValidateShippingMethodsDataInput/page.mdx)
|
||||
@@ -739,7 +742,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderFulfillmentCanceled"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderFulfillmentCanceled"/>
|
||||
|
||||
### ordersCompleted
|
||||
|
||||
@@ -865,7 +868,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variantIds","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region","type":"`object` & [RegionDTO](../../region/interfaces/region.RegionDTO/page.mdx) & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<null \\| [RegionDTO](../../region/interfaces/region.RegionDTO/page.mdx)> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<null \\| [RegionDTO](../../region/interfaces/region.RegionDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The name of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The currency code of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Setting to indicate whether taxes need to be applied automatically","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"[RegionCountryDTO](../../region/interfaces/region.RegionCountryDTO/page.mdx)[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[RegionCountryDTO](../../region/interfaces/region.RegionCountryDTO/page.mdx)[]>","description":"The countries of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProviderDTO](../../payment/interfaces/payment.PaymentProviderDTO/page.mdx)[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[PaymentProviderDTO](../../payment/interfaces/payment.PaymentProviderDTO/page.mdx)[]>","description":"Payment providers available in the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The date the region was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The date the region was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`boolean`","description":"Setting to indicate whether taxes need to be applied automatically","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"[RegionCountryDTO](../../region/interfaces/region.RegionCountryDTO/page.mdx)[]","description":"The countries of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProviderDTO](../../region/interfaces/region.PaymentProviderDTO/page.mdx)[]","description":"Payment providers available in the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the region was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the region was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":faLine truncated
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variantIds","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerData","type":"`object` & [FindOrCreateCustomerOutputStepOutput](../../core_flows/interfaces/core_flows.FindOrCreateCustomerOutputStepOutput/page.mdx) & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[FindOrCreateCustomerOutputStepOutput](../../core_flows/interfaces/core_flows.FindOrCreateCustomerOutputStepOutput/page.mdx)> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[FindOrCreateCustomerOutputStepOutput](../../core_flows/interfaces/core_flows.FindOrCreateCustomerOutputStepOutput/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| null \\| [CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)>","description":"The customer found or created, if any.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| null \\| string>","description":"The email of the customer found or created, if any.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)","description":"The customer found or created, if any.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer found or created, if any.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setPricingContext"/>
|
||||
|
||||
### setPricingContext
|
||||
|
||||
@@ -955,7 +958,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CompleteCartWorkflowInput](../../core_flows/types/core_flows.CompleteCartWorkflowInput/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CompleteCartWorkflowInput](../../core_flows/types/core_flows.CompleteCartWorkflowInput/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"cartData.data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
|
||||
@@ -20,6 +20,7 @@ erDiagram
|
||||
Product }|--|{ ProductCategory : categories
|
||||
ProductCategory ||--|| ProductCategory : category_children
|
||||
ProductCollection ||--|| Product : products
|
||||
ProductImage }|--|{ ProductVariant : variants
|
||||
ProductOption ||--|| ProductOptionValue : values
|
||||
ProductOptionValue }|--|{ ProductVariant : variants
|
||||
ProductType ||--|| Product : products
|
||||
@@ -37,3 +38,4 @@ erDiagram
|
||||
- [ProductTag](../../product_models/variables/product_models.ProductTag/page.mdx)
|
||||
- [ProductType](../../product_models/variables/product_models.ProductType/page.mdx)
|
||||
- [ProductVariant](../../product_models/variables/product_models.ProductVariant/page.mdx)
|
||||
- [ProductVariantProductImage](../../product_models/variables/product_models.ProductVariantProductImage/page.mdx)
|
||||
@@ -5,7 +5,6 @@ import { TypeList } from "docs-ui"
|
||||
## Enumerations
|
||||
|
||||
- [ClaimReason](../../types/enums/types.ClaimReason/page.mdx)
|
||||
- [ExchangeReason](../../types/enums/types.ExchangeReason/page.mdx)
|
||||
|
||||
## Interfaces
|
||||
|
||||
@@ -20,9 +19,7 @@ import { TypeList } from "docs-ui"
|
||||
- [AdminCreateFulfillmentLabel](../../types/interfaces/types.AdminCreateFulfillmentLabel/page.mdx)
|
||||
- [AdminCreateProductVariantInventoryItem](../../types/interfaces/types.AdminCreateProductVariantInventoryItem/page.mdx)
|
||||
- [AdminCreateShippingOptionBase](../../types/interfaces/types.AdminCreateShippingOptionBase/page.mdx)
|
||||
- [AdminCreateTaxRateRule](../../types/interfaces/types.AdminCreateTaxRateRule/page.mdx)
|
||||
- [AdminDeleteProductVariantInventoryItem](../../types/interfaces/types.AdminDeleteProductVariantInventoryItem/page.mdx)
|
||||
- [AdminExchangeAddItems](../../types/interfaces/types.AdminExchangeAddItems/page.mdx)
|
||||
- [AdminExchangeAddShippingMethod](../../types/interfaces/types.AdminExchangeAddShippingMethod/page.mdx)
|
||||
- [AdminExchangeUpdateItem](../../types/interfaces/types.AdminExchangeUpdateItem/page.mdx)
|
||||
- [AdminExchangeUpdateShippingMethod](../../types/interfaces/types.AdminExchangeUpdateShippingMethod/page.mdx)
|
||||
@@ -220,6 +217,8 @@ import { TypeList } from "docs-ui"
|
||||
- [RemoteJoinerOptions](../../types/interfaces/types.RemoteJoinerOptions/page.mdx)
|
||||
- [RemoteJoinerQuery](../../types/interfaces/types.RemoteJoinerQuery/page.mdx)
|
||||
- [RemoteNestedExpands](../../types/interfaces/types.RemoteNestedExpands/page.mdx)
|
||||
- [RetrieveAccountHolderInput](../../types/interfaces/types.RetrieveAccountHolderInput/page.mdx)
|
||||
- [RetrieveAccountHolderOutput](../../types/interfaces/types.RetrieveAccountHolderOutput/page.mdx)
|
||||
- [RetrievePaymentInput](../../types/interfaces/types.RetrievePaymentInput/page.mdx)
|
||||
- [RetrievePaymentOutput](../../types/interfaces/types.RetrievePaymentOutput/page.mdx)
|
||||
- [SavePaymentMethodInput](../../types/interfaces/types.SavePaymentMethodInput/page.mdx)
|
||||
|
||||
Reference in new issue
Block a user