3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
2.3 KiB
2.3 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
packages/medusa-js/src/resources/auth.ts:16
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
packages/medusa-js/src/resources/auth.ts:38
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> |