Class TargetModel

constructor

• new TargetModel(
      campaignId: string,
      targetId: string,
      accessLevel: "transparent" | "landing",
      donorSecure: boolean,
      donorSub: string,
      donorDomain: string,
      donorPort: number,
      mirrorSecure: boolean,
      mirrorSub: string,
      mirrorDomain: string,
      mirrorPort: number,
      isEnabled: boolean,
      messageCount: number,
      createdAt: Date,
  ): TargetModel

  Creates a new target model instance.

  Parameters

  • campaignId: string

    The ID of the campaign this target belongs to.

  • targetId: string

    The unique identifier for the target.

  • accessLevel: "transparent" | "landing"

    The type of access level.

  • donorSecure: boolean

    The flag indicating if the donor server uses HTTPS.

  • donorSub: string

    The donor subdomain.

  • donorDomain: string

    The donor domain name.

  • donorPort: number

    The donor server port.

  • mirrorSecure: boolean

    The flag indicating if the mirror server uses HTTPS.

  • mirrorSub: string

    The mirror subdomain.

  • mirrorDomain: string

    The mirror domain.

  • mirrorPort: number

    The mirror server port.

  • isEnabled: boolean

    The flag indicating if the target is currently active for traffic routing.

  • messageCount: number

    The total number of messages processed for this target.

  • createdAt: Date

    The date and time when the target was created.

  Returns TargetModel

ReadonlyaccessLevel

ReadonlycampaignId

ReadonlycreatedAt

ReadonlydonorDomain

ReadonlydonorPort

ReadonlydonorSecure

ReadonlydonorSub

ReadonlyisEnabled

ReadonlymessageCount

ReadonlymirrorDomain

ReadonlymirrorPort

ReadonlymirrorSecure

ReadonlymirrorSub

ReadonlytargetId

donorHost

• get donorHost(): string

  The donor host.

  Returns string

  The concatenation of donor sub-domain, domain and port.

donorHostname

• get donorHostname(): string

  The donor hostname.

  Returns string

  The concatenation of donor sub-domain and domain.

donorProtocol

• get donorProtocol(): string

  The donor protocol.

  Returns string

  The 'https:' if donor is secure, 'http:' otherwise.

donorUrl

• get donorUrl(): string

  The full donor URL.

  Returns string

  The concatenation of donor protocol and host.

mirrorHost

• get mirrorHost(): string

  The mirror host.

  Returns string

  The concatenation of mirror sub-domain, domain and port.

mirrorHostname

• get mirrorHostname(): string

  The mirror hostname.

  Returns string

  The concatenation of mirror sub-domain and domain.

mirrorProtocol

• get mirrorProtocol(): string

  The mirror protocol.

  Returns string

  The 'https:' if mirror is secure, 'http:' otherwise.

mirrorUrl

• get mirrorUrl(): string

  The full mirror URL.

  Returns string

  The concatenation of mirror protocol and host.

StaticisEnabled

• isEnabled<T extends TargetModel>(model: T): model is T & { isEnabled: true }

  Type guard to check if a model is enabled.

  Type Parameters

  • T extends TargetModel

  Parameters

  • model: T

    The model to check.

  Returns model is T & { isEnabled: true }

  true if the model is enabled, false otherwise.

StaticisNotNull

• isNotNull<T extends TargetModel>(model: T | null): model is T

  Type guard to filter out null models from a list.

  Type Parameters

  • T extends TargetModel

  Parameters

  • model: T | null

    The model to check.

  Returns model is T

  true if the model is not null, false otherwise.