medusa-store/docs/content/references/services/classes/AnalyticsConfigService.md

Class: AnalyticsConfigService

Hierarchy

• TransactionBaseService

  ↳ AnalyticsConfigService

Constructors

constructor

• new AnalyticsConfigService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/analytics-config.ts:24

Properties

__configModule__

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

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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

---

__moduleDeclaration__

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

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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

---

analyticsConfigRepository_

• Protected Readonly analyticsConfigRepository_: typeof AnalyticsConfigRepository

Defined in

packages/medusa/src/services/analytics-config.ts:21

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/analytics-config.ts:18

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/analytics-config.ts:19

---

userService_

• Protected Readonly userService_: UserService

Defined in

packages/medusa/src/services/analytics-config.ts:22

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/src/interfaces/transaction-base-service.ts:50

---

create

▸ create(userId, data): Promise<AnalyticsConfig>

Creates an analytics config.

Parameters

Name	Type
userId	string
data	CreateAnalyticsConfig

Returns

Promise<AnalyticsConfig>

Defined in

packages/medusa/src/services/analytics-config.ts:56

---

delete

▸ delete(userId): Promise<void>

Deletes an analytics config.

Parameters

Name	Type
userId	string

Returns

Promise<void>

Defined in

packages/medusa/src/services/analytics-config.ts:103

---

retrieve

▸ retrieve(userId): Promise<AnalyticsConfig>

Parameters

Name	Type
userId	string

Returns

Promise<AnalyticsConfig>

Defined in

packages/medusa/src/services/analytics-config.ts:32

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31

---

update

▸ update(userId, update): Promise<AnalyticsConfig>

Updates an analytics config. If the config does not exist, it will be created instead.

Parameters

Name	Type
userId	string
update	UpdateAnalyticsConfig

Returns

Promise<AnalyticsConfig>

Defined in

packages/medusa/src/services/analytics-config.ts:72

---

withTransaction

▸ withTransaction(transactionManager?): AnalyticsConfigService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

AnalyticsConfigService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:14