Turo developer documentation
  1. Classes
  2. Project

File

src/project/entities/project.entity.ts

Index

Properties
Methods

Constructor

constructor(partial: Partial<Project>)
Defined in src/project/entities/project.entity.ts:62
Parameters :
Name Type Optional
partial Partial<Project> No

Properties

Optional budget
Type : number
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:33
Optional businessObjective
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:18
businessUnit
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:51
Optional createdAt
Type : Date
Decorators :
@Exclude()
Defined in src/project/entities/project.entity.ts:54
description
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:15
Optional estimatedRevenue
Type : number
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:27
Optional hasPendingAccessRequest
Type : boolean
Defined in src/project/entities/project.entity.ts:60
id
Type : number
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:6
Optional impactNotes
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:30
Optional isProjectUser
Type : boolean
Defined in src/project/entities/project.entity.ts:59
Optional isPublic
Type : boolean
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:12
Optional keyResults
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:21
Optional kpis
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:24
Optional metrics
Type : any
Defined in src/project/entities/project.entity.ts:61
name
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:9
Optional owner
Type : any
Defined in src/project/entities/project.entity.ts:62
slug
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:48
Optional stage
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:42
Optional targetVariable
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:36
Optional teamMembers
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:39
Optional updatedAt
Type : Date
Decorators :
@Exclude()
Defined in src/project/entities/project.entity.ts:57
Optional useCaseType
Type : string
Decorators :
@ApiProperty()
Defined in src/project/entities/project.entity.ts:45

Methods

getProjectServiceUsername
getProjectServiceUsername()
Defined in src/project/entities/project.entity.ts:68
Returns : string 
import { ApiProperty } from "@nestjs/swagger";
import { Exclude } from "class-transformer";

export class Project {
  @ApiProperty()
  id: number;

  @ApiProperty()
  name: string;

  @ApiProperty()
  isPublic?: boolean;

  @ApiProperty()
  description: string;

  @ApiProperty()
  businessObjective?: string;

  @ApiProperty()
  keyResults?: string;

  @ApiProperty()
  kpis?: string;

  @ApiProperty()
  estimatedRevenue?: number;

  @ApiProperty()
  impactNotes?: string;

  @ApiProperty()
  budget?: number;

  @ApiProperty()
  targetVariable?: string;

  @ApiProperty()
  teamMembers?: string;

  @ApiProperty()
  stage?: string;

  @ApiProperty()
  useCaseType?: string;

  @ApiProperty()
  slug: string;

  @ApiProperty()
  businessUnit: string;

  @Exclude()
  createdAt?: Date;

  @Exclude()
  updatedAt?: Date;

  isProjectUser?: boolean;
  hasPendingAccessRequest?: boolean;
  metrics?: any;
  owner?: any;

  constructor(partial: Partial<Project>) {
    Object.assign(this, partial);
  }

  getProjectServiceUsername() {
    return `${this.slug}-su`;
  }
}

export enum ProjectStages {
  ASSESS = "ASSESS",
  BUILD = "BUILD",
  PILOT = "PILOT",
  SCALE = "SCALE",
  ARCHIVED = "ARCHIVED",
  DELETED = "DELETED",
  APPROVAL = "APPROVAL",
  REJECTED = "REJECTED",
}

export enum ProjectUseCaseType {
  FRAUD_DETECTION = "FRAUD_DETECTION",
  RISK_ASSESSMENT = "RISK_ASSESSMENT",
  PERSONALISATION = "PERSONALISATION",
  RECOMMENDATION_ENGINE = "RECOMMENDATION_ENGINE",
  CROSS_SELL = "CROSS_SELL",
  OTHER = "OTHER",
}

export enum ProjectUseCaseModelName {
  FRAUD_DETECTION = "Number of flagged suspicious transactions",
  RISK_ASSESSMENT = "Number of missed payments",
  PERSONALISATION = "Open rate and click-through rate of personalized messages",
  RECOMMENDATION_ENGINE = "Number of accepted recommendations by end users",
  CROSS_SELL = "Number of cross-sell offers made, customer engagement with offers",
}

results matching ""

    No results matching ""