asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5602)

Browse Source 
Generated the following references:
- `pricing`
- `product`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-10 17:31:02 +00:00
committed by GitHub
parent 5f4317b9d7
commit 39649b3552
2110 changed files with 148777 additions and 4448445 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/classes/AdminAuthResource.mdx
+6 -6
View File
@@ -83,7 +83,7 @@ medusa.admin.AdminAuthResource.createSession({
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../modules/internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/internal.mdx#adminauthres)\\>",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminAuthRes`](../internal/types/internal.AdminAuthRes.mdx)\\>",
"optional": false,
"defaultValue": "",
"description": "Resolves to the user's details.",
@@ -99,7 +99,7 @@ medusa.admin.AdminAuthResource.createSession({
"children": [
{
"name": "user",
"type": "[`Omit`](../modules/internal.mdx#omit)<[`User`](../internal/classes/internal.User.mdx), ``\"password_hash\"``\\>",
"type": "[`Omit`](../internal/types/internal.Omit.mdx)<[`User`](../internal/classes/internal.User.mdx), ``\"password_hash\"``\\>",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ medusa.admin.auth.deleteSession()
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../modules/internal.mdx#responsepromise)<`void`\\>",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<`void`\\>",
"optional": false,
"defaultValue": "",
"description": "Resolves when user is logged out successfully.",
@@ -283,7 +283,7 @@ medusa.admin.auth.getSession().then(({ user }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../modules/internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/internal.mdx#adminauthres)\\>",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminAuthRes`](../internal/types/internal.AdminAuthRes.mdx)\\>",
"optional": false,
"defaultValue": "",
"description": "Resolves to the logged-in user's details.",
@@ -299,7 +299,7 @@ medusa.admin.auth.getSession().then(({ user }) => {
"children": [
{
"name": "user",
"type": "[`Omit`](../modules/internal.mdx#omit)<[`User`](../internal/classes/internal.User.mdx), ``\"password_hash\"``\\>",
"type": "[`Omit`](../internal/types/internal.Omit.mdx)<[`User`](../internal/classes/internal.User.mdx), ``\"password_hash\"``\\>",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -471,7 +471,7 @@ medusa.admin.auth
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../modules/internal.mdx#responsepromise)<[`AdminBearerAuthRes`](../modules/internal.mdx#adminbearerauthres)\\>",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminBearerAuthRes`](../internal/types/internal.AdminBearerAuthRes.mdx)\\>",
"optional": false,
"defaultValue": "",
"description": "Resolves to the access token of the user, if they're authenticated successfully.",