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

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: AnalyticsConfigService

internal.internal.AnalyticsConfigService

Hierarchy

• TransactionBaseService

  ↳ AnalyticsConfigService

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

---

analyticsConfigRepository_

• Protected Readonly analyticsConfigRepository_: Repository<AnalyticsConfig>

Defined in

packages/medusa/dist/services/analytics-config.d.ts:12

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

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

---

userService_

• Protected Readonly userService_: UserService

Defined in

packages/medusa/dist/services/analytics-config.d.ts:13

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(userId, data): Promise<AnalyticsConfig>

Creates an analytics config.

Parameters

Name	Type
userId	string
data	CreateAnalyticsConfig

Returns

Promise<AnalyticsConfig>

Defined in

packages/medusa/dist/services/analytics-config.d.ts:19

---

delete

▸ delete(userId): Promise<void>

Deletes an analytics config.

Parameters

Name	Type
userId	string

Returns

Promise<void>

Defined in

packages/medusa/dist/services/analytics-config.d.ts:27

---

retrieve

▸ retrieve(userId): Promise<AnalyticsConfig>

Parameters

Name	Type
userId	string

Returns

Promise<AnalyticsConfig>

Defined in

packages/medusa/dist/services/analytics-config.d.ts:15

---

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(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/dist/services/analytics-config.d.ts:23

---

withTransaction

▸ withTransaction(transactionManager?): AnalyticsConfigService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

AnalyticsConfigService

Inherited from

TransactionBaseService.withTransaction

Defined in

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