91615f9c45
* add oas schema to tsdoc parser * add tsdoc (part 1) * Finished tsdoc in js client * general fixes * added tsdoc in core medusa package * parse schema tags in model files * added maxlevel option * added more tsdoc * added tsdoc in core * added TSDoc in core package * generated client types * support featureFlag and expandable tags * added support for resource feature flag note * fix api ignore plugin * added eslint plugin * support feature flag and expandable badges * adjusted overview page + generated reference * revert generated files * added changeset * add details about new typedoc options * fix broken link
158 lines
4.4 KiB
TypeScript
158 lines
4.4 KiB
TypeScript
import {
|
|
BeforeInsert,
|
|
Column,
|
|
Entity,
|
|
Index,
|
|
JoinColumn,
|
|
ManyToOne,
|
|
OneToMany,
|
|
} from "typeorm"
|
|
|
|
import { BaseEntity } from "../interfaces/models/base-entity"
|
|
import { Customer } from "./customer"
|
|
import { DbAwareColumn } from "../utils/db-aware-column"
|
|
import { NotificationProvider } from "./notification-provider"
|
|
import { generateEntityId } from "../utils/generate-entity-id"
|
|
|
|
@Entity()
|
|
export class Notification extends BaseEntity {
|
|
@Column({ nullable: true })
|
|
event_name: string
|
|
|
|
@Index()
|
|
@Column()
|
|
resource_type: string
|
|
|
|
@Index()
|
|
@Column()
|
|
resource_id: string
|
|
|
|
@Index()
|
|
@Column({ nullable: true })
|
|
customer_id: string | null
|
|
|
|
@ManyToOne(() => Customer)
|
|
@JoinColumn({ name: "customer_id" })
|
|
customer: Customer
|
|
|
|
@Column()
|
|
to: string
|
|
|
|
@DbAwareColumn({ type: "jsonb" })
|
|
data: Record<string, unknown>
|
|
|
|
@Column({ nullable: true })
|
|
parent_id: string
|
|
|
|
@ManyToOne(() => Notification)
|
|
@JoinColumn({ name: "parent_id" })
|
|
parent_notification: Notification
|
|
|
|
@OneToMany(() => Notification, (noti) => noti.parent_notification)
|
|
resends: Notification[]
|
|
|
|
@Column({ nullable: true })
|
|
provider_id: string
|
|
|
|
@ManyToOne(() => NotificationProvider)
|
|
@JoinColumn({ name: "provider_id" })
|
|
provider: NotificationProvider
|
|
|
|
/**
|
|
* @apiIgnore
|
|
*/
|
|
@BeforeInsert()
|
|
private beforeInsert(): void {
|
|
this.id = generateEntityId(this.id, "noti")
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @schema Notification
|
|
* title: "Notification"
|
|
* description: "A notification is an alert sent, typically to customers, using the installed Notification Provider as a reaction to internal events such as `order.placed`. Notifications can be resent."
|
|
* type: object
|
|
* required:
|
|
* - created_at
|
|
* - customer_id
|
|
* - data
|
|
* - event_name
|
|
* - id
|
|
* - parent_id
|
|
* - provider_id
|
|
* - resource_type
|
|
* - resource_id
|
|
* - to
|
|
* - updated_at
|
|
* properties:
|
|
* id:
|
|
* description: The notification's ID
|
|
* type: string
|
|
* example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
|
|
* event_name:
|
|
* description: The name of the event that the notification was sent for.
|
|
* nullable: true
|
|
* type: string
|
|
* example: order.placed
|
|
* resource_type:
|
|
* description: The type of resource that the Notification refers to.
|
|
* type: string
|
|
* example: order
|
|
* resource_id:
|
|
* description: The ID of the resource that the Notification refers to.
|
|
* type: string
|
|
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
|
* customer_id:
|
|
* description: The ID of the customer that this notification was sent to.
|
|
* nullable: true
|
|
* type: string
|
|
* example: cus_01G2SG30J8C85S4A5CHM2S1NS2
|
|
* customer:
|
|
* description: The details of the customer that this notification was sent to.
|
|
* x-expandable: "customer"
|
|
* nullable: true
|
|
* $ref: "#/components/schemas/Customer"
|
|
* to:
|
|
* description: The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.
|
|
* type: string
|
|
* example: user@example.com
|
|
* data:
|
|
* description: The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.
|
|
* type: object
|
|
* example: {}
|
|
* parent_id:
|
|
* description: The notification's parent ID
|
|
* nullable: true
|
|
* type: string
|
|
* example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
|
|
* parent_notification:
|
|
* description: The details of the parent notification.
|
|
* x-expandable: "parent_notification"
|
|
* nullable: true
|
|
* $ref: "#/components/schemas/Notification"
|
|
* resends:
|
|
* description: The details of all resends of the notification.
|
|
* type: array
|
|
* x-expandable: "resends"
|
|
* items:
|
|
* $ref: "#/components/schemas/Notification"
|
|
* provider_id:
|
|
* description: The ID of the notification provider used to send the notification.
|
|
* nullable: true
|
|
* type: string
|
|
* example: sengrid
|
|
* provider:
|
|
* description: The notification provider used to send the notification.
|
|
* x-expandable: "provider"
|
|
* nullable: true
|
|
* $ref: "#/components/schemas/NotificationProvider"
|
|
* created_at:
|
|
* description: The date with timezone at which the resource was created.
|
|
* type: string
|
|
* format: date-time
|
|
* updated_at:
|
|
* description: The date with timezone at which the resource was updated.
|
|
* type: string
|
|
* format: date-time
|
|
*/
|