ask-and-trust - v1.0.0
    Preparing search index...

    Payment Entity

    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.
    // 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
    Index

    Constructors

    • Returns Payment

    Properties

    amount: number

    Amount of the payment in cents

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

    createdAt: Date

    Timestamp of when the payment was created

    The date and time when this payment was created.

    currency: string

    Currency of the payment

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

    description: string

    Description of the payment

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

    id: number

    Unique identifier for the payment

    Auto-generated primary key for the payment entity.

    status: string

    Status of the payment

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

    stripePaymentIntentId: string

    ID of the Stripe PaymentIntent

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

    surveyCount: number

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

    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: Date

    Timestamp of when the payment was last updated

    The date and time when this payment was last updated.

    user: User

    Relation to the User entity

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

    userId: number

    ID of the user who made the payment

    The ID of the user who made this payment.

    Accessors

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

    • Reloads entity data from the database.

      Returns Promise<void>

    • Removes current entity from the database.

      Parameters

      • Optionaloptions: RemoveOptions

      Returns Promise<Payment>

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

      Parameters

      • Optionaloptions: SaveOptions

      Returns Promise<Payment>

    • Records the delete date of current entity.

      Parameters

      • Optionaloptions: SaveOptions

      Returns Promise<Payment>

    • 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
            | Date
            | string[]
            | ObjectId
            | number[]
            | 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
            | Date
            | string[]
            | ObjectId
            | number[]
            | Date[]
            | ObjectId[]
            | FindOptionsWhere<T>
      • partialEntity: _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : 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