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>
This commit is contained in:
authored and GitHub committed 2024-10-24 09:41:14 +00:00
1 parent e196ad7659
commit 5deeae060a
2313 files changed
+1734550 -1584991

No files matched your search

File diff suppressed because it is too large. Load diff
+56 -76
View File
@@ -3123,6 +3123,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryLevelsStep/page.mdx", "filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryLevelsStep/page.mdx",
"pathname": "/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryLevelsStep" "pathname": "/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryLevelsStep"
}, },
{
"filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx",
"pathname": "/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep"
},
{ {
"filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryItemsForCreate/page.mdx", "filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryItemsForCreate/page.mdx",
"pathname": "/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryItemsForCreate" "pathname": "/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryItemsForCreate"
@@ -3171,6 +3175,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/variables/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStepId/page.mdx", "filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/variables/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStepId/page.mdx",
"pathname": "/references/core_flows/Inventory/Steps_Inventory/variables/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStepId" "pathname": "/references/core_flows/Inventory/Steps_Inventory/variables/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStepId"
}, },
{
"filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/variables/core_flows.Inventory.Steps_Inventory.validateVariantInventoryStepId/page.mdx",
"pathname": "/references/core_flows/Inventory/Steps_Inventory/variables/core_flows.Inventory.Steps_Inventory.validateVariantInventoryStepId"
},
{ {
"filePath": "/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow/page.mdx", "filePath": "/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow/page.mdx",
"pathname": "/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow" "pathname": "/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow"
@@ -6147,6 +6155,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRatesWorkflow/page.mdx", "filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRatesWorkflow/page.mdx",
"pathname": "/references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRatesWorkflow" "pathname": "/references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRatesWorkflow"
}, },
{
"filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRegionsWorkflow/page.mdx",
"pathname": "/references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRegionsWorkflow"
},
{ {
"filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/variables/core_flows.Tax.Workflows_Tax.createTaxRateRulesWorkflowId/page.mdx", "filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/variables/core_flows.Tax.Workflows_Tax.createTaxRateRulesWorkflowId/page.mdx",
"pathname": "/references/core_flows/Tax/Workflows_Tax/variables/core_flows.Tax.Workflows_Tax.createTaxRateRulesWorkflowId" "pathname": "/references/core_flows/Tax/Workflows_Tax/variables/core_flows.Tax.Workflows_Tax.createTaxRateRulesWorkflowId"
@@ -6179,6 +6191,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/variables/core_flows.Tax.Workflows_Tax.updateTaxRatesWorkflowId/page.mdx", "filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/variables/core_flows.Tax.Workflows_Tax.updateTaxRatesWorkflowId/page.mdx",
"pathname": "/references/core_flows/Tax/Workflows_Tax/variables/core_flows.Tax.Workflows_Tax.updateTaxRatesWorkflowId" "pathname": "/references/core_flows/Tax/Workflows_Tax/variables/core_flows.Tax.Workflows_Tax.updateTaxRatesWorkflowId"
}, },
{
"filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/variables/core_flows.Tax.Workflows_Tax.updateTaxRegionsWorkflowId/page.mdx",
"pathname": "/references/core_flows/Tax/Workflows_Tax/variables/core_flows.Tax.Workflows_Tax.updateTaxRegionsWorkflowId"
},
{ {
"filePath": "/www/apps/resources/references/core_flows/Tax/core_flows.Tax.Steps_Tax/page.mdx", "filePath": "/www/apps/resources/references/core_flows/Tax/core_flows.Tax.Steps_Tax/page.mdx",
"pathname": "/references/core_flows/Tax/core_flows.Tax.Steps_Tax" "pathname": "/references/core_flows/Tax/core_flows.Tax.Steps_Tax"
@@ -6863,6 +6879,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ValidateDeletedPaymentSessionsStepInput/page.mdx", "filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ValidateDeletedPaymentSessionsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ValidateDeletedPaymentSessionsStepInput" "pathname": "/references/core_flows/interfaces/core_flows.ValidateDeletedPaymentSessionsStepInput"
}, },
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ValidateInventoryDeleteStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ValidateInventoryDeleteStepInput"
},
{ {
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ValidateSalesChannelsExistStepInput/page.mdx", "filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ValidateSalesChannelsExistStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ValidateSalesChannelsExistStepInput" "pathname": "/references/core_flows/interfaces/core_flows.ValidateSalesChannelsExistStepInput"
@@ -7371,6 +7391,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpsertVariantPricesWorkflowInput/page.mdx", "filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpsertVariantPricesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpsertVariantPricesWorkflowInput" "pathname": "/references/core_flows/types/core_flows.UpsertVariantPricesWorkflowInput"
}, },
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UseQueryGraphStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UseQueryGraphStepInput"
},
{ {
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCountCurrencies/page.mdx", "filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCountCurrencies/page.mdx",
"pathname": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCountCurrencies" "pathname": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCountCurrencies"
@@ -8795,6 +8819,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/helper_steps/types/helper_steps.DismissRemoteLinksStepInput/page.mdx", "filePath": "/www/apps/resources/references/helper_steps/types/helper_steps.DismissRemoteLinksStepInput/page.mdx",
"pathname": "/references/helper_steps/types/helper_steps.DismissRemoteLinksStepInput" "pathname": "/references/helper_steps/types/helper_steps.DismissRemoteLinksStepInput"
}, },
{
"filePath": "/www/apps/resources/references/helper_steps/types/helper_steps.UseQueryGraphStepInput/page.mdx",
"pathname": "/references/helper_steps/types/helper_steps.UseQueryGraphStepInput"
},
{ {
"filePath": "/www/apps/resources/references/helper_steps/variables/helper_steps.createLinksStepId/page.mdx", "filePath": "/www/apps/resources/references/helper_steps/variables/helper_steps.createLinksStepId/page.mdx",
"pathname": "/references/helper_steps/variables/helper_steps.createLinksStepId" "pathname": "/references/helper_steps/variables/helper_steps.createLinksStepId"
@@ -10992,33 +11020,21 @@ export const filesMap = [
"pathname": "/references/js_sdk/store/classes/js_sdk.store.Store" "pathname": "/references/js_sdk/store/classes/js_sdk.store.Store"
}, },
{ {
"filePath": "/www/apps/resources/references/medusa/interfaces/medusa.AuthContext/page.mdx", "filePath": "/www/apps/resources/references/medusa/classes/medusa.RestrictedFields/page.mdx",
"pathname": "/references/medusa/interfaces/medusa.AuthContext" "pathname": "/references/medusa/classes/medusa.RestrictedFields"
},
{
"filePath": "/www/apps/resources/references/medusa/interfaces/medusa.AuthenticatedMedusaRequest/page.mdx",
"pathname": "/references/medusa/interfaces/medusa.AuthenticatedMedusaRequest"
}, },
{ {
"filePath": "/www/apps/resources/references/medusa/interfaces/medusa.FindConfig/page.mdx", "filePath": "/www/apps/resources/references/medusa/interfaces/medusa.FindConfig/page.mdx",
"pathname": "/references/medusa/interfaces/medusa.FindConfig" "pathname": "/references/medusa/interfaces/medusa.FindConfig"
}, },
{ {
"filePath": "/www/apps/resources/references/medusa/interfaces/medusa.FindConfig-1/page.mdx", "filePath": "/www/apps/resources/references/medusa/interfaces/medusa.Logger/page.mdx",
"pathname": "/references/medusa/interfaces/medusa.FindConfig-1" "pathname": "/references/medusa/interfaces/medusa.Logger"
}, },
{ {
"filePath": "/www/apps/resources/references/medusa/interfaces/medusa.MedusaRequest/page.mdx", "filePath": "/www/apps/resources/references/medusa/interfaces/medusa.MedusaRequest/page.mdx",
"pathname": "/references/medusa/interfaces/medusa.MedusaRequest" "pathname": "/references/medusa/interfaces/medusa.MedusaRequest"
}, },
{
"filePath": "/www/apps/resources/references/medusa/interfaces/medusa.MedusaRequest-1/page.mdx",
"pathname": "/references/medusa/interfaces/medusa.MedusaRequest-1"
},
{
"filePath": "/www/apps/resources/references/medusa/interfaces/medusa.ModuleImplementations/page.mdx",
"pathname": "/references/medusa/interfaces/medusa.ModuleImplementations"
},
{ {
"filePath": "/www/apps/resources/references/medusa/interfaces/medusa.RequestQueryFields/page.mdx", "filePath": "/www/apps/resources/references/medusa/interfaces/medusa.RequestQueryFields/page.mdx",
"pathname": "/references/medusa/interfaces/medusa.RequestQueryFields" "pathname": "/references/medusa/interfaces/medusa.RequestQueryFields"
@@ -11044,8 +11060,8 @@ export const filesMap = [
"pathname": "/references/medusa/types/medusa.EventMetadata" "pathname": "/references/medusa/types/medusa.EventMetadata"
}, },
{ {
"filePath": "/www/apps/resources/references/medusa/types/medusa.Logger/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.Logger-1/page.mdx",
"pathname": "/references/medusa/types/medusa.Logger" "pathname": "/references/medusa/types/medusa.Logger-1"
}, },
{ {
"filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaContainer/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaContainer/page.mdx",
@@ -11067,10 +11083,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaNextFunction/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaNextFunction/page.mdx",
"pathname": "/references/medusa/types/medusa.MedusaNextFunction" "pathname": "/references/medusa/types/medusa.MedusaNextFunction"
}, },
{
"filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaNextFunction-1/page.mdx",
"pathname": "/references/medusa/types/medusa.MedusaNextFunction-1"
},
{ {
"filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaPricingContext/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaPricingContext/page.mdx",
"pathname": "/references/medusa/types/medusa.MedusaPricingContext" "pathname": "/references/medusa/types/medusa.MedusaPricingContext"
@@ -11079,18 +11091,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaRequestHandler/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaRequestHandler/page.mdx",
"pathname": "/references/medusa/types/medusa.MedusaRequestHandler" "pathname": "/references/medusa/types/medusa.MedusaRequestHandler"
}, },
{
"filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaRequestHandler-1/page.mdx",
"pathname": "/references/medusa/types/medusa.MedusaRequestHandler-1"
},
{ {
"filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaResponse/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaResponse/page.mdx",
"pathname": "/references/medusa/types/medusa.MedusaResponse" "pathname": "/references/medusa/types/medusa.MedusaResponse"
}, },
{
"filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaResponse-1/page.mdx",
"pathname": "/references/medusa/types/medusa.MedusaResponse-1"
},
{ {
"filePath": "/www/apps/resources/references/medusa/types/medusa.MiddlewareFunction/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.MiddlewareFunction/page.mdx",
"pathname": "/references/medusa/types/medusa.MiddlewareFunction" "pathname": "/references/medusa/types/medusa.MiddlewareFunction"
@@ -11115,10 +11119,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/medusa/types/medusa.ParserConfigArgs/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.ParserConfigArgs/page.mdx",
"pathname": "/references/medusa/types/medusa.ParserConfigArgs" "pathname": "/references/medusa/types/medusa.ParserConfigArgs"
}, },
{
"filePath": "/www/apps/resources/references/medusa/types/medusa.QueryConfig/page.mdx",
"pathname": "/references/medusa/types/medusa.QueryConfig"
},
{ {
"filePath": "/www/apps/resources/references/medusa/types/medusa.RouteVerb/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.RouteVerb/page.mdx",
"pathname": "/references/medusa/types/medusa.RouteVerb" "pathname": "/references/medusa/types/medusa.RouteVerb"
@@ -11131,10 +11131,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/medusa/types/medusa.SubscriberConfig/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.SubscriberConfig/page.mdx",
"pathname": "/references/medusa/types/medusa.SubscriberConfig" "pathname": "/references/medusa/types/medusa.SubscriberConfig"
}, },
{
"filePath": "/www/apps/resources/references/medusa/types/medusa.TransformObjectMethodToAsync/page.mdx",
"pathname": "/references/medusa/types/medusa.TransformObjectMethodToAsync"
},
{ {
"filePath": "/www/apps/resources/references/medusa_config/interfaces/medusa_config.AdminOptions/page.mdx", "filePath": "/www/apps/resources/references/medusa_config/interfaces/medusa_config.AdminOptions/page.mdx",
"pathname": "/references/medusa_config/interfaces/medusa_config.AdminOptions" "pathname": "/references/medusa_config/interfaces/medusa_config.AdminOptions"
@@ -11379,10 +11375,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/modules_sdk/classes/modules_sdk.RemoteQuery/page.mdx", "filePath": "/www/apps/resources/references/modules_sdk/classes/modules_sdk.RemoteQuery/page.mdx",
"pathname": "/references/modules_sdk/classes/modules_sdk.RemoteQuery" "pathname": "/references/modules_sdk/classes/modules_sdk.RemoteQuery"
}, },
{
"filePath": "/www/apps/resources/references/modules_sdk/enums/modules_sdk.MODULE_RESOURCE_TYPE/page.mdx",
"pathname": "/references/modules_sdk/enums/modules_sdk.MODULE_RESOURCE_TYPE"
},
{ {
"filePath": "/www/apps/resources/references/modules_sdk/enums/modules_sdk.MODULE_SCOPE/page.mdx", "filePath": "/www/apps/resources/references/modules_sdk/enums/modules_sdk.MODULE_SCOPE/page.mdx",
"pathname": "/references/modules_sdk/enums/modules_sdk.MODULE_SCOPE" "pathname": "/references/modules_sdk/enums/modules_sdk.MODULE_SCOPE"
@@ -15631,6 +15623,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRates/page.mdx", "filePath": "/www/apps/resources/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRates/page.mdx",
"pathname": "/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRates" "pathname": "/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRates"
}, },
{
"filePath": "/www/apps/resources/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRegions/page.mdx",
"pathname": "/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRegions"
},
{ {
"filePath": "/www/apps/resources/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.upsertTaxRates/page.mdx", "filePath": "/www/apps/resources/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.upsertTaxRates/page.mdx",
"pathname": "/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.upsertTaxRates" "pathname": "/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.upsertTaxRates"
@@ -15747,6 +15743,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/tax/interfaces/tax.UpdateTaxRateDTO/page.mdx", "filePath": "/www/apps/resources/references/tax/interfaces/tax.UpdateTaxRateDTO/page.mdx",
"pathname": "/references/tax/interfaces/tax.UpdateTaxRateDTO" "pathname": "/references/tax/interfaces/tax.UpdateTaxRateDTO"
}, },
{
"filePath": "/www/apps/resources/references/tax/interfaces/tax.UpdateTaxRegionDTO/page.mdx",
"pathname": "/references/tax/interfaces/tax.UpdateTaxRegionDTO"
},
{ {
"filePath": "/www/apps/resources/references/tax/interfaces/tax.UpsertTaxRateDTO/page.mdx", "filePath": "/www/apps/resources/references/tax/interfaces/tax.UpsertTaxRateDTO/page.mdx",
"pathname": "/references/tax/interfaces/tax.UpsertTaxRateDTO" "pathname": "/references/tax/interfaces/tax.UpsertTaxRateDTO"
@@ -16279,10 +16279,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeInboundItems/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeInboundItems/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeInboundItems" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeInboundItems"
}, },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeItems/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeItems"
},
{ {
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeOutboundItems/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeOutboundItems/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeOutboundItems" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeOutboundItems"
@@ -16559,10 +16555,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeOrderResponse/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeOrderResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeOrderResponse" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeOrderResponse"
}, },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeParams/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeParams"
},
{ {
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangePreviewResponse/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangePreviewResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangePreviewResponse" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangePreviewResponse"
@@ -17067,10 +17059,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeInboundItem/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeInboundItem/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeInboundItem" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeInboundItem"
}, },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeItem/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeItem"
},
{ {
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeOutboundItem/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeOutboundItem/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeOutboundItem" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeOutboundItem"
@@ -17607,6 +17595,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx", "filePath": "/www/apps/resources/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx",
"pathname": "/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports" "pathname": "/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports"
}, },
{
"filePath": "/www/apps/resources/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderLoaderFunction/page.mdx",
"pathname": "/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderLoaderFunction"
},
{ {
"filePath": "/www/apps/resources/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution/page.mdx", "filePath": "/www/apps/resources/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution/page.mdx",
"pathname": "/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution" "pathname": "/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution"
@@ -17620,8 +17612,8 @@ export const filesMap = [
"pathname": "/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModulesResponse" "pathname": "/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModulesResponse"
}, },
{ {
"filePath": "/www/apps/resources/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryFilterType/page.mdx", "filePath": "/www/apps/resources/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ProviderLoaderOptions/page.mdx",
"pathname": "/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryFilterType" "pathname": "/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ProviderLoaderOptions"
}, },
{ {
"filePath": "/www/apps/resources/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx", "filePath": "/www/apps/resources/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx",
@@ -17679,6 +17671,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/NotificationTypes/interfaces/types.NotificationTypes.LocalNotificationServiceOptions/page.mdx", "filePath": "/www/apps/resources/references/types/NotificationTypes/interfaces/types.NotificationTypes.LocalNotificationServiceOptions/page.mdx",
"pathname": "/references/types/NotificationTypes/interfaces/types.NotificationTypes.LocalNotificationServiceOptions" "pathname": "/references/types/NotificationTypes/interfaces/types.NotificationTypes.LocalNotificationServiceOptions"
}, },
{
"filePath": "/www/apps/resources/references/types/NotificationTypes/interfaces/types.NotificationTypes.NotificationContent/page.mdx",
"pathname": "/references/types/NotificationTypes/interfaces/types.NotificationTypes.NotificationContent"
},
{ {
"filePath": "/www/apps/resources/references/types/NotificationTypes/interfaces/types.NotificationTypes.NotificationDTO/page.mdx", "filePath": "/www/apps/resources/references/types/NotificationTypes/interfaces/types.NotificationTypes.NotificationDTO/page.mdx",
"pathname": "/references/types/NotificationTypes/interfaces/types.NotificationTypes.NotificationDTO" "pathname": "/references/types/NotificationTypes/interfaces/types.NotificationTypes.NotificationDTO"
@@ -18023,10 +18019,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseExchangeItem/page.mdx", "filePath": "/www/apps/resources/references/types/interfaces/types.BaseExchangeItem/page.mdx",
"pathname": "/references/types/interfaces/types.BaseExchangeItem" "pathname": "/references/types/interfaces/types.BaseExchangeItem"
}, },
{
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseExchangeListParams/page.mdx",
"pathname": "/references/types/interfaces/types.BaseExchangeListParams"
},
{ {
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseFile/page.mdx", "filePath": "/www/apps/resources/references/types/interfaces/types.BaseFile/page.mdx",
"pathname": "/references/types/interfaces/types.BaseFile" "pathname": "/references/types/interfaces/types.BaseFile"
@@ -18963,6 +18955,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx", "filePath": "/www/apps/resources/references/utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx",
"pathname": "/references/utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType" "pathname": "/references/utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType"
}, },
{
"filePath": "/www/apps/resources/references/utils/GraphQLUtils/classes/utils.GraphQLUtils.GraphQLParser/page.mdx",
"pathname": "/references/utils/GraphQLUtils/classes/utils.GraphQLUtils.GraphQLParser"
},
{ {
"filePath": "/www/apps/resources/references/utils/OrderUtils/enums/utils.OrderUtils.ChangeActionType/page.mdx", "filePath": "/www/apps/resources/references/utils/OrderUtils/enums/utils.OrderUtils.ChangeActionType/page.mdx",
"pathname": "/references/utils/OrderUtils/enums/utils.OrderUtils.ChangeActionType" "pathname": "/references/utils/OrderUtils/enums/utils.OrderUtils.ChangeActionType"
@@ -19035,10 +19031,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/utils/ShippingProfileUtils/enums/utils.ShippingProfileUtils.ShippingProfileType/page.mdx", "filePath": "/www/apps/resources/references/utils/ShippingProfileUtils/enums/utils.ShippingProfileUtils.ShippingProfileType/page.mdx",
"pathname": "/references/utils/ShippingProfileUtils/enums/utils.ShippingProfileUtils.ShippingProfileType" "pathname": "/references/utils/ShippingProfileUtils/enums/utils.ShippingProfileUtils.ShippingProfileType"
}, },
{
"filePath": "/www/apps/resources/references/utils/classes/utils.GraphQLParser/page.mdx",
"pathname": "/references/utils/classes/utils.GraphQLParser"
},
{ {
"filePath": "/www/apps/resources/references/utils/enums/utils.NotificationStatus/page.mdx", "filePath": "/www/apps/resources/references/utils/enums/utils.NotificationStatus/page.mdx",
"pathname": "/references/utils/enums/utils.NotificationStatus" "pathname": "/references/utils/enums/utils.NotificationStatus"
@@ -19079,18 +19071,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/utils/interfaces/utils.Entity/page.mdx", "filePath": "/www/apps/resources/references/utils/interfaces/utils.Entity/page.mdx",
"pathname": "/references/utils/interfaces/utils.Entity" "pathname": "/references/utils/interfaces/utils.Entity"
}, },
{
"filePath": "/www/apps/resources/references/utils/interfaces/utils.JoinerArgument/page.mdx",
"pathname": "/references/utils/interfaces/utils.JoinerArgument"
},
{
"filePath": "/www/apps/resources/references/utils/interfaces/utils.JoinerDirective/page.mdx",
"pathname": "/references/utils/interfaces/utils.JoinerDirective"
},
{
"filePath": "/www/apps/resources/references/utils/interfaces/utils.RemoteJoinerQuery/page.mdx",
"pathname": "/references/utils/interfaces/utils.RemoteJoinerQuery"
},
{ {
"filePath": "/www/apps/resources/references/utils/utils.CoreFlowsUitls/page.mdx", "filePath": "/www/apps/resources/references/utils/utils.CoreFlowsUitls/page.mdx",
"pathname": "/references/utils/utils.CoreFlowsUitls" "pathname": "/references/utils/utils.CoreFlowsUitls"
+24
View File
@@ -7389,6 +7389,14 @@ export const generatedSidebar = [
"title": "updateTaxRates", "title": "updateTaxRates",
"children": [] "children": []
}, },
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/tax/updateTaxRegions",
"title": "updateTaxRegions",
"children": []
},
{ {
"loaded": true, "loaded": true,
"isPathHref": true, "isPathHref": true,
@@ -11245,6 +11253,14 @@ export const generatedSidebar = [
"title": "updateInventoryLevelsStep", "title": "updateInventoryLevelsStep",
"children": [] "children": []
}, },
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/medusa-workflows/steps/validateInventoryDeleteStep",
"title": "validateInventoryDeleteStep",
"children": []
},
{ {
"loaded": true, "loaded": true,
"isPathHref": true, "isPathHref": true,
@@ -14664,6 +14680,14 @@ export const generatedSidebar = [
"path": "/references/medusa-workflows/updateTaxRatesWorkflow", "path": "/references/medusa-workflows/updateTaxRatesWorkflow",
"title": "updateTaxRatesWorkflow", "title": "updateTaxRatesWorkflow",
"children": [] "children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/medusa-workflows/updateTaxRegionsWorkflow",
"title": "updateTaxRegionsWorkflow",
"children": []
} }
], ],
"loaded": true "loaded": true
@@ -1139,6 +1139,11 @@ export const slugChanges = [
"newSlug": "/references/medusa-workflows/steps/updateInventoryLevelsStep", "newSlug": "/references/medusa-workflows/steps/updateInventoryLevelsStep",
"filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryLevelsStep/page.mdx" "filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryLevelsStep/page.mdx"
}, },
{
"origSlug": "/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep",
"newSlug": "/references/medusa-workflows/steps/validateInventoryDeleteStep",
"filePath": "/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx"
},
{ {
"origSlug": "/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryItemsForCreate", "origSlug": "/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryItemsForCreate",
"newSlug": "/references/medusa-workflows/steps/validateInventoryItemsForCreate", "newSlug": "/references/medusa-workflows/steps/validateInventoryItemsForCreate",
@@ -3109,6 +3114,11 @@ export const slugChanges = [
"newSlug": "/references/medusa-workflows/updateTaxRatesWorkflow", "newSlug": "/references/medusa-workflows/updateTaxRatesWorkflow",
"filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRatesWorkflow/page.mdx" "filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRatesWorkflow/page.mdx"
}, },
{
"origSlug": "/references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRegionsWorkflow",
"newSlug": "/references/medusa-workflows/updateTaxRegionsWorkflow",
"filePath": "/www/apps/resources/references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRegionsWorkflow/page.mdx"
},
{ {
"origSlug": "/references/core_flows/User/Steps_User/functions/core_flows.User.Steps_User.createUsersStep", "origSlug": "/references/core_flows/User/Steps_User/functions/core_flows.User.Steps_User.createUsersStep",
"newSlug": "/references/medusa-workflows/steps/createUsersStep", "newSlug": "/references/medusa-workflows/steps/createUsersStep",
@@ -6649,6 +6659,11 @@ export const slugChanges = [
"newSlug": "/references/tax/updateTaxRates", "newSlug": "/references/tax/updateTaxRates",
"filePath": "/www/apps/resources/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRates/page.mdx" "filePath": "/www/apps/resources/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRates/page.mdx"
}, },
{
"origSlug": "/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRegions",
"newSlug": "/references/tax/updateTaxRegions",
"filePath": "/www/apps/resources/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRegions/page.mdx"
},
{ {
"origSlug": "/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.upsertTaxRates", "origSlug": "/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.upsertTaxRates",
"newSlug": "/references/tax/upsertTaxRates", "newSlug": "/references/tax/upsertTaxRates",
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `authenticate` method. This belongs to the API Key Module. This documentation provides a reference to the `authenticate` method. This belongs to the API Key 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 verifies whether a token is valid, considering it authenticated. This method verifies whether a token is valid, considering it authenticated.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `createApiKeys` method. This belongs to the API Key Module. This documentation provides a reference to the `createApiKeys` method. This belongs to the API Key Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## createApiKeys(data, sharedContext?): Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)[]&#62; ## createApiKeys(data, sharedContext?): Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)[]&#62;
This method creates API keys. This method creates API keys.
@@ -54,4 +60,4 @@ const apiKey = await apiKeyModuleService.createApiKeys({
### Returns ### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created API key.","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createApiKeys"/> <TypeList types={[{"name":"Promise","type":"Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created API key.","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createApiKeys"/>
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteApiKeys` method. This belongs to the API Key Module. This documentation provides a reference to the `deleteApiKeys` method. This belongs to the API Key Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## deleteApiKeys(ids, sharedContext?): Promise&#60;void&#62; ## deleteApiKeys(ids, sharedContext?): Promise&#60;void&#62;
This method deletes API keys by their IDs. This method deletes API keys by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listAndCountApiKeys` method. This belongs to the API Key Module. This documentation provides a reference to the `listAndCountApiKeys` method. This belongs to the API Key Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of API keys along with the total count of available API keys satisfying the provided filters. This method retrieves a paginated list of API keys along with the total count of available API keys satisfying the provided filters.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listApiKeys` method. This belongs to the API Key Module. This documentation provides a reference to the `listApiKeys` method. This belongs to the API Key Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of API keys based on optional filters and configuration. This method retrieves a paginated list of API keys based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `retrieveApiKey` method. This belongs to the API Key Module. This documentation provides a reference to the `retrieveApiKey` method. This belongs to the API Key Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves an API key by its ID. This method retrieves an API key by its ID.
## Example ## Example
@@ -24,4 +30,4 @@ const apiKey = await apiKeyModuleService.retrieveApiKey("apk_123")
## Returns ## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved API key.","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveApiKey"/> <TypeList types={[{"name":"Promise","type":"Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved API key.","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveApiKey"/>
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `revoke` method. This belongs to the API Key Module. This documentation provides a reference to the `revoke` method. This belongs to the API Key Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## revoke(selector, data, sharedContext?): Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)[]&#62; ## revoke(selector, data, sharedContext?): Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)[]&#62;
This method revokes API keys based on the filters provided. This method revokes API keys based on the filters provided.
@@ -57,4 +63,4 @@ const apiKey = await apiKeyModuleService.revoke("apk_123", {
### Returns ### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The revoked API key.","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="revoke"/> <TypeList types={[{"name":"Promise","type":"Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The revoked API key.","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="revoke"/>
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `updateApiKeys` method. This belongs to the API Key Module. This documentation provides a reference to the `updateApiKeys` method. This belongs to the API Key Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## updateApiKeys(id, data, sharedContext?): Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62; ## updateApiKeys(id, data, sharedContext?): Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;
This method updates an existing API key. This method updates an existing API key.
@@ -28,7 +34,7 @@ const apiKey = await apiKeyModuleService.updateApiKeys("apk_123", {
### Returns ### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated API key.","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateApiKeys"/> <TypeList types={[{"name":"Promise","type":"Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated API key.","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateApiKeys"/>
## updateApiKeys(selector, data, sharedContext?): Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)[]&#62; ## updateApiKeys(selector, data, sharedContext?): Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)[]&#62;
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `upsertApiKeys` method. This belongs to the API Key Module. This documentation provides a reference to the `upsertApiKeys` method. This belongs to the API Key Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## upsertApiKeys(data, sharedContext?): Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)[]&#62; ## upsertApiKeys(data, sharedContext?): Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)[]&#62;
This method updates or creates API keys if they don't exist. This method updates or creates API keys if they don't exist.
@@ -57,4 +63,4 @@ const apiKey = await apiKeyModuleService.upsertApiKeys({
### Returns ### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created or updated API key.","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertApiKeys"/> <TypeList types={[{"name":"Promise","type":"Promise&#60;[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created or updated API key.","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertApiKeys"/>
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The API key details. The API key details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ApiKeyDTO"/> <TypeList types={[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ApiKeyDTO"/>
@@ -9,6 +9,12 @@ import { TypeList } from "docs-ui"
This section of the documentation provides a reference to the `IApiKeyModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the API Key Module. This section of the documentation provides a reference to the `IApiKeyModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the API Key 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 Api Key Module. The main service interface for the Api Key Module.
## Methods ## Methods
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"
**Event**: `Object` **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](../api_key.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"/> <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](../api_key.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` **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"/> <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` **OperatorMap**: `Object`
## Properties
<TypeList types={[{"name":"$and","type":"[Query](../api_key.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../api_key.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62; \\| [ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../api_key.Query/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../api_key.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"/> <TypeList types={[{"name":"$and","type":"[Query](../api_key.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../api_key.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62; \\| [ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../api_key.Query/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../api_key.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../api_key.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` **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/api_key.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"/> <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/api_key.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"/>
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `authenticate` method. This belongs to the Auth Module. This documentation provides a reference to the `authenticate` method. This belongs to the Auth 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 authenticate a user using a provider. The `authenticate` method of the This method is used to authenticate a user using a provider. The `authenticate` method of the
underlying provider is called, passing it the `providerData` parameter as a parameter. The method underlying provider is called, passing it the `providerData` parameter as a parameter. The method
returns the data returned by the provider. returns the data returned by the provider.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `createAuthIdentities` method. This belongs to the Auth Module. This documentation provides a reference to the `createAuthIdentities` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## createAuthIdentities(data, sharedContext?): Promise&#60;[AuthIdentityDTO](../../../interfaces/auth.AuthIdentityDTO/page.mdx)[]&#62; ## createAuthIdentities(data, sharedContext?): Promise&#60;[AuthIdentityDTO](../../../interfaces/auth.AuthIdentityDTO/page.mdx)[]&#62;
This method creates auth identities. This method creates auth identities.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `createProviderIdentities` method. This belongs to the Auth Module. This documentation provides a reference to the `createProviderIdentities` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## createProviderIdentities(data, sharedContext?): Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62; ## createProviderIdentities(data, sharedContext?): Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62;
This method creates provider identities. This method creates provider identities.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteAuthIdentities` method. This belongs to the Auth Module. This documentation provides a reference to the `deleteAuthIdentities` method. This belongs to the Auth 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 a auth by its ID. This method deletes a auth by its ID.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteProviderIdentities` method. This belongs to the Auth Module. This documentation provides a reference to the `deleteProviderIdentities` method. This belongs to the Auth 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 a provider identity by its ID. This method deletes a provider identity by its ID.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listAndCountAuthIdentities` method. This belongs to the Auth Module. This documentation provides a reference to the `listAndCountAuthIdentities` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of auth identities along with the total count of available auth identities satisfying the provided filters. This method retrieves a paginated list of auth identities along with the total count of available auth identities satisfying the provided filters.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listAuthIdentities` method. This belongs to the Auth Module. This documentation provides a reference to the `listAuthIdentities` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of auth identities based on optional filters and configuration. This method retrieves a paginated list of auth identities based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listProviderIdentities` method. This belongs to the Auth Module. This documentation provides a reference to the `listProviderIdentities` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of provider identities based on optional filters and configuration. This method retrieves a paginated list of provider identities based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `register` method. This belongs to the Auth Module. This documentation provides a reference to the `register` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## Parameters ## Parameters
<TypeList types={[{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providerData","type":"[AuthenticationInput](../../../interfaces/auth.AuthenticationInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"url","type":"`string`","description":"URL of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"`Record<string, string>`","description":"Headers of incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`Record<string, string>`","description":"Query params of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"`Record<string, string>`","description":"Body of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"protocol","type":"`string`","description":"Protocol of the incoming authentication request (For example, `https`).","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="register"/> <TypeList types={[{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providerData","type":"[AuthenticationInput](../../../interfaces/auth.AuthenticationInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"url","type":"`string`","description":"URL of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"`Record<string, string>`","description":"Headers of incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`Record<string, string>`","description":"Query params of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"`Record<string, string>`","description":"Body of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"protocol","type":"`string`","description":"Protocol of the incoming authentication request (For example, `https`).","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="register"/>
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `retrieveAuthIdentity` method. This belongs to the Auth Module. This documentation provides a reference to the `retrieveAuthIdentity` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves an auth identity by its ID. This method retrieves an auth identity by its ID.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `retrieveProviderIdentity` method. This belongs to the Auth Module. This documentation provides a reference to the `retrieveProviderIdentity` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a provider identity by its ID. This method retrieves a provider identity by its ID.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `updateAuthIdentities` method. This belongs to the Auth Module. This documentation provides a reference to the `updateAuthIdentities` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## updateAuthIdentities(data, sharedContext?): Promise&#60;[AuthIdentityDTO](../../../interfaces/auth.AuthIdentityDTO/page.mdx)[]&#62; ## updateAuthIdentities(data, sharedContext?): Promise&#60;[AuthIdentityDTO](../../../interfaces/auth.AuthIdentityDTO/page.mdx)[]&#62;
This method updates existing auths. This method updates existing auths.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `updateProvider` method. This belongs to the Auth Module. This documentation provides a reference to the `updateProvider` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## Parameters ## Parameters
<TypeList types={[{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providerData","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProvider"/> <TypeList types={[{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providerData","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProvider"/>
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `updateProviderIdentities` method. This belongs to the Auth Module. This documentation provides a reference to the `updateProviderIdentities` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## updateProviderIdentities(data, sharedContext?): Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62; ## updateProviderIdentities(data, sharedContext?): Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62;
This method updates existing provider identities. This method updates existing provider identities.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `validateCallback` method. This belongs to the Auth Module. This documentation provides a reference to the `validateCallback` method. This belongs to the Auth Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
When authenticating users with a third-party provider, such as Google, the user performs an When authenticating users with a third-party provider, such as Google, the user performs an
action to finish the authentication, such as enter their credentials in Google's sign-in action to finish the authentication, such as enter their credentials in Google's sign-in
form. form.
@@ -9,6 +9,12 @@ import { TypeList } from "docs-ui"
This section of the documentation provides a reference to the `IAuthModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Auth Module. This section of the documentation provides a reference to the `IAuthModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Auth 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 Auth Module. The main service interface for the Auth Module.
## Methods ## Methods
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"
**Event**: `Object` **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](../auth.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"/> <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](../auth.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` **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"/> <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"
**RawMessageFormat**: `Object` **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/auth.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"/> <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/auth.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"/>
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `addLineItemAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `addLineItemAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## addLineItemAdjustments(data): Promise&#60;[LineItemAdjustmentDTO](../../../interfaces/cart.LineItemAdjustmentDTO/page.mdx)[]&#62; ## addLineItemAdjustments(data): Promise&#60;[LineItemAdjustmentDTO](../../../interfaces/cart.LineItemAdjustmentDTO/page.mdx)[]&#62;
This method adds line item adjustments to line items. This method adds line item adjustments to line items.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `addLineItemTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `addLineItemTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## addLineItemTaxLines(taxLines): Promise&#60;[LineItemTaxLineDTO](../../../interfaces/cart.LineItemTaxLineDTO/page.mdx)[]&#62; ## addLineItemTaxLines(taxLines): Promise&#60;[LineItemTaxLineDTO](../../../interfaces/cart.LineItemTaxLineDTO/page.mdx)[]&#62;
This method creates and adds line item tax lines. This method creates and adds line item tax lines.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `addLineItems` method. This belongs to the Cart Module. This documentation provides a reference to the `addLineItems` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## addLineItems(data): Promise&#60;[CartLineItemDTO](../../../interfaces/cart.CartLineItemDTO/page.mdx)[]&#62; ## addLineItems(data): Promise&#60;[CartLineItemDTO](../../../interfaces/cart.CartLineItemDTO/page.mdx)[]&#62;
This method adds a line item to a cart This method adds a line item to a cart
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `addShippingMethodAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `addShippingMethodAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## addShippingMethodAdjustments(data): Promise&#60;[ShippingMethodAdjustmentDTO](../../../interfaces/cart.ShippingMethodAdjustmentDTO/page.mdx)[]&#62; ## addShippingMethodAdjustments(data): Promise&#60;[ShippingMethodAdjustmentDTO](../../../interfaces/cart.ShippingMethodAdjustmentDTO/page.mdx)[]&#62;
This method adds shipping method adjustments to shipping methods. This method adds shipping method adjustments to shipping methods.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `addShippingMethodTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `addShippingMethodTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## addShippingMethodTaxLines(taxLines): Promise&#60;[ShippingMethodTaxLineDTO](../../../interfaces/cart.ShippingMethodTaxLineDTO/page.mdx)[]&#62; ## addShippingMethodTaxLines(taxLines): Promise&#60;[ShippingMethodTaxLineDTO](../../../interfaces/cart.ShippingMethodTaxLineDTO/page.mdx)[]&#62;
This method creates and adds shipping method tax lines. This method creates and adds shipping method tax lines.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `addShippingMethods` method. This belongs to the Cart Module. This documentation provides a reference to the `addShippingMethods` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## addShippingMethods(data): Promise&#60;[CartShippingMethodDTO](../../../interfaces/cart.CartShippingMethodDTO/page.mdx)&#62; ## addShippingMethods(data): Promise&#60;[CartShippingMethodDTO](../../../interfaces/cart.CartShippingMethodDTO/page.mdx)&#62;
This method adds a shipping method to carts. This method adds a shipping method to carts.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `createAddresses` method. This belongs to the Cart Module. This documentation provides a reference to the `createAddresses` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## createAddresses(data, sharedContext?): Promise&#60;[CartAddressDTO](../../../interfaces/cart.CartAddressDTO/page.mdx)[]&#62; ## createAddresses(data, sharedContext?): Promise&#60;[CartAddressDTO](../../../interfaces/cart.CartAddressDTO/page.mdx)[]&#62;
This method creates addresses. This method creates addresses.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `createCarts` method. This belongs to the Cart Module. This documentation provides a reference to the `createCarts` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## createCarts(data, sharedContext?): Promise&#60;[CartDTO](../../../interfaces/cart.CartDTO/page.mdx)[]&#62; ## createCarts(data, sharedContext?): Promise&#60;[CartDTO](../../../interfaces/cart.CartDTO/page.mdx)[]&#62;
This method creates carts. This method creates carts.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteAddresses` method. This belongs to the Cart Module. This documentation provides a reference to the `deleteAddresses` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## deleteAddresses(ids, sharedContext?): Promise&#60;void&#62; ## deleteAddresses(ids, sharedContext?): Promise&#60;void&#62;
This method deletes addresses by their IDs. This method deletes addresses by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteCarts` method. This belongs to the Cart Module. This documentation provides a reference to the `deleteCarts` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## deleteCarts(cartIds, sharedContext?): Promise&#60;void&#62; ## deleteCarts(cartIds, sharedContext?): Promise&#60;void&#62;
This method deletes carts by their IDs. This method deletes carts by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteLineItemAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `deleteLineItemAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## deleteLineItemAdjustments(ids, sharedContext?): Promise&#60;void&#62; ## deleteLineItemAdjustments(ids, sharedContext?): Promise&#60;void&#62;
This method deletes line item adjustments by their IDs. This method deletes line item adjustments by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteLineItemTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `deleteLineItemTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## deleteLineItemTaxLines(ids, sharedContext?): Promise&#60;void&#62; ## deleteLineItemTaxLines(ids, sharedContext?): Promise&#60;void&#62;
This method deletes line item tax lines by their IDs. This method deletes line item tax lines by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteLineItems` method. This belongs to the Cart Module. This documentation provides a reference to the `deleteLineItems` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## deleteLineItems(ids, sharedContext?): Promise&#60;void&#62; ## deleteLineItems(ids, sharedContext?): Promise&#60;void&#62;
This method deletes line items by their IDs. This method deletes line items by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteShippingMethodAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `deleteShippingMethodAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## deleteShippingMethodAdjustments(ids, sharedContext?): Promise&#60;void&#62; ## deleteShippingMethodAdjustments(ids, sharedContext?): Promise&#60;void&#62;
This method deletes shipping method adjustments by their IDs. This method deletes shipping method adjustments by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteShippingMethodTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `deleteShippingMethodTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## deleteShippingMethodTaxLines(ids, sharedContext?): Promise&#60;void&#62; ## deleteShippingMethodTaxLines(ids, sharedContext?): Promise&#60;void&#62;
This method deletes shipping method tax lines by their IDs. This method deletes shipping method tax lines by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `deleteShippingMethods` method. This belongs to the Cart Module. This documentation provides a reference to the `deleteShippingMethods` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## deleteShippingMethods(ids, sharedContext?): Promise&#60;void&#62; ## deleteShippingMethods(ids, sharedContext?): Promise&#60;void&#62;
This method deletes shipping methods by their IDs. This method deletes shipping methods by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listAddresses` method. This belongs to the Cart Module. This documentation provides a reference to the `listAddresses` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of addresses based on optional filters and configuration. This method retrieves a paginated list of addresses based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listAndCountCarts` method. This belongs to the Cart Module. This documentation provides a reference to the `listAndCountCarts` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of carts along with the total count of available carts satisfying the provided filters. This method retrieves a paginated list of carts along with the total count of available carts satisfying the provided filters.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listCarts` method. This belongs to the Cart Module. This documentation provides a reference to the `listCarts` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of carts based on optional filters and configuration. This method retrieves a paginated list of carts based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listLineItemAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `listLineItemAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of line item adjustments based on optional filters and configuration. This method retrieves a paginated list of line item adjustments based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listLineItemTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `listLineItemTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of line item tax lines based on optional filters and configuration. This method retrieves a paginated list of line item tax lines based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listLineItems` method. This belongs to the Cart Module. This documentation provides a reference to the `listLineItems` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of line items based on optional filters and configuration. This method retrieves a paginated list of line items based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listShippingMethodAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `listShippingMethodAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of shipping method adjustments based on optional filters and configuration. This method retrieves a paginated list of shipping method adjustments based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listShippingMethodTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `listShippingMethodTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of shipping method tax lines based on optional filters and configuration. This method retrieves a paginated list of shipping method tax lines based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `listShippingMethods` method. This belongs to the Cart Module. This documentation provides a reference to the `listShippingMethods` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a paginated list of shipping methods based on optional filters and configuration. This method retrieves a paginated list of shipping methods based on optional filters and configuration.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `restoreAddresses` method. This belongs to the Cart Module. This documentation provides a reference to the `restoreAddresses` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method restores soft deleted addresses by their IDs. This method restores soft deleted addresses by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `restoreCarts` method. This belongs to the Cart Module. This documentation provides a reference to the `restoreCarts` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method restores soft deleted carts by their IDs. This method restores soft deleted carts by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `restoreLineItemAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `restoreLineItemAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method restores soft deleted line item adjustments by their IDs. This method restores soft deleted line item adjustments by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `restoreLineItemTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `restoreLineItemTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method restores soft deleted line item tax lines by its IDs. This method restores soft deleted line item tax lines by its IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `restoreLineItems` method. This belongs to the Cart Module. This documentation provides a reference to the `restoreLineItems` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method restores soft deleted line items by their IDs. This method restores soft deleted line items by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `restoreShippingMethodAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `restoreShippingMethodAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method restores soft deleted shipping method adjustments by their IDs. This method restores soft deleted shipping method adjustments by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `restoreShippingMethodTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `restoreShippingMethodTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method restores soft deleted shipping method tax lines by their IDs. This method restores soft deleted shipping method tax lines by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `restoreShippingMethods` method. This belongs to the Cart Module. This documentation provides a reference to the `restoreShippingMethods` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method restores soft deleted shipping methods by their IDs. This method restores soft deleted shipping methods by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `retrieveCart` method. This belongs to the Cart Module. This documentation provides a reference to the `retrieveCart` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a cart by its ID. This method retrieves a cart by its ID.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `retrieveLineItem` method. This belongs to the Cart Module. This documentation provides a reference to the `retrieveLineItem` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method retrieves a line item by its ID. This method retrieves a line item by its ID.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `setLineItemAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `setLineItemAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method set the line item adjustments of line items in a cart. The existing line item adjustments, except those This method set the line item adjustments of line items in a cart. The existing line item adjustments, except those
included in the specified list, of an item are removed and replaced with the specified adjustments. included in the specified list, of an item are removed and replaced with the specified adjustments.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `setLineItemTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `setLineItemTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method sets the line item tax lines in a cart. The existing line item tax lines, This method sets the line item tax lines in a cart. The existing line item tax lines,
except those included in the specified list, are removed and replaced with the specified tax lines. except those included in the specified list, are removed and replaced with the specified tax lines.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `setShippingMethodAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `setShippingMethodAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method sets the shipping method adjustment of shipping methods in a cart. The existing shipping method adjustments, This method sets the shipping method adjustment of shipping methods in a cart. The existing shipping method adjustments,
except those included in the specified list, of an item are removed and replaced with the specified adjustments. except those included in the specified list, of an item are removed and replaced with the specified adjustments.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `setShippingMethodTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `setShippingMethodTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method sets the shipping item tax lines in a cart. The shipping line item tax lines, This method sets the shipping item tax lines in a cart. The shipping line item tax lines,
except those included in the specified list, are removed and replaced with the specified tax lines. except those included in the specified list, are removed and replaced with the specified tax lines.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `softDeleteAddresses` method. This belongs to the Cart Module. This documentation provides a reference to the `softDeleteAddresses` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method soft deletes addresses by their IDs. This method soft deletes addresses by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `softDeleteCarts` method. This belongs to the Cart Module. This documentation provides a reference to the `softDeleteCarts` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method soft deletes carts by their IDs. This method soft deletes carts by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `softDeleteLineItemAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `softDeleteLineItemAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method soft deletes line item adjustments by their IDs. This method soft deletes line item adjustments by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `softDeleteLineItemTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `softDeleteLineItemTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method soft deletes line item tax lines by their IDs. This method soft deletes line item tax lines by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `softDeleteLineItems` method. This belongs to the Cart Module. This documentation provides a reference to the `softDeleteLineItems` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method soft deletes line items by their IDs. This method soft deletes line items by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `softDeleteShippingMethodAdjustments` method. This belongs to the Cart Module. This documentation provides a reference to the `softDeleteShippingMethodAdjustments` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method soft deletes shipping method adjustments by their IDs. This method soft deletes shipping method adjustments by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `softDeleteShippingMethodTaxLines` method. This belongs to the Cart Module. This documentation provides a reference to the `softDeleteShippingMethodTaxLines` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method soft deletes shipping method tax lines by their IDs. This method soft deletes shipping method tax lines by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `softDeleteShippingMethods` method. This belongs to the Cart Module. This documentation provides a reference to the `softDeleteShippingMethods` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method soft deletes shipping methods by their IDs. This method soft deletes shipping methods by their IDs.
## Example ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `updateAddresses` method. This belongs to the Cart Module. This documentation provides a reference to the `updateAddresses` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## updateAddresses(data, sharedContext?): Promise&#60;[CartAddressDTO](../../../interfaces/cart.CartAddressDTO/page.mdx)[]&#62; ## updateAddresses(data, sharedContext?): Promise&#60;[CartAddressDTO](../../../interfaces/cart.CartAddressDTO/page.mdx)[]&#62;
This method updates existing addresses. This method updates existing addresses.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `updateCarts` method. This belongs to the Cart Module. This documentation provides a reference to the `updateCarts` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## updateCarts(data): Promise&#60;[CartDTO](../../../interfaces/cart.CartDTO/page.mdx)[]&#62; ## updateCarts(data): Promise&#60;[CartDTO](../../../interfaces/cart.CartDTO/page.mdx)[]&#62;
This method updates existing carts. This method updates existing carts.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `updateLineItems` method. This belongs to the Cart Module. This documentation provides a reference to the `updateLineItems` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## updateLineItems(data): Promise&#60;[CartLineItemDTO](../../../interfaces/cart.CartLineItemDTO/page.mdx)[]&#62; ## updateLineItems(data): Promise&#60;[CartLineItemDTO](../../../interfaces/cart.CartLineItemDTO/page.mdx)[]&#62;
This method updates existing line items. This method updates existing line items.
@@ -9,6 +9,12 @@ import { TypeList } from "docs-ui"
This section of the documentation provides a reference to the `ICartModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Cart Module. This section of the documentation provides a reference to the `ICartModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Cart 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 Cart Module. The main service interface for the Cart Module.
## Methods ## Methods
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"
**BigNumberRawValue**: `Object` **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"/> <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` **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](../cart.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"/> <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](../cart.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` **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"/> <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` **OperatorMap**: `Object`
## Properties
<TypeList types={[{"name":"$and","type":"[Query](../cart.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../cart.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62; \\| [ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../cart.Query/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../cart.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"/> <TypeList types={[{"name":"$and","type":"[Query](../cart.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../cart.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62; \\| [ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../cart.Query/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../cart.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../cart.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` **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/cart.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"/> <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/cart.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"/>
@@ -17,4 +17,4 @@ This step creates one or more API keys.
## Output ## Output
<TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createApiKeysStep"/> <TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createApiKeysStep"/>
@@ -17,4 +17,4 @@ This step revokes one or more API keys.
## Output ## Output
<TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="revokeApiKeysStep"/> <TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="revokeApiKeysStep"/>
@@ -17,4 +17,4 @@ This step updates one or more API keys.
## Output ## Output
<TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateApiKeysStep"/> <TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateApiKeysStep"/>
@@ -21,4 +21,4 @@ This workflow creates one or more API keys.
## Output ## Output
<TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createApiKeysWorkflow"/> <TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createApiKeysWorkflow"/>
@@ -21,4 +21,4 @@ This workflow revokes one or more API keys.
## Output ## Output
<TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="revokeApiKeysWorkflow"/> <TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="revokeApiKeysWorkflow"/>
@@ -21,4 +21,4 @@ This workflow creates one or more API keys.
## Output ## Output
<TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateApiKeysWorkflow"/> <TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the API key was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date the API key was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateApiKeysWorkflow"/>
Loaded 100 of 2313 files, more files were not shown because too many files have changed in this diff. Show more