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

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

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-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
www/apps/docs/content/references/services/classes/OauthService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new OauthService**(cradle)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -132,29 +132,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -162,6 +146,8 @@ Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -183,7 +169,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -215,7 +201,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -233,11 +219,11 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(data): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -251,7 +237,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Oauth](Oauth.mdx)&#62;
@@ -269,11 +255,11 @@ Promise&#60;[Oauth](Oauth.mdx)&#62;
___
### generateToken
#### generateToken
`**generateToken**(appName, code, state): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -305,7 +291,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Oauth](Oauth.mdx)&#62;
@@ -323,11 +309,11 @@ Promise&#60;[Oauth](Oauth.mdx)&#62;
___
### list
#### list
`**list**(selector): Promise&#60;[Oauth](Oauth.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -341,7 +327,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Oauth](Oauth.mdx)[]&#62;
@@ -359,11 +345,11 @@ Promise&#60;[Oauth](Oauth.mdx)[]&#62;
___
### refreshToken
#### refreshToken
`**refreshToken**(appName): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -377,7 +363,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Oauth](Oauth.mdx)&#62;
@@ -395,11 +381,11 @@ Promise&#60;[Oauth](Oauth.mdx)&#62;
___
### registerOauthApp
#### registerOauthApp
`**registerOauthApp**(appDetails): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -413,7 +399,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Oauth](Oauth.mdx)&#62;
@@ -431,11 +417,11 @@ Promise&#60;[Oauth](Oauth.mdx)&#62;
___
### retrieve
#### retrieve
`**retrieve**(oauthId): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -449,7 +435,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Oauth](Oauth.mdx)&#62;
@@ -467,11 +453,11 @@ Promise&#60;[Oauth](Oauth.mdx)&#62;
___
### retrieveByName
#### retrieveByName
`**retrieveByName**(appName): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -485,7 +471,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Oauth](Oauth.mdx)&#62;
@@ -503,11 +489,11 @@ Promise&#60;[Oauth](Oauth.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -521,7 +507,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -539,11 +525,11 @@ ___
___
### update
#### update
`**update**(id, update): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -566,7 +552,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Oauth](Oauth.mdx)&#62;
@@ -584,11 +570,11 @@ Promise&#60;[Oauth](Oauth.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [OauthService](OauthService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -602,7 +588,7 @@ ___
}
]} />
#### Returns
##### Returns
[OauthService](OauthService.mdx)