chore(docs): Generated References (automated) (#9727)

Generated the following references: - `api_key` - `auth` - `cart` - `core_flows` - `currency` - `customer` - `dml` - `fulfillment` - `helper_steps` - `inventory_next` - `js_sdk` - `medusa` - `medusa_config` - `modules` - `modules_sdk` - `notification` - `order` - `order_models` - `payment` - `pricing` - `product` - `promotion` - `region` - `sales_channel` - `stock_location_next` - `store` - `tax` - `tax_provider` - `types` - `user` - `utils` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:41:14 +00:00
1 parent e196ad7659
commit 5deeae060a
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `authenticate` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method is used to authenticate a user using a provider. The `authenticate` method of the
 underlying provider is called, passing it the `providerData` parameter as a parameter. The method
 returns the data returned by the provider.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `createAuthIdentities` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## createAuthIdentities(data, sharedContext?): Promise&#60;[AuthIdentityDTO](../../../interfaces/auth.AuthIdentityDTO/page.mdx)[]&#62;

 This method creates auth identities.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `createProviderIdentities` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## createProviderIdentities(data, sharedContext?): Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62;

 This method creates provider identities.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteAuthIdentities` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method deletes a auth by its ID.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteProviderIdentities` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method deletes a provider identity by its ID.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listAndCountAuthIdentities` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of auth identities along with the total count of available auth identities satisfying the provided filters.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listAuthIdentities` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of auth identities based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listProviderIdentities` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of provider identities based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `register` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## Parameters

 <TypeList types={[{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providerData","type":"[AuthenticationInput](../../../interfaces/auth.AuthenticationInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"url","type":"`string`","description":"URL of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"`Record<string, string>`","description":"Headers of incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`Record<string, string>`","description":"Query params of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"`Record<string, string>`","description":"Body of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"protocol","type":"`string`","description":"Protocol of the incoming authentication request (For example, `https`).","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="register"/>
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `retrieveAuthIdentity` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves an auth identity by its ID.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `retrieveProviderIdentity` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a provider identity by its ID.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updateAuthIdentities` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updateAuthIdentities(data, sharedContext?): Promise&#60;[AuthIdentityDTO](../../../interfaces/auth.AuthIdentityDTO/page.mdx)[]&#62;

 This method updates existing auths.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updateProvider` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## Parameters

 <TypeList types={[{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providerData","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProvider"/>
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updateProviderIdentities` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updateProviderIdentities(data, sharedContext?): Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62;

 This method updates existing provider identities.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `validateCallback` method. This belongs to the Auth Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 When authenticating users with a third-party provider, such as Google, the user performs an
 action to finish the authentication, such as enter their credentials in Google's sign-in
 form.
@@ -9,6 +9,12 @@ import { TypeList } from "docs-ui"

 This section of the documentation provides a reference to the `IAuthModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Auth Module.

+<Note>
+
+You should only use the methods in this reference when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 The main service interface for the Auth Module.

 ## Methods
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"

 **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":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Event"/>
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"

 **JoinerRelationship**: `Object`

-## Properties
-
 <TypeList types={[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="JoinerRelationship"/>
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"

 **RawMessageFormat**: `Object`

-## Properties
-
 <TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"source","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Pick&#60;[Context](../../interfaces/auth.Context/page.mdx), \"eventGroupId\"&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RawMessageFormat"/>