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

chore(docs): Generated References (#5516)

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

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-02 09:16:47 +00:00
committed by GitHub
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions
Download Patch File Download Diff File Expand all files Collapse all files

210
www/apps/docs/content/references/services/classes/NotificationService.md
View File

@@ -1,4 +1,4 @@
# Class: NotificationService
# NotificationService
## Hierarchy
@@ -10,12 +10,12 @@
### constructor
• **new NotificationService**(`container`)
**new NotificationService**(`container`)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `container` | `InjectedDependencies` |
#### Overrides
@@ -24,13 +24,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L34)
[medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L34)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -38,13 +38,13 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
`Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
@@ -52,13 +52,13 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -66,43 +66,43 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### attachmentGenerator\_
• `Protected` **attachmentGenerator\_**: `unknown` = `null`
`Protected` **attachmentGenerator\_**: `unknown` = `null`
#### Defined in
[medusa/src/services/notification.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L25)
[medusa/src/services/notification.ts:25](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L25)
___
### container\_
• `Protected` `Readonly` **container\_**: `InjectedDependencies` & {}
`Protected` `Readonly` **container\_**: `InjectedDependencies` & {}
#### Defined in
[medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L26)
[medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L26)
___
### logger\_
• `Protected` `Readonly` **logger\_**: `Logger`
`Protected` `Readonly` **logger\_**: `Logger`
#### Defined in
[medusa/src/services/notification.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L29)
[medusa/src/services/notification.ts:29](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L29)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -110,43 +110,43 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
### notificationProviderRepository\_
• `Protected` `Readonly` **notificationProviderRepository\_**: `Repository`<`NotificationProvider`\>
`Protected` `Readonly` **notificationProviderRepository\_**: `Repository`<`NotificationProvider`\>
#### Defined in
[medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L32)
[medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L32)
___
### notificationRepository\_
• `Protected` `Readonly` **notificationRepository\_**: `Repository`<`Notification`\>
`Protected` `Readonly` **notificationRepository\_**: `Repository`<`Notification`\>
#### Defined in
[medusa/src/services/notification.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L30)
[medusa/src/services/notification.ts:30](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L30)
___
### subscribers\_
• `Protected` **subscribers\_**: `Object` = `{}`
`Protected` **subscribers\_**: `object` = `{}`
#### Defined in
[medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L24)
[medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L24)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
@@ -154,47 +154,47 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
-`EntityManager`:
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
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
| Name |
| :------ |
| `TResult` |
| `TError` |
| `TResult` | `object` |
| `TError` | `object` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
@@ -203,7 +203,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -211,13 +211,13 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
### handleEvent
▸ **handleEvent**(`eventName`, `data`): `Promise`<`undefined` \| `void` \| `Notification`[]\>
**handleEvent**(`eventName`, `data`): `Promise`<`undefined` \| `void` \| `Notification`[]\>
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
@@ -225,33 +225,34 @@ order to allow for resends. Will log any errors that are encountered.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `eventName` | `string` | the event to handle |
| `data` | `Record`<`string`, `unknown`\> | the data the event was sent with |
| `data` | Record<`string`, `unknown`\> | the data the event was sent with |
#### Returns
`Promise`<`undefined` \| `void` \| `Notification`[]\>
the result of notification subscribed
-`Promise`: the result of notification subscribed
-`undefined \| void \| Notification[]`: (optional)
#### Defined in
[medusa/src/services/notification.ts:185](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L185)
[medusa/src/services/notification.ts:185](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L185)
___
### list
▸ **list**(`selector`, `config?`): `Promise`<`Notification`[]\>
**list**(`selector`, `config?`): `Promise`<`Notification`[]\>
Retrieves a list of notifications.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `selector` | `Selector`<`Notification`\> | the params to select the notifications by. |
| `config` | `FindConfig`<`Notification`\> | the configuration to apply to the query |
@@ -259,24 +260,26 @@ Retrieves a list of notifications.
`Promise`<`Notification`[]\>
the notifications that satisfy the query.
-`Promise`: the notifications that satisfy the query.
-`Notification[]`:
-`Notification`:
#### Defined in
[medusa/src/services/notification.ts:78](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L78)
[medusa/src/services/notification.ts:78](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L78)
___
### listAndCount
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`Notification`[], `number`]\>
**listAndCount**(`selector`, `config?`): `Promise`<[`Notification`[], `number`]\>
Retrieves a list of notifications and total count.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `selector` | `Selector`<`Notification`\> | the params to select the notifications by. |
| `config` | `FindConfig`<`Notification`\> | the configuration to apply to the query |
@@ -284,70 +287,76 @@ Retrieves a list of notifications and total count.
`Promise`<[`Notification`[], `number`]\>
the notifications that satisfy the query as well as the count.
-`Promise`: the notifications that satisfy the query as well as the count.
-`Notification[]`:
-`number`: (optional)
#### Defined in
[medusa/src/services/notification.ts:97](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L97)
[medusa/src/services/notification.ts:97](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L97)
___
### registerAttachmentGenerator
▸ **registerAttachmentGenerator**(`service`): `void`
**registerAttachmentGenerator**(`service`): `void`
Registers an attachment generator to the service. The generator can be
used to generate on demand invoices or other documents.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `service` | `unknown` | the service to assign to the attachmentGenerator |
#### Returns
`void`
-`void`: (optional)
#### Defined in
[medusa/src/services/notification.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L52)
[medusa/src/services/notification.ts:52](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L52)
___
### registerInstalledProviders
▸ **registerInstalledProviders**(`providerIds`): `Promise`<`void`\>
**registerInstalledProviders**(`providerIds`): `Promise`<`void`\>
Takes a list of notification provider ids and persists them in the database.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `providerIds` | `string`[] | a list of provider ids |
#### Returns
`Promise`<`void`\>
-`Promise`:
#### Defined in
[medusa/src/services/notification.ts:60](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L60)
[medusa/src/services/notification.ts:60](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L60)
___
### resend
▸ **resend**(`id`, `config?`): `Promise`<`Notification`\>
**resend**(`id`, `config?`): `Promise`<`Notification`\>
Resends a notification by retrieving a prior notification and calling the
underlying provider's resendNotification method.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `id` | `string` | the id of the notification |
| `config` | `FindConfig`<`Notification`\> | any configuration that might override the previous send |
@@ -355,24 +364,25 @@ underlying provider's resendNotification method.
`Promise`<`Notification`\>
the newly created notification
-`Promise`: the newly created notification
-`Notification`:
#### Defined in
[medusa/src/services/notification.ts:265](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L265)
[medusa/src/services/notification.ts:265](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L265)
___
### retrieve
▸ **retrieve**(`id`, `config?`): `Promise`<`Notification`\>
**retrieve**(`id`, `config?`): `Promise`<`Notification`\>
Retrieves a notification with a given id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `id` | `string` | the id of the notification |
| `config` | `FindConfig`<`Notification`\> | the configuration to apply to the query |
@@ -380,100 +390,104 @@ Retrieves a notification with a given id
`Promise`<`Notification`\>
the notification
-`Promise`: the notification
-`Notification`:
#### Defined in
[medusa/src/services/notification.ts:118](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L118)
[medusa/src/services/notification.ts:118](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L118)
___
### retrieveProvider\_
▸ `Protected` **retrieveProvider_**(`id`): `AbstractNotificationService`
`Protected` **retrieveProvider_**(`id`): `AbstractNotificationService`
Finds a provider with a given id. Will throw a NOT_FOUND error if the
resolution fails.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `id` | `string` | the id of the provider |
#### Returns
`AbstractNotificationService`
the notification provider
-`AbstractNotificationService`: the notification provider
#### Defined in
[medusa/src/services/notification.ts:166](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L166)
[medusa/src/services/notification.ts:166](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L166)
___
### send
▸ **send**(`event`, `eventData`, `providerId`): `Promise`<`undefined` \| `Notification`\>
**send**(`event`, `eventData`, `providerId`): `Promise`<`undefined` \| `Notification`\>
Sends a notification, by calling the given provider's sendNotification
method. Persists the Notification in the database.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `event` | `string` | the name of the event |
| `eventData` | `Record`<`string`, `unknown`\> | the data the event was sent with |
| `eventData` | Record<`string`, `unknown`\> | the data the event was sent with |
| `providerId` | `string` | the provider that should handle the event. |
#### Returns
`Promise`<`undefined` \| `Notification`\>
the created notification
-`Promise`: the created notification
-`undefined \| Notification`: (optional)
#### Defined in
[medusa/src/services/notification.ts:217](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L217)
[medusa/src/services/notification.ts:217](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L217)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
| Name |
| :------ |
| `err` | Record<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
-`boolean`: (optional)
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### subscribe
▸ **subscribe**(`eventName`, `providerId`): `void`
**subscribe**(`eventName`, `providerId`): `void`
Subscribes a given provider to an event.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `eventName` | `string` | the event to subscribe to |
| `providerId` | `string` | the provider that the event will be sent to |
@@ -481,30 +495,34 @@ Subscribes a given provider to an event.
`void`
-`void`: (optional)
#### Defined in
[medusa/src/services/notification.ts:145](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/notification.ts#L145)
[medusa/src/services/notification.ts:145](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/notification.ts#L145)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`NotificationService`](NotificationService.md)
**withTransaction**(`transactionManager?`): [`NotificationService`](NotificationService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`NotificationService`](NotificationService.md)
-`NotificationService`:
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L20)