Class BaseBrandAssignmentsService<BA, U, R, B>

Service that provides methods to work with brand assignments Brand assignments are used to assign roles to users for specific brands

Type Parameters

BA extends BaseBrandAssignment
U extends BaseUser
R extends BaseRole
B extends BaseBrand

Index

Constructors

constructor

new BaseBrandAssignmentsService<
 BA extends BaseBrandAssignment,
 U extends BaseUser,
 R extends BaseRole,
 B extends BaseBrand,
>(
 brandAssignmentRepository: Repository<BA>,
 userRepository: Repository,
 roleRepository: Repository<R>,
 brandRepository: Repository,
): BaseBrandAssignmentsService<BA, U, R, B>
Type Parameters
- BA extends BaseBrandAssignment
- U extends BaseUser
- R extends BaseRole
- B extends BaseBrand
Parameters
- brandAssignmentRepository: Repository<BA>
- userRepository: Repository
- roleRepository: Repository<R>
- brandRepository: Repository
Returns BaseBrandAssignmentsService<BA, U, R, B>
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:79

Properties

`Protected` `Readonly`actionsService

actionsService: BaseActionsService

`Protected` `Readonly`appConfig

appConfig: AppConfigType

`Protected` `Readonly`brandAssignmentRepository

brandAssignmentRepository: Repository<BA>

`Protected` `Readonly`brandRepository

brandRepository: Repository

`Protected` `Readonly`idService

idService: IdService

`Protected`logger

logger: WinstonLogger

`Protected` `Readonly`loggerFactory

loggerFactory: WinstonLoggerFactory

`Protected` `Readonly`roleRepository

roleRepository: Repository<R>

`Protected` `Readonly`userRepository

userRepository: Repository

Methods

clean

clean(
input: CleanBrandsAssignemntsOptions,
ctx: BaseServiceMethodContext,
): Promise<boolean>
Remove brand assignments for user in organization
Parameters
- input: CleanBrandsAssignemntsOptions
- ctx: BaseServiceMethodContext
Returns Promise<boolean>
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:426

create

create(
__namedParameters: CreateBrandAssignmentOptions,
ctx: BaseServiceMethodContext,
): Promise<BA>
Create brand assignment
Parameters
- __namedParameters: CreateBrandAssignmentOptions
- ctx: BaseServiceMethodContext
Returns Promise<BA>
- created brand assignment
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:135

delete

delete(id: string, ctx: BaseServiceMethodContext): Promise<void>
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise<void>
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:465

`Protected`generateEntityId

generateEntityId(): string
Returns string
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:127

getCount

getCount(
filter: BrandAssignmentsFilter,
ctx: BaseServiceMethodContext,
): Promise<number>
Get brand assignments count
Parameters
- filter: BrandAssignmentsFilter
- ctx: BaseServiceMethodContext
Returns Promise<number>
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:370

getMany

getMany(
__namedParameters: FetchBrandAssignmentsOptions,
ctx: BaseServiceMethodContext,
): Promise<[BA[], ListMeta]>
Fetch brand assignments list
Parameters
- __namedParameters: FetchBrandAssignmentsOptions
- ctx: BaseServiceMethodContext
Returns Promise<[BA[], ListMeta]>
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:337

getOne

getOne(id: string): Promise<MaybeNull<BA>>
Fetch brand assignment by id
Parameters
- id: string
 ID of the brand assignment
Returns Promise<MaybeNull<BA>>
- brand assignment if exists or null
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:97

getOneOrFail

getOneOrFail(id: string, ctx: BaseServiceMethodContext): Promise<BA>
Fetch brand assignment by id or throw an exception if not found
Parameters
- id: string
 ID of the brand assignment
- ctx: BaseServiceMethodContext
 service method context
Returns Promise<BA>
- brand assignment if exists or throws an exception
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:109

`Protected`isSilent

isSilent(ctx: BaseServiceMethodContext): boolean
Parameters
- ctx: BaseServiceMethodContext
Returns boolean
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:506

onModuleInit

onModuleInit(): void
Returns void
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:86

sync

sync(
options: SyncBrandAssignmentOptions,
ctx: BaseServiceMethodContext,
): Promise<BA>
Sync brand assignment from remote service
Parameters
- options: SyncBrandAssignmentOptions
 options for sync
- ctx: BaseServiceMethodContext
 service method context
Returns Promise<BA>
- synced brand assignment
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:245

update

update(
opts: UpdateBrandAssignmentOptions,
ctx: BaseServiceMethodContext,
): Promise<BA>
Update brand assignment
Parameters
- opts: UpdateBrandAssignmentOptions
 options for update
- ctx: BaseServiceMethodContext
 service method context
Returns Promise<BA>
- updated brand assignment
- Defined in src/modules/brand-assignments/brand-assignments.service.ts:285

Class BaseBrandAssignmentsService<BA, U, R, B>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseBrandAssignmentsService<BA, U, R, B>

Properties

Protected ReadonlyactionsService

Protected ReadonlyappConfig

Protected ReadonlybrandAssignmentRepository

Protected ReadonlybrandRepository

Protected ReadonlyidService

Protectedlogger

Protected ReadonlyloggerFactory

Protected ReadonlyroleRepository

Protected ReadonlyuserRepository

Methods

clean

Parameters

Returns Promise<boolean>

create

Parameters

Returns Promise<BA>

delete

Parameters

Returns Promise<void>

ProtectedgenerateEntityId

Returns string

getCount

Parameters

Returns Promise<number>

getMany

Parameters

Returns Promise<[BA[], ListMeta]>

getOne

Parameters

Returns Promise<MaybeNull<BA>>

getOneOrFail

Parameters

Returns Promise<BA>

ProtectedisSilent

Parameters

Returns boolean

onModuleInit

Returns void

sync

Parameters

Returns Promise<BA>

update

Parameters

Returns Promise<BA>

Settings

On This Page

`Protected` `Readonly`actionsService

`Protected` `Readonly`appConfig

`Protected` `Readonly`brandAssignmentRepository

`Protected` `Readonly`brandRepository

`Protected` `Readonly`idService

`Protected`logger

`Protected` `Readonly`loggerFactory

`Protected` `Readonly`roleRepository

`Protected` `Readonly`userRepository

`Protected`generateEntityId

`Protected`isSilent