chore(docs): Generated References (#9153)

Generated the following references:
- `api_key`
- `auth`
- `auth_provider`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `customer_models`
- `dml`
- `file`
- `fulfillment`
- `fulfillment_provider`
- `inventory_next`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`
This commit is contained in:
github-actions[bot] authored and GitHub committed 2024-09-17 07:17:55 +00:00
1 parent 653a4bff71
commit 175ca30f4f
1147 files changed
+520826 -473805

No files matched your search

@@ -80,6 +80,18 @@ export default MyNotificationProviderService
### constructor
### validateOptions
Override this static method in order for the loader to validate the options provided to the module provider.
#### Parameters
<TypeList types={[{"name":"options","type":"`Record<any, any>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/>
#### Returns
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Override this static method in order for the loader to validate the options provided to the module provider.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/>
### send
This method is used to send a notification using the third-party provider or your custom logic.
@@ -87,6 +99,12 @@ This method is used to send a notification using the third-party provider or you
#### Example
```ts
// other imports...
import {
ProviderSendNotificationDTO,
ProviderSendNotificationResultsDTO
} from "@medusajs/types"
class MyNotificationProviderService extends AbstractNotificationProviderService {
// ...
async send(
@@ -141,7 +159,7 @@ The Notification Module accepts one provider per channel.
</Note>
```js title="medusa-config.js"
import { Modules } from "@medusajs/utils"
const { Modules } = require("@medusajs/utils")
// ...