Skip to content

chore(docs): Generated References #511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

chore(docs): Generated References #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 88 additions & 80 deletions www/apps/resources/generated/files-map.mjs
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions www/apps/resources/generated/sidebar.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3185,6 +3185,13 @@ export const generatedSidebar = [
"path": "/references/order/updateReturns",
"title": "updateReturns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/updateShippingMethods",
"title": "updateShippingMethods",
"children": []
}
]
}
Expand Down
5 changes: 5 additions & 0 deletions www/apps/resources/generated/slug-changes.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2634,6 +2634,11 @@ export const slugChanges = [
"newSlug": "/references/order/updateReturns",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateReturns/page.mdx"
},
{
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateShippingMethods",
"newSlug": "/references/order/updateShippingMethods",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateShippingMethods/page.mdx"
},
{
"origSlug": "/references/order/interfaces/order.IOrderModuleService",
"newSlug": "/references/order",
Expand Down
2 changes: 1 addition & 1 deletion ..._key/IMessageAggregator/methods/api_key.IMessageAggregator.getMessages/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"

## Returns

<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/api_key.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/api_key.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/api_key.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/api_key.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/api_key.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/api_key.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
2 changes: 1 addition & 1 deletion ...ces/api_key/IMessageAggregator/methods/api_key.IMessageAggregator.save/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"

## Parameters

<TypeList types={[{"name":"msg","type":"[Message](../../../types/api_key.Message/page.mdx) \\| [Message](../../../types/api_key.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/api_key.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
<TypeList types={[{"name":"msg","type":"[Message](../../../types/api_key.Message/page.mdx) \\| [Message](../../../types/api_key.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"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](../../../types/api_key.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>

## Returns

Expand Down
13 changes: 13 additions & 0 deletions www/apps/resources/references/api_key/types/api_key.Event/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
displayed_sidebar: apiKeyReference
---

import { TypeList } from "docs-ui"

# Event

**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":[]}]}]} sectionTitle="Event"/>
2 changes: 1 addition & 1 deletion www/apps/resources/references/api_key/types/api_key.Message/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"

# Message

**Message**: [MessageBody](../api_key.MessageBody/page.mdx)&#60;TData&#62; & `object`
**Message**: [Event](../api_key.Event/page.mdx)&#60;TData&#62; & `object`
13 changes: 0 additions & 13 deletions www/apps/resources/references/api_key/types/api_key.MessageBody/page.mdx
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion ...es/auth/IMessageAggregator/methods/auth.IMessageAggregator.getMessages/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"

## Returns

<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/auth.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/auth.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/auth.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/auth.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/auth.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/auth.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
2 changes: 1 addition & 1 deletion ...eferences/auth/IMessageAggregator/methods/auth.IMessageAggregator.save/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"

## Parameters

<TypeList types={[{"name":"msg","type":"[Message](../../../types/auth.Message/page.mdx) \\| [Message](../../../types/auth.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/auth.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
<TypeList types={[{"name":"msg","type":"[Message](../../../types/auth.Message/page.mdx) \\| [Message](../../../types/auth.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"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](../../../types/auth.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>

## Returns

Expand Down
13 changes: 13 additions & 0 deletions www/apps/resources/references/auth/types/auth.Event/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
displayed_sidebar: authReference
---

import { TypeList } from "docs-ui"

# Event

**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":[]}]}]} sectionTitle="Event"/>
2 changes: 1 addition & 1 deletion www/apps/resources/references/auth/types/auth.Message/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"

# Message

**Message**: [MessageBody](../auth.MessageBody/page.mdx)&#60;TData&#62; & `object`
**Message**: [Event](../auth.Event/page.mdx)&#60;TData&#62; & `object`
13 changes: 0 additions & 13 deletions www/apps/resources/references/auth/types/auth.MessageBody/page.mdx
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion ...es/cart/IMessageAggregator/methods/cart.IMessageAggregator.getMessages/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"

## Returns

<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/cart.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/cart.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/cart.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/cart.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/cart.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/cart.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
2 changes: 1 addition & 1 deletion ...eferences/cart/IMessageAggregator/methods/cart.IMessageAggregator.save/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"

## Parameters

<TypeList types={[{"name":"msg","type":"[Message](../../../types/cart.Message/page.mdx) \\| [Message](../../../types/cart.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/cart.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
<TypeList types={[{"name":"msg","type":"[Message](../../../types/cart.Message/page.mdx) \\| [Message](../../../types/cart.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"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](../../../types/cart.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>

## Returns

Expand Down
13 changes: 13 additions & 0 deletions www/apps/resources/references/cart/types/cart.Event/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartReference
---

import { TypeList } from "docs-ui"

# Event

**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":[]}]}]} sectionTitle="Event"/>
2 changes: 1 addition & 1 deletion www/apps/resources/references/cart/types/cart.Message/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"

# Message

**Message**: [MessageBody](../cart.MessageBody/page.mdx)&#60;TData&#62; & `object`
**Message**: [Event](../cart.Event/page.mdx)&#60;TData&#62; & `object`
13 changes: 0 additions & 13 deletions www/apps/resources/references/cart/types/cart.MessageBody/page.mdx
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion ...ncy/IMessageAggregator/methods/currency.IMessageAggregator.getMessages/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"

## Returns

<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/currency.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/currency.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/currency.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/currency.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/currency.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/currency.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
2 changes: 1 addition & 1 deletion ...s/currency/IMessageAggregator/methods/currency.IMessageAggregator.save/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"

## Parameters

<TypeList types={[{"name":"msg","type":"[Message](../../../types/currency.Message/page.mdx) \\| [Message](../../../types/currency.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/currency.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
<TypeList types={[{"name":"msg","type":"[Message](../../../types/currency.Message/page.mdx) \\| [Message](../../../types/currency.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"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](../../../types/currency.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>

## Returns

Expand Down
Loading