daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
3.8 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AuthResource
Hierarchy
-
default↳
AuthResource
Methods
authenticate
▸ authenticate(payload, customHeaders?): ResponsePromise<StoreAuthRes>
Parameters
| Name | Type | Description |
|---|---|---|
payload |
StorePostAuthReq |
authentication payload |
customHeaders |
Record<string, any> |
Returns
Description
Authenticates a customer using email and password combination
Defined in
packages/medusa-js/src/resources/auth.ts:18
deleteSession
▸ deleteSession(customHeaders?): ResponsePromise<void>
Parameters
| Name | Type |
|---|---|
customHeaders |
Record<string, any> |
Returns
ResponsePromise<void>
Description
Removes authentication session
Defined in
packages/medusa-js/src/resources/auth.ts:27
exists
▸ exists(email, customHeaders?): ResponsePromise<StoreGetAuthEmailRes>
Parameters
| Name | Type | Description |
|---|---|---|
email |
string |
is required |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<StoreGetAuthEmailRes>
Description
Check if email exists
Defined in
packages/medusa-js/src/resources/auth.ts:49
getSession
▸ getSession(customHeaders?): ResponsePromise<StoreAuthRes>
Parameters
| Name | Type |
|---|---|
customHeaders |
Record<string, any> |
Returns
Description
Retrieves an authenticated session Usually used to check if authenticated session is alive.
Defined in
packages/medusa-js/src/resources/auth.ts:38
getToken
▸ getToken(payload, customHeaders?): ResponsePromise<StoreBearerAuthRes>
Parameters
| Name | Type |
|---|---|
payload |
StorePostAuthReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<StoreBearerAuthRes>
Description
Retrieves a new JWT access token