@deep/nest-kit
    Preparing search index...

    Brand entity helps to create, store, and update information about the media products associated with the organizations. This information can include the name of the brand, its logo, a description, settings, and other useful information that can help in organizing and managing brands.

    Hierarchy

    • BaseEntity
      • BaseBrand
    Index

    Constructors

    Properties

    accessLevels: string[]

    Default access levels that will be used when sharing the brand with organizations or organization groups

    categoryId?: string

    Category identifier related to current brand

    code: string

    Unique brand code

    'HSS'
    
    cover: Promise<MaybeNull<BaseImage>>

    Brand cover. It's a background image for the brand page

    coverId?: MaybeNull<string>

    Brand cover id.

    createdAt: Date

    Brand creation date

    createdBy: Promise<MaybeNull<BaseUser>>

    User who created the brand

    createdById?: MaybeNull<string>

    Keep id of the user who created the brand

    deletedAt?: Date

    Date when the brand was soft-deleted

    distributionPermissions: DistributionPermission[]

    Distribution permissions for sharing the brand to other organizations

    episodeStages: string[]

    Default episode stages that will be used when sharing the brand with organizations or organization groups

    geoRestrictions?: MaybeNull<string[]>

    Array of countries where the brand is not available

    id: string

    Brand ID

    'hcb:gj39hkbngh34'
    
    isCaptionAutoGenerationEnabled: boolean

    If true, captions for videos will be automatically generated

    isGeoRestrictionsEnabled: boolean
    isWorkflowEnabled?: boolean

    Jetsteam Flow enabled flag

    language: string

    Brand language in ISO 639-2 format

    'eng'
    
    lastActivity: Date

    Brand last activity date. When the brand was last updated or when a new episode was published

    logo: Promise<MaybeNull<BaseImage>>

    Brand logo

    logoId?: MaybeNull<string>
    longDescription?: MaybeNull<RichText>

    Brand long description

    madeForKids?: boolean

    If true, brand content is made for kids

    materialId: string

    Unique brand material ID

    'HSS'
    
    organization: Promise<BaseOrganization>

    Organization where the brand belongs to

    organizationId: string

    Organization ID where the brand belongs to

    shortDescription?: MaybeNull<RichText>

    Brand short description

    status: BrandStatus

    Brand status. Can be ACTIVE, DELETED.

    tagline?: MaybeNull<RichText>

    Brand logo ID

    title: string

    Brand title

    'Hope Sabbath School'
    
    type: BrandType

    Brand type. Can be TV_SHOW, RADIO, PODCAST

    updatedAt: Date

    Date when the brand was updated

    updatedBy: Promise<MaybeNull<BaseUser>>

    Last user who updated the brand

    updatedById?: MaybeNull<string>

    Keep id of the last user who updated the brand

    visibility: BrandVisibility

    Brand visibility settings for other organizations

    workflowId?: MaybeNull<WorkflowId>

    Jetsteam Flow workflow ID

    Accessors

    • get isDeleted(): boolean

      Returns boolean

    • get target(): EntityTarget<any>

      Returns object that is managed by this repository. If this repository manages entity from schema, then it returns a name of that schema instead.

      Returns EntityTarget<any>

    Methods

    • Checks if entity has an id. If entity composite compose ids, it will check them all.

      Returns boolean

    • Recovers a given entity in the database.

      Parameters

      • Optionaloptions: SaveOptions

      Returns Promise<BaseBrand>

    • Reloads entity data from the database.

      Returns Promise<void>

    • Removes current entity from the database.

      Parameters

      • Optionaloptions: RemoveOptions

      Returns Promise<BaseBrand>

    • Saves current entity in the database. If entity does not exist in the database then inserts, otherwise updates.

      Parameters

      • Optionaloptions: SaveOptions

      Returns Promise<BaseBrand>

    • Records the delete date of current entity.

      Parameters

      • Optionaloptions: SaveOptions

      Returns Promise<BaseBrand>

    • Return the AVG of a column

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • columnName: PickKeysByType<T, number>
      • where: FindOptionsWhere<T>

      Returns Promise<null | number>

    • Clears all the data from the given table/collection (truncates/drops it).

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity

      Returns Promise<void>

    • Counts entities that match given options.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • Optionaloptions: FindManyOptions<T>

      Returns Promise<number>

    • Counts entities that match given WHERE conditions.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • where: FindOptionsWhere<T>

      Returns Promise<number>

    • Creates a new entity instance.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity

      Returns T

    • Creates a new entities and copies all entity properties from given objects into their new entities. Note that it copies only properties that present in entity schema.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entityLikeArray: DeepPartial<T>[]

      Returns T[]

    • Creates a new entity instance and copies all entity properties from this object into a new entity. Note that it copies only properties that present in entity schema.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entityLike: DeepPartial<T>

      Returns T

    • Creates a new query builder that can be used to build a SQL query.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • Optionalalias: string

      Returns SelectQueryBuilder<T>

    • Deletes entities by a given criteria. Unlike remove method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient DELETE query. Does not check if entity exist in the database.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • criteria:
            | string
            | number
            | string[]
            | Date
            | number[]
            | ObjectId
            | Date[]
            | ObjectId[]
            | FindOptionsWhere<T>

      Returns Promise<DeleteResult>

    • Checks whether any entity exists that matches the given options.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • Optionaloptions: FindManyOptions<T>

      Returns Promise<boolean>

    • Checks whether any entity exists that matches the given conditions.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • where: FindOptionsWhere<T>

      Returns Promise<boolean>

    • Finds entities that match given options.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • Optionaloptions: FindManyOptions<T>

      Returns Promise<T[]>

    • Finds entities that match given find options. Also counts all entities that match given conditions, but ignores pagination settings (from and take options).

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • Optionaloptions: FindManyOptions<T>

      Returns Promise<[T[], number]>

    • Finds entities that match given WHERE conditions. Also counts all entities that match given conditions, but ignores pagination settings (from and take options).

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • where: FindOptionsWhere<T>

      Returns Promise<[T[], number]>

    • Finds entities that match given WHERE conditions.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • where: FindOptionsWhere<T>

      Returns Promise<T[]>

    • Finds entities by ids. Optionally find options can be applied.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • ids: any[]

      Returns Promise<T[]>

      use findBy method instead in conjunction with In operator, for example:

      .findBy({ id: In([1, 2, 3]) })

    • Finds first entity that matches given conditions.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • options: FindOneOptions<T>

      Returns Promise<null | T>

    • Finds first entity that matches given conditions.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • where: FindOptionsWhere<T>

      Returns Promise<null | T>

    • Finds first entity that matches given options.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • id: string | number | Date | ObjectId

      Returns Promise<null | T>

      use findOneBy method instead in conjunction with In operator, for example:

      .findOneBy({ id: 1 // where "id" is your primary column name })

    • Finds first entity that matches given conditions.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • where: FindOptionsWhere<T>

      Returns Promise<T>

    • Finds first entity that matches given conditions.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • options: FindOneOptions<T>

      Returns Promise<T>

    • Gets entity mixed id.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entity: T

      Returns any

    • Gets current entity's Repository.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity

      Returns Repository<T>

    • Checks entity has an id. If entity composite compose ids, it will check them all.

      Parameters

      • entity: BaseEntity

      Returns boolean

    • Inserts a given entity into the database. Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient INSERT query. Does not check if entity exist in the database, so query will fail if duplicate entity is being inserted.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entity:
            | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
            | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[]

      Returns Promise<InsertResult>

    • Return the MAX of a column

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • columnName: PickKeysByType<T, number>
      • where: FindOptionsWhere<T>

      Returns Promise<null | number>

    • Merges multiple entities (or entity-like objects) into a given entity.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • mergeIntoEntity: T
      • ...entityLikes: DeepPartial<T>[]

      Returns T

    • Return the MIN of a column

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • columnName: PickKeysByType<T, number>
      • where: FindOptionsWhere<T>

      Returns Promise<null | number>

    • Creates a new entity from the given plain javascript object. If entity already exist in the database, then it loads it (and everything related to it), replaces all values with the new ones from the given object and returns this new entity. This new entity is actually a loaded from the db entity with all properties replaced from the new object.

      Note that given entity-like object must have an entity id / primary key to find entity by. Returns undefined if entity with given id was not found.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entityLike: DeepPartial<T>

      Returns Promise<undefined | T>

    • Executes a raw SQL query and returns a raw database results. Raw query execution is supported only by relational databases (MongoDB is not supported).

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • query: string
      • Optionalparameters: any[]

      Returns Promise<any>

    • Removes a given entities from the database.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entities: T[]
      • Optionaloptions: RemoveOptions

      Returns Promise<T[]>

    • Removes a given entity from the database.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entity: T
      • Optionaloptions: RemoveOptions

      Returns Promise<T>

    • Saves all given entities in the database. If entities do not exist in the database then inserts, otherwise updates.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entities: DeepPartial<T>[]
      • Optionaloptions: SaveOptions

      Returns Promise<T[]>

    • Saves a given entity in the database. If entity does not exist in the database then inserts, otherwise updates.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entity: DeepPartial<T>
      • Optionaloptions: SaveOptions

      Returns Promise<T>

    • Records the delete date of all given entities.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entities: T[]
      • Optionaloptions: SaveOptions

      Returns Promise<T[]>

    • Records the delete date of a given entity.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entity: T
      • Optionaloptions: SaveOptions

      Returns Promise<T>

    • Return the SUM of a column

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • columnName: PickKeysByType<T, number>
      • where: FindOptionsWhere<T>

      Returns Promise<null | number>

    • Updates entity partially. Entity can be found by a given conditions. Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient UPDATE query. Does not check if entity exist in the database.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • criteria:
            | string
            | number
            | string[]
            | Date
            | number[]
            | ObjectId
            | Date[]
            | ObjectId[]
            | FindOptionsWhere<T>
      • partialEntity: QueryDeepPartialEntity<T>

      Returns Promise<UpdateResult>

    • Inserts a given entity into the database, unless a unique constraint conflicts then updates the entity Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient INSERT ... ON CONFLICT DO UPDATE/ON DUPLICATE KEY UPDATE query.

      Type Parameters

      • T extends BaseEntity

      Parameters

      • this: new () => T & typeof BaseEntity
      • entityOrEntities:
            | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
            | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[]
      • conflictPathsOrOptions: string[] | UpsertOptions<T>

      Returns Promise<InsertResult>

    • Sets DataSource to be used by entity.

      Parameters

      • dataSource: null | DataSource

      Returns void