chore(docs): Generated References (#5743)

Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `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:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions

View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new NotificationService**(container)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -132,29 +132,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -162,6 +146,8 @@ Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -183,7 +169,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -215,7 +201,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -233,7 +219,7 @@ Promise&#60;TResult&#62;
___
### handleEvent
#### handleEvent
`**handleEvent**(eventName, data): Promise&#60;undefined \| void \| [Notification](Notification.mdx)[]&#62;`
@@ -241,7 +227,7 @@ Handles an event by relaying the event data to the subscribing providers.
The result of the notification send will be persisted in the database in
order to allow for resends. Will log any errors that are encountered.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -264,7 +250,7 @@ order to allow for resends. Will log any errors that are encountered.
}
]} />
#### Returns
##### Returns
Promise&#60;undefined \| void \| [Notification](Notification.mdx)[]&#62;
@@ -282,13 +268,13 @@ Promise&#60;undefined \| void \| [Notification](Notification.mdx)[]&#62;
___
### list
#### list
`**list**(selector, config?): Promise&#60;[Notification](Notification.mdx)[]&#62;`
Retrieves a list of notifications.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -311,7 +297,7 @@ Retrieves a list of notifications.
}
]} />
#### Returns
##### Returns
Promise&#60;[Notification](Notification.mdx)[]&#62;
@@ -329,13 +315,13 @@ Promise&#60;[Notification](Notification.mdx)[]&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector, config?): Promise&#60;[[Notification](Notification.mdx)[], number]&#62;`
Retrieves a list of notifications and total count.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -358,7 +344,7 @@ Retrieves a list of notifications and total count.
}
]} />
#### Returns
##### Returns
Promise&#60;[[Notification](Notification.mdx)[], number]&#62;
@@ -376,14 +362,14 @@ Promise&#60;[[Notification](Notification.mdx)[], number]&#62;
___
### registerAttachmentGenerator
#### registerAttachmentGenerator
`**registerAttachmentGenerator**(service): void`
Registers an attachment generator to the service. The generator can be
used to generate on demand invoices or other documents.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -397,7 +383,7 @@ used to generate on demand invoices or other documents.
}
]} />
#### Returns
##### Returns
`void`
@@ -415,13 +401,13 @@ used to generate on demand invoices or other documents.
___
### registerInstalledProviders
#### registerInstalledProviders
`**registerInstalledProviders**(providerIds): Promise&#60;void&#62;`
Takes a list of notification provider ids and persists them in the database.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -435,7 +421,7 @@ Takes a list of notification provider ids and persists them in the database.
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -453,14 +439,14 @@ Promise&#60;void&#62;
___
### resend
#### resend
`**resend**(id, config?): Promise&#60;[Notification](Notification.mdx)&#62;`
Resends a notification by retrieving a prior notification and calling the
underlying provider's resendNotification method.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -483,7 +469,7 @@ underlying provider's resendNotification method.
}
]} />
#### Returns
##### Returns
Promise&#60;[Notification](Notification.mdx)&#62;
@@ -501,13 +487,13 @@ Promise&#60;[Notification](Notification.mdx)&#62;
___
### retrieve
#### retrieve
`**retrieve**(id, config?): Promise&#60;[Notification](Notification.mdx)&#62;`
Retrieves a notification with a given id
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -530,7 +516,7 @@ Retrieves a notification with a given id
}
]} />
#### Returns
##### Returns
Promise&#60;[Notification](Notification.mdx)&#62;
@@ -548,14 +534,14 @@ Promise&#60;[Notification](Notification.mdx)&#62;
___
### retrieveProvider\_
#### retrieveProvider\_
`Protected **retrieveProvider_**(id): [AbstractNotificationService](AbstractNotificationService.mdx)`
Finds a provider with a given id. Will throw a NOT\_FOUND error if the
resolution fails.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -569,7 +555,7 @@ resolution fails.
}
]} />
#### Returns
##### Returns
[AbstractNotificationService](AbstractNotificationService.mdx)
@@ -587,14 +573,14 @@ resolution fails.
___
### send
#### send
`**send**(event, eventData, providerId): Promise&#60;undefined \| [Notification](Notification.mdx)&#62;`
Sends a notification, by calling the given provider's sendNotification
method. Persists the Notification in the database.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -626,7 +612,7 @@ method. Persists the Notification in the database.
}
]} />
#### Returns
##### Returns
Promise&#60;undefined \| [Notification](Notification.mdx)&#62;
@@ -644,11 +630,11 @@ Promise&#60;undefined \| [Notification](Notification.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -662,7 +648,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -680,13 +666,13 @@ ___
___
### subscribe
#### subscribe
`**subscribe**(eventName, providerId): void`
Subscribes a given provider to an event.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -709,7 +695,7 @@ Subscribes a given provider to an event.
}
]} />
#### Returns
##### Returns
`void`
@@ -727,11 +713,11 @@ Subscribes a given provider to an event.
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [NotificationService](NotificationService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -745,7 +731,7 @@ ___
}
]} />
#### Returns
##### Returns
[NotificationService](NotificationService.mdx)