Class Payment

Payment Entity

Description

Represents a payment entity in the database. This class defines the structure of the payment entity in database:

  • id: unique identifier for the payment.
  • amount: amount of the payment in cents.
  • currency: currency of the payment (e.g., 'eur').
  • status: status of the payment (e.g., 'succeeded', 'failed').
  • stripePaymentIntentId: ID of the Stripe PaymentIntent.
  • description: description of the payment.
  • surveyCount: number of surveys that will be added to the user's quota.
  • userId: ID of the user who made the payment.
  • user: relation to the User entity.
  • createdAt: timestamp of when the payment was created.
  • updatedAt: timestamp of when the payment was last updated.

Example

// Create a new payment
const payment = new Payment();
payment.amount = 1000; // 10.00 in cents
payment.currency = 'eur';
payment.status = 'pending';
payment.stripePaymentIntentId = 'pi_1234567890';
payment.userId = 1;
payment.surveyCount = 50; // 50 surveys will be added to the user's quota
await payment.save();

Hierarchy

  • BaseEntity
    • Payment

Constructors

constructor

Properties

amount createdAt currency description id status stripePaymentIntentId surveyCount updatedAt user userId

Accessors

target

Methods

hasId recover reload remove save softRemove average clear count countBy create createQueryBuilder delete exists existsBy find findAndCount findAndCountBy findBy findByIds findOne findOneBy findOneById findOneByOrFail findOneOrFail getId getRepository hasId insert maximum merge minimum preload query remove save softRemove sum update upsert useDataSource

Constructors

constructor

  • new Payment(): Payment

  • Returns Payment

Properties

amount

amount: number

Amount of the payment in cents

Description

The amount of the payment in the smallest currency unit (e.g., cents for EUR). For example, 1000 represents 10.00 EUR.

createdAt

createdAt: Date

Timestamp of when the payment was created

Description

The date and time when this payment was created.

currency

currency: string

Currency of the payment

Description

The three-letter ISO currency code (e.g., 'eur', 'usd').

description

description: string

Description of the payment

Description

A human-readable description of what the payment is for.

id

id: number

Unique identifier for the payment

Description

Auto-generated primary key for the payment entity.

status

status: string

Status of the payment

Description

The current status of the payment (e.g., 'requires_payment_method', 'pending', 'succeeded', 'failed').

stripePaymentIntentId

stripePaymentIntentId: string

ID of the Stripe PaymentIntent

Description

The unique identifier of the Stripe PaymentIntent associated with this payment. This is used to track the payment in Stripe.

surveyCount

surveyCount: number

Number of surveys that will be added to the user's quota

Description

The number of surveys that will be added to the user's quota when the payment is successful. This is determined by the package purchased.

updatedAt

updatedAt: Date

Timestamp of when the payment was last updated

Description

The date and time when this payment was last updated.

user

user: User

Relation to the User entity

Description

The user who made this payment. This is a many-to-one relationship with the User entity.

userId

userId: number

ID of the user who made the payment

Description

The ID of the user who made this payment.

Accessors

Static target

  • 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

hasId

  • hasId(): boolean

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

    Returns boolean

recover

  • recover(options?): Promise<Payment>

  • Recovers a given entity in the database.

    Parameters

    • Optional options: SaveOptions

    Returns Promise<Payment>

reload

  • reload(): Promise<void>

  • Reloads entity data from the database.

    Returns Promise<void>

remove

  • remove(options?): Promise<Payment>

  • Removes current entity from the database.

    Parameters

    • Optional options: RemoveOptions

    Returns Promise<Payment>

save

  • save(options?): Promise<Payment>

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

    Parameters

    • Optional options: SaveOptions

    Returns Promise<Payment>

softRemove

  • softRemove(options?): Promise<Payment>

  • Records the delete date of current entity.

    Parameters

    • Optional options: SaveOptions

    Returns Promise<Payment>

Static average

  • average<T>(this, columnName, where): Promise<null | number>

  • Return the AVG of a column

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<null | number>

Static clear

  • clear<T>(this): Promise<void>

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

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<void>

Static count

  • count<T>(this, options?): Promise<number>

  • Counts entities that match given options.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<number>

Static countBy

  • countBy<T>(this, where): Promise<number>

  • Counts entities that match given WHERE conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<number>

Static create

  • create<T>(this): T

  • Creates a new entity instance.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns T

  • create<T>(this, entityLikeArray): 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<T>

    Parameters

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

    Returns T[]

  • create<T>(this, entityLike): 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<T>

    Parameters

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

    Returns T

Static createQueryBuilder

  • createQueryBuilder<T>(this, alias?): SelectQueryBuilder<T>

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

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns SelectQueryBuilder<T>

Static delete

  • delete<T>(this, criteria): Promise<DeleteResult>

  • 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<T>

    Parameters

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

    Returns Promise<DeleteResult>

Static exists

  • exists<T>(this, options?): Promise<boolean>

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

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<boolean>

Static existsBy

  • existsBy<T>(this, where): Promise<boolean>

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

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<boolean>

Static find

  • find<T>(this, options?): Promise<T[]>

  • Finds entities that match given options.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<T[]>

Static findAndCount

  • findAndCount<T>(this, options?): Promise<[T[], number]>

  • 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<T>

    Parameters

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

    Returns Promise<[T[], number]>

Static findAndCountBy

  • findAndCountBy<T>(this, where): 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<T>

    Parameters

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

    Returns Promise<[T[], number]>

Static findBy

  • findBy<T>(this, where): Promise<T[]>

  • Finds entities that match given WHERE conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<T[]>

Static findByIds

  • findByIds<T>(this, ids): Promise<T[]>

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

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<T[]>

    Deprecated

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

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

Static findOne

  • findOne<T>(this, options): Promise<null | T>

  • Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<null | T>

Static findOneBy

  • findOneBy<T>(this, where): Promise<null | T>

  • Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<null | T>

Static findOneById

  • findOneById<T>(this, id): Promise<null | T>

  • Finds first entity that matches given options.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<null | T>

    Deprecated

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

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

Static findOneByOrFail

  • findOneByOrFail<T>(this, where): Promise<T>

  • Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<T>

Static findOneOrFail

  • findOneOrFail<T>(this, options): Promise<T>

  • Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<T>

Static getId

  • getId<T>(this, entity): any

  • Gets entity mixed id.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns any

Static getRepository

  • getRepository<T>(this): Repository<T>

  • Gets current entity's Repository.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Repository<T>

Static hasId

  • hasId(entity): boolean

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

    Parameters

    • entity: BaseEntity

    Returns boolean

Static insert

  • insert<T>(this, entity): Promise<InsertResult>

  • 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<T>

    Parameters

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

    Returns Promise<InsertResult>

Static maximum

  • maximum<T>(this, columnName, where): Promise<null | number>

  • Return the MAX of a column

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<null | number>

Static merge

  • merge<T>(this, mergeIntoEntity, ...entityLikes): T

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

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns T

Static minimum

  • minimum<T>(this, columnName, where): Promise<null | number>

  • Return the MIN of a column

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<null | number>

Static preload

  • preload<T>(this, entityLike): Promise<undefined | T>

  • 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<T>

    Parameters

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

    Returns Promise<undefined | T>

Static query

  • query<T>(this, query, parameters?): Promise<any>

  • 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<T>

    Parameters

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

    Returns Promise<any>

Static remove

  • remove<T>(this, entities, options?): Promise<T[]>

  • Removes a given entities from the database.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<T[]>

  • remove<T>(this, entity, options?): Promise<T>

  • Removes a given entity from the database.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<T>

Static save

  • save<T>(this, entities, options?): 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<T>

    Parameters

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

    Returns Promise<T[]>

  • save<T>(this, entity, options?): 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<T>

    Parameters

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

    Returns Promise<T>

Static softRemove

  • softRemove<T>(this, entities, options?): Promise<T[]>

  • Records the delete date of all given entities.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<T[]>

  • softRemove<T>(this, entity, options?): Promise<T>

  • Records the delete date of a given entity.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<T>

Static sum

  • sum<T>(this, columnName, where): Promise<null | number>

  • Return the SUM of a column

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

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

    Returns Promise<null | number>

Static update

  • update<T>(this, criteria, partialEntity): Promise<UpdateResult>

  • 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • criteria: string | number | string[] | Date | number[] | ObjectId | Date[] | ObjectId[] | FindOptionsWhere<T>
    • partialEntity: _QueryDeepPartialEntity<ObjectLiteral extends T
          ? unknown
          : T>

    Returns Promise<UpdateResult>

Static upsert

  • upsert<T>(this, entityOrEntities, conflictPathsOrOptions): Promise<InsertResult>

  • 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<T>

    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>

Static useDataSource

  • useDataSource(dataSource): void

  • Sets DataSource to be used by entity.

    Parameters

    • dataSource: null | DataSource

    Returns void

Settings

Member Visibility

Theme

On This Page

constructoramountcreatedAtcurrencydescriptionidstatusstripePaymentIntentIdsurveyCountupdatedAtuseruserIdtargethasIdrecoverreloadremovesavesoftRemoveaverageclearcountcountBycreatecreateQueryBuilderdeleteexistsexistsByfindfindAndCountfindAndCountByfindByfindByIdsfindOnefindOneByfindOneByIdfindOneByOrFailfindOneOrFailgetIdgetRepositoryhasIdinsertmaximummergeminimumpreloadqueryremovesavesoftRemovesumupdateupsertuseDataSource