fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2.7 KiB
2.7 KiB
Class: AuthResource
Hierarchy
-
default↳
AuthResource
Methods
authenticate
▸ authenticate(payload, customHeaders?): ResponsePromise<StoreAuthRes>
Description
Authenticates a customer using email and password combination
Parameters
| Name | Type | Description |
|---|---|---|
payload |
StorePostAuthReq |
authentication payload |
customHeaders |
Record<string, any> |
Returns
Defined in
medusa-js/src/resources/auth.ts:16
deleteSession
▸ deleteSession(customHeaders?): ResponsePromise<void>
Description
Removes authentication session
Parameters
| Name | Type |
|---|---|
customHeaders |
Record<string, any> |
Returns
ResponsePromise<void>
Defined in
medusa-js/src/resources/auth.ts:25
exists
▸ exists(email, customHeaders?): ResponsePromise<StoreGetAuthEmailRes>
Description
Check if email exists
Parameters
| Name | Type | Description |
|---|---|---|
email |
string |
is required |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<StoreGetAuthEmailRes>
Defined in
medusa-js/src/resources/auth.ts:47
getSession
▸ getSession(customHeaders?): ResponsePromise<StoreAuthRes>
Description
Retrieves an authenticated session Usually used to check if authenticated session is alive.
Parameters
| Name | Type |
|---|---|
customHeaders |
Record<string, any> |