chore(js-sdk): add tags to js-sdk (#10739)

This commit is contained in:
Shahed Nasser
2024-12-26 11:18:02 +02:00
committed by GitHub
parent ebca8fed28
commit 688e1e60a5
3 changed files with 163 additions and 0 deletions
+14
View File
@@ -20,6 +20,8 @@ export class Auth {
* @param payload - The data to pass in the request's body for authentication. When using the `emailpass` provider,
* you pass the email and password.
* @returns The JWT token used for registration later.
*
* @tags auth
*
* @example
* sdk.auth.register(
@@ -66,6 +68,8 @@ export class Auth {
* @param payload - The data to pass in the request's body for authentication. When using the `emailpass` provider,
* you pass the email and password.
* @returns The authentication JWT token
*
* @tags auth
*
* @example
* sdk.auth.login(
@@ -111,6 +115,8 @@ export class Auth {
* @param method - The authentication provider to use. For example, `google`.
* @param query - The query parameters from the Oauth callback, which should be passed to the API route.
* @returns The authentication JWT token
*
* @tags auth
*
* @example
* sdk.auth.callback(
@@ -150,6 +156,8 @@ export class Auth {
* with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/api/admin#auth_postadminauthtokenrefresh).
*
* @returns The refreshed JWT authentication token.
*
* @tags auth
*
* @example
* sdk.auth.refresh()
@@ -174,6 +182,8 @@ export class Auth {
/**
* 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/api/admin#auth_deletesession).
*
* @tags auth
*
* @example
* sdk.auth.logout()
@@ -202,6 +212,8 @@ export class Auth {
* @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
* @param provider - The authentication provider to use. For example, `emailpass`.
* @param body - The data required to identify the user.
*
* @tags auth
*
* @example
* sdk.auth.resetPassword(
@@ -247,6 +259,8 @@ export class Auth {
* @param provider - The authentication provider to use. For example, `emailpass`.
* @param body - The data necessary to update the user's authentication data. When resetting the user's password,
* send the `password` property.
*
* @tags auth
*
* @example
* sdk.auth.updateProvider(