medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.OauthService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: OauthService

internal.internal.OauthService

Hierarchy

• TransactionBaseService

  ↳ OauthService

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:4

---

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:6

---

container_

• Protected container_: InjectedDependencies

Defined in

packages/medusa/dist/services/oauth.d.ts:19

---

eventBus_

• Protected eventBus_: EventBusService

Defined in

packages/medusa/dist/services/oauth.d.ts:21

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:7

---

oauthRepository_

• Protected oauthRepository_: Repository<Oauth>

Defined in

packages/medusa/dist/services/oauth.d.ts:20

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:8

---

Events

▪ Static Events: Object

Type declaration

Name	Type
TOKEN_GENERATED	string
TOKEN_REFRESHED	string

Defined in

packages/medusa/dist/services/oauth.d.ts:15

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:9

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

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

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>	the transactional work to be done
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>	the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>	Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:24

---

create

▸ create(data): Promise<Oauth>

Parameters

Name	Type
data	CreateOauthInput

Returns

Promise<Oauth>

Defined in

packages/medusa/dist/services/oauth.d.ts:26

---

generateToken

▸ generateToken(appName, code, state): Promise<Oauth>

Parameters

Name	Type
appName	string
code	string
state	string

Returns

Promise<Oauth>

Defined in

packages/medusa/dist/services/oauth.d.ts:29

---

list

▸ list(selector): Promise<Oauth[]>

Parameters

Name	Type
selector	Selector<Oauth>

Returns

Promise<Oauth[]>

Defined in

packages/medusa/dist/services/oauth.d.ts:25

---

refreshToken

▸ refreshToken(appName): Promise<Oauth>

Parameters

Name	Type
appName	string

Returns

Promise<Oauth>

Defined in

packages/medusa/dist/services/oauth.d.ts:30

---

registerOauthApp

▸ registerOauthApp(appDetails): Promise<Oauth>

Parameters

Name	Type
appDetails	CreateOauthInput

Returns

Promise<Oauth>

Defined in

packages/medusa/dist/services/oauth.d.ts:28

---

retrieve

▸ retrieve(oauthId): Promise<Oauth>

Parameters

Name	Type
oauthId	string

Returns

Promise<Oauth>

Defined in

packages/medusa/dist/services/oauth.d.ts:24

---

retrieveByName

▸ retrieveByName(appName): Promise<Oauth>

Parameters

Name	Type
appName	string

Returns

Promise<Oauth>

Defined in

packages/medusa/dist/services/oauth.d.ts:23

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:12

---

update

▸ update(id, update): Promise<Oauth>

Parameters

Name	Type
id	string
update	UpdateOauthInput

Returns

Promise<Oauth>

Defined in

packages/medusa/dist/services/oauth.d.ts:27

---

withTransaction

▸ withTransaction(transactionManager?): OauthService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

OauthService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:11