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

chore(docs): Generated References (#5666)

Browse Source 
Generated the following references:
- `entities`
- `js-client`
- `pricing`
- `services`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-21 12:36:09 +00:00
committed by GitHub
parent 4774b8ff3a
commit 2b9e8bda5e
178 changed files with 10576 additions and 718 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
www/apps/docs/content/references/js-client/internal/classes/internal.AbstractEventBusModuleService.mdx
View File

@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Implements
- [IEventBusModuleService](../interfaces/internal.IEventBusModuleService.mdx)
- [IEventBusModuleService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx)
## Properties
@@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "data",
"type": "[EmitData](../types/internal.EmitData.mdx)&#60;T&#62;[]",
"type": "[EmitData](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx)&#60;T&#62;[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -151,7 +151,7 @@ ___
},
{
"name": "__namedParameters.subscriber",
"type": "[Subscriber](../types/internal.Subscriber.mdx)&#60;unknown&#62;",
"type": "[Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)&#60;unknown&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ ___
},
{
"name": "subscriber",
"type": "[Subscriber](../types/internal.Subscriber.mdx)&#60;unknown&#62;",
"type": "[Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)&#60;unknown&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -210,7 +210,7 @@ ___
},
{
"name": "context",
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
"type": "[SubscriberContext](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -251,7 +251,7 @@ ___
},
{
"name": "subscriber",
"type": "[Subscriber](../types/internal.Subscriber.mdx)&#60;unknown&#62;",
"type": "[Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)&#60;unknown&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -260,7 +260,7 @@ ___
},
{
"name": "context",
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
"type": "[SubscriberContext](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
"description": "",
"optional": false,
"defaultValue": "",

9
www/apps/docs/content/references/js-client/internal/classes/internal.AdminPostProductCategoriesCategoryReq.mdx
View File

@@ -45,6 +45,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs to hold additional information.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",

9
www/apps/docs/content/references/js-client/internal/classes/internal.AdminPostProductCategoriesReq.mdx
View File

@@ -45,6 +45,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs to hold additional information.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",

9
www/apps/docs/content/references/js-client/internal/classes/internal.ProductCategory.mdx
View File

@@ -74,6 +74,15 @@ A product category can be used to categorize products into a hierarchy of catego
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",

18
www/apps/docs/content/references/js-client/internal/classes/internal.internal.EventBusService.mdx
View File

@@ -11,7 +11,7 @@ subscribers when events happen. Events will run asynchronously.
## Implements
- [IEventBusService](../interfaces/internal.IEventBusService.mdx)
- [IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)
## Properties
@@ -45,7 +45,7 @@ subscribers when events happen. Events will run asynchronously.
},
{
"name": "config_",
"type": "[ConfigModule](../types/internal.ConfigModule.mdx)",
"type": "[ConfigModule](../../CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -63,7 +63,7 @@ subscribers when events happen. Events will run asynchronously.
},
{
"name": "logger_",
"type": "[Logger](../interfaces/internal.Logger.mdx)",
"type": "[Logger](../../LoggerTypes/interfaces/internal.internal-1.LoggerTypes.Logger.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -135,7 +135,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IEventBusModuleService",
"type": "[IEventBusModuleService](../interfaces/internal.IEventBusModuleService.mdx)",
"type": "[IEventBusModuleService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -211,7 +211,7 @@ Calls all subscribers when an event occurs.
<ParameterTypes parameters={[
{
"name": "data",
"type": "[EmitData](../types/internal.EmitData.mdx)&#60;T&#62;[]",
"type": "[EmitData](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx)&#60;T&#62;[]",
"description": "The data to use to process the events",
"optional": false,
"defaultValue": "",
@@ -422,7 +422,7 @@ Adds a function to a list of event subscribers.
},
{
"name": "subscriber",
"type": "[Subscriber](../types/internal.Subscriber.mdx)&#60;unknown&#62;",
"type": "[Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)&#60;unknown&#62;",
"description": "the function to be called when a certain event happens. Subscribers must return a Promise.",
"optional": false,
"defaultValue": "",
@@ -431,7 +431,7 @@ Adds a function to a list of event subscribers.
},
{
"name": "context",
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
"type": "[SubscriberContext](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
"description": "subscriber context",
"optional": true,
"defaultValue": "",
@@ -474,7 +474,7 @@ Removes function from the list of event subscribers.
},
{
"name": "subscriber",
"type": "[Subscriber](../types/internal.Subscriber.mdx)&#60;unknown&#62;",
"type": "[Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)&#60;unknown&#62;",
"description": "the function to be removed",
"optional": false,
"defaultValue": "",
@@ -483,7 +483,7 @@ Removes function from the list of event subscribers.
},
{
"name": "context",
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
"type": "[SubscriberContext](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
"description": "subscriber context",
"optional": false,
"defaultValue": "",

2
www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderEditItemChangeService.mdx
View File

@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "eventBus_",
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",

2
www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderEditService.mdx
View File

@@ -236,7 +236,7 @@ ___
<ParameterTypes parameters={[
{
"name": "undefined \\| IInventoryService",
"type": "`undefined` \\| [IInventoryService](../interfaces/internal.IInventoryService.mdx)",
"type": "`undefined` \\| [IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)",
"optional": true,
"defaultValue": "",
"description": "",

2
www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderService.mdx
View File

@@ -137,7 +137,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "inventoryService_",
"type": "[IInventoryService](../interfaces/internal.IInventoryService.mdx)",
"type": "[IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",

4
www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariantInventoryService.mdx
View File

@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "eventBusService_",
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1061,7 +1061,7 @@ Reserves a quantity of a variant
},
{
"name": "context",
"type": "[ReserveQuantityContext](../types/internal.ReserveQuantityContext.mdx)",
"type": "[ReserveQuantityContext](../../InventoryTypes/types/internal.internal-1.InventoryTypes.ReserveQuantityContext.mdx)",
"description": "optional parameters",
"optional": true,
"defaultValue": "",

2
www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelInventoryService.mdx
View File

@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "eventBusService_",
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",

2
www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelLocationService.mdx
View File

@@ -40,7 +40,7 @@ Service for managing the stock locations of sales channels
},
{
"name": "eventBusService_",
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",

2
www/apps/docs/content/references/js-client/internal/classes/internal.internal.StagedJobService.mdx
View File

@@ -148,7 +148,7 @@ ___
<ParameterTypes parameters={[
{
"name": "data",
"type": "[EmitData](../types/internal.EmitData.mdx)&#60;unknown&#62; \\| [EmitData](../types/internal.EmitData.mdx)&#60;unknown&#62;[]",
"type": "[EmitData](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx)&#60;unknown&#62; \\| [EmitData](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx)&#60;unknown&#62;[]",
"description": "",
"optional": false,
"defaultValue": "",

4
www/apps/docs/content/references/js-client/internal/classes/internal.internal.TaxProviderService.mdx
View File

@@ -40,7 +40,7 @@ Finds tax providers and assists in tax related operations.
},
{
"name": "cacheService_",
"type": "[ICacheService](../interfaces/internal.ICacheService.mdx)",
"type": "[ICacheService](../../CacheTypes/interfaces/internal.internal-1.CacheTypes.ICacheService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ Finds tax providers and assists in tax related operations.
},
{
"name": "eventBus_",
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",

2
www/apps/docs/content/references/js-client/internal/classes/internal.internal.TokenService.mdx
View File

@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "configModule_",
"type": "[ConfigModule](../types/internal.ConfigModule.mdx)",
"type": "[ConfigModule](../../CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx)",
"description": "",
"optional": false,
"defaultValue": "",