chore(docs): Generated References (automated) (#9772)
Generated the following references: - `auth_provider` - `core_flows` - `js_sdk` - `medusa_config` - `modules` - `payment_provider` - `tax` - `tax_provider` - `types` - `workflows` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
1 parent
59e6747800
commit
d40499ca6a
613 files changed
+56943
-55109
No files matched your search
+1
-1
@@ -10,7 +10,7 @@ import { TypeList } from "docs-ui"
|
||||
This documentation provides a reference to the `sdk.auth.callback` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types.
|
||||
|
||||
This method is used to validate an Oauth callback from a third-party service, such as Google, for an admin user, customer, or custom actor types.
|
||||
It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/v2/api/admin#auth\_postactor\_typeauth\_providercallback).
|
||||
It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/api/admin#auth\_postactor\_typeauth\_providercallback).
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
+2
-2
@@ -10,10 +10,10 @@ import { TypeList } from "docs-ui"
|
||||
This documentation provides a reference to the `sdk.auth.login` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types.
|
||||
|
||||
This method retrieves the JWT authenticated token for an admin user, customer, or custom
|
||||
actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/v2/api/admin#auth\_postactor\_typeauth\_provider).
|
||||
actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/api/admin#auth\_postactor\_typeauth\_provider).
|
||||
|
||||
If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
|
||||
[Set Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth\_postsession).
|
||||
[Set Authentication Session API route](https://docs.medusajs.com/api/admin#auth\_postsession).
|
||||
|
||||
Subsequent requests using the SDK will automatically have the necessary authentication headers / session
|
||||
set.
|
||||
|
||||
+2
-2
@@ -10,7 +10,7 @@ import { TypeList } from "docs-ui"
|
||||
This documentation provides a reference to the `sdk.auth.logout` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types.
|
||||
|
||||
This method deletes the authentication session of the currently logged-in user to log them out.
|
||||
It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth\_deletesession).
|
||||
It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/api/admin#auth\_deletesession).
|
||||
|
||||
## Example
|
||||
|
||||
@@ -23,4 +23,4 @@ sdk.auth.logout()
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"This method deletes the authentication session of the currently logged-in user to log them out.\nIt sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth\\_deletesession).","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="logout"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"This method deletes the authentication session of the currently logged-in user to log them out.\nIt sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/api/admin#auth\\_deletesession).","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="logout"/>
|
||||
+1
-1
@@ -10,7 +10,7 @@ import { TypeList } from "docs-ui"
|
||||
This documentation provides a reference to the `sdk.auth.refresh` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types.
|
||||
|
||||
This method refreshes a JWT authentication token, which is useful after validating the Oauth callback
|
||||
with [callback](../js_sdk.auth.Auth.callback/page.mdx). It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/v2/api/admin#auth\_postadminauthtokenrefresh).
|
||||
with [callback](../js_sdk.auth.Auth.callback/page.mdx). It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/api/admin#auth\_postadminauthtokenrefresh).
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
+1
-1
@@ -10,7 +10,7 @@ import { TypeList } from "docs-ui"
|
||||
This documentation provides a reference to the `sdk.auth.register` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types.
|
||||
|
||||
This method is used to retrieve a registration JWT token for a user, customer, or custom actor type. It sends a request to the
|
||||
[Retrieve Registration Token API route](https://docs.medusajs.com/v2/api/store#auth\_postactor\_typeauth\_provider\_register).
|
||||
[Retrieve Registration Token API route](https://docs.medusajs.com/api/store#auth\_postactor\_typeauth\_provider\_register).
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
+3
-3
@@ -10,11 +10,11 @@ import { TypeList } from "docs-ui"
|
||||
This documentation provides a reference to the `sdk.auth.resetPassword` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types.
|
||||
|
||||
This method requests a reset password token for an admin user, customer, or custom actor type.
|
||||
It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/v2/api/admin#auth\_postactor\_typeauth\_providerresetpassword).
|
||||
It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth\_postactor\_typeauth\_providerresetpassword).
|
||||
|
||||
To reset the password later using the token delivered to the user, use the [updateProvider](../js_sdk.auth.Auth.updateProvider/page.mdx) method.
|
||||
|
||||
Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).
|
||||
Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).
|
||||
|
||||
## Example
|
||||
|
||||
@@ -37,4 +37,4 @@ sdk.auth.resetPassword(
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"This method requests a reset password token for an admin user, customer, or custom actor type.\nIt sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/v2/api/admin#auth\\_postactor\\_typeauth\\_providerresetpassword).\n\nTo reset the password later using the token delivered to the user, use the [updateProvider](../js_sdk.auth.Auth.updateProvider/page.mdx) method.\n\nRelated guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="resetPassword"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"This method requests a reset password token for an admin user, customer, or custom actor type.\nIt sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth\\_postactor\\_typeauth\\_providerresetpassword).\n\nTo reset the password later using the token delivered to the user, use the [updateProvider](../js_sdk.auth.Auth.updateProvider/page.mdx) method.\n\nRelated guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="resetPassword"/>
|
||||
+3
-3
@@ -14,9 +14,9 @@ This method is used to update user-related data authentication data.
|
||||
More specifically, use this method when updating the password of an admin user, customer, or
|
||||
custom actor type after requesting to reset their password with [resetPassword](../js_sdk.auth.Auth.resetPassword/page.mdx).
|
||||
|
||||
This method sends a request to [this API route](https://docs.medusajs.com/v2/api/admin#auth\_postactor\_typeauth\_providerupdate).
|
||||
This method sends a request to [this API route](https://docs.medusajs.com/api/admin#auth\_postactor\_typeauth\_providerupdate).
|
||||
|
||||
Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).
|
||||
Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).
|
||||
|
||||
## Example
|
||||
|
||||
@@ -40,4 +40,4 @@ sdk.auth.updateProvider(
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"This method is used to update user-related data authentication data.\n\nMore specifically, use this method when updating the password of an admin user, customer, or \ncustom actor type after requesting to reset their password with [resetPassword](../js_sdk.auth.Auth.resetPassword/page.mdx).\n\nThis method sends a request to [this API route](https://docs.medusajs.com/v2/api/admin#auth\\_postactor\\_typeauth\\_providerupdate).\n\nRelated guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProvider"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"This method is used to update user-related data authentication data.\n\nMore specifically, use this method when updating the password of an admin user, customer, or \ncustom actor type after requesting to reset their password with [resetPassword](../js_sdk.auth.Auth.resetPassword/page.mdx).\n\nThis method sends a request to [this API route](https://docs.medusajs.com/api/admin#auth\\_postactor\\_typeauth\\_providerupdate).\n\nRelated guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProvider"/>
|
||||
Reference in new issue
Block a user