@oneuptime/common 9.2.15 → 9.2.17

package/Models/DatabaseModels/ProbeOwnerTeam.ts

@@ -94,6 +94,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -131,6 +132,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -161,6 +163,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     title: "Team",
     description:
       "Team that is the owner. All users in this team will receive notifications. ",
+    example: "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
   })
   @ManyToOne(
     () => {
@@ -198,6 +201,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of your OneUptime Team in which this object belongs",
+    example: "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -227,6 +231,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     modelType: Probe,
     title: "Probe",
     description: "Relation to Probe Resource in which this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
   })
   @ManyToOne(
     () => {
@@ -264,6 +269,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Probe ID",
     description: "ID of your OneUptime Probe in which this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -294,6 +300,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
   })
   @ManyToOne(
     () => {
@@ -329,6 +336,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -354,6 +362,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @ManyToOne(
     () => {
@@ -385,6 +394,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -413,6 +423,7 @@ export default class ProbeOwnerTeam extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of this resource ownership?",
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/ProbeOwnerUser.ts

@@ -93,6 +93,7 @@ export default class ProbeOwnerUser extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -130,6 +131,7 @@ export default class ProbeOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -160,6 +162,7 @@ export default class ProbeOwnerUser extends BaseModel {
     title: "User",
     description:
       "User that is the owner. This user will receive notifications. ",
+    example: "e5f6a7b8-c9d0-1234-ef56-ab78cd901234",
   })
   @ManyToOne(
     () => {
@@ -197,6 +200,7 @@ export default class ProbeOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "User ID",
     description: "ID of your OneUptime User in which this object belongs",
+    example: "e5f6a7b8-c9d0-1234-ef56-ab78cd901234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -226,6 +230,7 @@ export default class ProbeOwnerUser extends BaseModel {
     modelType: Probe,
     title: "Probe",
     description: "Relation to Probe Resource in which this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
   })
   @ManyToOne(
     () => {
@@ -263,6 +268,7 @@ export default class ProbeOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Probe ID",
     description: "ID of your OneUptime Probe in which this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -293,6 +299,7 @@ export default class ProbeOwnerUser extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
   })
   @ManyToOne(
     () => {
@@ -328,6 +335,7 @@ export default class ProbeOwnerUser extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -353,6 +361,7 @@ export default class ProbeOwnerUser extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @ManyToOne(
     () => {
@@ -384,6 +393,7 @@ export default class ProbeOwnerUser extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -412,6 +422,7 @@ export default class ProbeOwnerUser extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of this resource ownership?",
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/Project.ts

@@ -87,6 +87,7 @@ export default class Project extends TenantModel {
     title: "Name",
     description: "Any friendly name of this object",
     canReadOnRelationQuery: true,
+    example: "My Awesome Project",
   })
   @Column({
     nullable: false,
@@ -265,6 +266,8 @@ export default class Project extends TenantModel {
     title: "Business Details / Billing Address",
     description:
       "Business legal name, address and any tax information to appear on invoices.",
+    example:
+      "Acme Corporation\n123 Main Street\nSan Francisco, CA 94102\nTax ID: 12-3456789",
   })
   @Column({
     type: ColumnType.LongText,
@@ -291,6 +294,7 @@ export default class Project extends TenantModel {
     title: "Business Country (ISO Alpha-2)",
     description:
       "Two-letter ISO country code for billing address (e.g., US, GB, DE).",
+    example: "US",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -317,6 +321,7 @@ export default class Project extends TenantModel {
     title: "Finance / Accounting Email",
     description:
       "Invoices, receipts and billing related notifications will be sent to this email in addition to project owner.",
+    example: "accounting@example.com",
   })
   @Column({
     type: ColumnType.Email,
@@ -441,6 +446,7 @@ export default class Project extends TenantModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -494,6 +500,7 @@ export default class Project extends TenantModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -707,6 +714,7 @@ export default class Project extends TenantModel {
     title: "SMS, Call, and WhatsApp Current Balance",
     description: "Balance in USD for SMS, Call, and WhatsApp",
     defaultValue: 0,
+    example: 2500,
   })
   @Column({
     type: ColumnType.Number,
@@ -734,6 +742,7 @@ export default class Project extends TenantModel {
     title: "Auto Recharge Amount",
     description: "Auto recharge amount in USD for SMS, Call, and WhatsApp",
     defaultValue: 20,
+    example: 20,
   })
   @Column({
     type: ColumnType.Number,
@@ -762,6 +771,7 @@ export default class Project extends TenantModel {
     description:
       "Auto recharge is triggered when current balance falls to this amount in USD for SMS, Call, and WhatsApp",
     defaultValue: 10,
+    example: 10,
   })
   @Column({
     type: ColumnType.Number,
@@ -790,6 +800,7 @@ export default class Project extends TenantModel {
     title: "Enable SMS Notifications",
     description: "Enable SMS notifications for this project.",
     defaultValue: false,
+    example: true,
   })
   @Column({
     nullable: false,
@@ -817,6 +828,7 @@ export default class Project extends TenantModel {
     title: "Enable WhatsApp Notifications",
     description: "Enable WhatsApp notifications for this project.",
     defaultValue: false,
+    example: false,
   })
   @Column({
     nullable: false,
@@ -844,6 +856,7 @@ export default class Project extends TenantModel {
     title: "Enable Call Notifications",
     description: "Enable call notifications for this project.",
     defaultValue: false,
+    example: false,
   })
   @Column({
     nullable: false,
@@ -872,6 +885,7 @@ export default class Project extends TenantModel {
     description:
       "Enable auto recharge for SMS, Call, and WhatsApp balance for this project.",
     defaultValue: false,
+    example: true,
   })
   @Column({
     nullable: false,
@@ -948,6 +962,212 @@ export default class Project extends TenantModel {
   })
   public notEnabledSmsOrCallNotificationSentToOwners?: boolean = undefined;
 
+  // AI Billing Fields
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProject,
+      Permission.UnAuthorizedSsoUser,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.Number,
+    isDefaultValueColumn: true,
+    required: true,
+    title: "AI Current Balance",
+    description: "Balance in USD for AI services",
+    defaultValue: 0,
+    example: 2500,
+  })
+  @Column({
+    type: ColumnType.Number,
+    nullable: false,
+    unique: false,
+    default: 0,
+  })
+  public aiCurrentBalanceInUSDCents?: number = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProject,
+      Permission.UnAuthorizedSsoUser,
+    ],
+    update: [Permission.ProjectOwner, Permission.ManageProjectBilling],
+  })
+  @TableColumn({
+    type: TableColumnType.Number,
+    isDefaultValueColumn: true,
+    required: true,
+    title: "AI Auto Recharge Amount",
+    description: "Auto recharge amount in USD for AI services",
+    defaultValue: 20,
+    example: 20,
+  })
+  @Column({
+    type: ColumnType.Number,
+    nullable: false,
+    unique: false,
+    default: 20,
+  })
+  public autoAiRechargeByBalanceInUSD?: number = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProject,
+      Permission.UnAuthorizedSsoUser,
+    ],
+    update: [Permission.ProjectOwner, Permission.ManageProjectBilling],
+  })
+  @TableColumn({
+    type: TableColumnType.Number,
+    isDefaultValueColumn: true,
+    required: true,
+    title: "AI Auto Recharge when current balance falls to",
+    description:
+      "Auto recharge is triggered when current balance falls to this amount in USD for AI services",
+    defaultValue: 10,
+    example: 10,
+  })
+  @Column({
+    type: ColumnType.Number,
+    nullable: false,
+    unique: false,
+    default: 10,
+  })
+  public autoRechargeAiWhenCurrentBalanceFallsInUSD?: number = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProject,
+      Permission.UnAuthorizedSsoUser,
+      Permission.ProjectUser,
+    ],
+    update: [Permission.ProjectOwner, Permission.ManageProjectBilling],
+  })
+  @TableColumn({
+    required: true,
+    isDefaultValueColumn: true,
+    type: TableColumnType.Boolean,
+    title: "Enable AI",
+    description: "Enable AI services for this project.",
+    defaultValue: true,
+    example: true,
+  })
+  @Column({
+    nullable: false,
+    default: true,
+    type: ColumnType.Boolean,
+  })
+  public enableAi?: boolean = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProject,
+      Permission.UnAuthorizedSsoUser,
+      Permission.ProjectUser,
+    ],
+    update: [Permission.ProjectOwner, Permission.ManageProjectBilling],
+  })
+  @TableColumn({
+    required: true,
+    isDefaultValueColumn: true,
+    type: TableColumnType.Boolean,
+    title: "Enable auto recharge for AI balance",
+    description: "Enable auto recharge for AI balance for this project.",
+    defaultValue: false,
+    example: true,
+  })
+  @Column({
+    nullable: false,
+    default: false,
+    type: ColumnType.Boolean,
+  })
+  public enableAutoRechargeAiBalance?: boolean = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    required: true,
+    isDefaultValueColumn: true,
+    hideColumnInDocumentation: true,
+    type: TableColumnType.Boolean,
+    title: "Low AI Balance Notification Sent to Owners",
+    description: "Low AI Balance Notification Sent to Owners",
+    defaultValue: false,
+  })
+  @Column({
+    nullable: false,
+    default: false,
+    type: ColumnType.Boolean,
+  })
+  public lowAiBalanceNotificationSentToOwners?: boolean = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    required: true,
+    isDefaultValueColumn: true,
+    type: TableColumnType.Boolean,
+    hideColumnInDocumentation: true,
+    title: "Failed AI Balance Charge Notification Sent to Owners",
+    description: "Failed AI Balance Charge Notification Sent to Owners",
+    defaultValue: false,
+  })
+  @Column({
+    nullable: false,
+    default: false,
+    type: ColumnType.Boolean,
+  })
+  public failedAiBalanceChargeNotificationSentToOwners?: boolean = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    required: true,
+    isDefaultValueColumn: true,
+    hideColumnInDocumentation: true,
+    type: TableColumnType.Boolean,
+    title: "Not Enabled AI Notification Sent to Owners",
+    description: "Not Enabled AI Notification Sent to Owners",
+    defaultValue: false,
+  })
+  @Column({
+    nullable: false,
+    default: false,
+    type: ColumnType.Boolean,
+  })
+  public notEnabledAiNotificationSentToOwners?: boolean = undefined;
+
   @ColumnAccessControl({
     create: [Permission.User],
     read: [
@@ -1199,6 +1419,7 @@ export default class Project extends TenantModel {
     hideColumnInDocumentation: true,
     title: "Reseller ID",
     description: "ID of your OneUptime Reseller in which this object belongs",
+    example: "d4e5f6a7-b8c9-0123-def0-123456789abc",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -1373,6 +1594,7 @@ export default class Project extends TenantModel {
     description:
       "If enabled, global probes will NOT be automatically added to new monitors. Enable this only if you are using ONLY custom probes to monitor your resources.",
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/ProjectCallSMSConfig.ts

@@ -84,6 +84,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -120,6 +121,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -150,6 +152,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     required: true,
     type: TableColumnType.ShortText,
     canReadOnRelationQuery: true,
+    example: "Production Twilio Config",
   })
   @Column({
     nullable: false,
@@ -175,6 +178,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     type: TableColumnType.Slug,
     title: "Slug",
     description: "Friendly globally unique name for your object",
+    example: "production-twilio-config",
   })
   @Column({
     nullable: false,
@@ -206,6 +210,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example: "Twilio configuration for production SMS and call notifications",
   })
   @Column({
     nullable: true,
@@ -235,6 +240,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -269,6 +275,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -294,6 +301,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -325,6 +333,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -357,6 +366,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     type: TableColumnType.ShortText,
     title: "Twilio Account SID",
     description: "Account SID for your Twilio Account",
+    example: "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -388,6 +398,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     type: TableColumnType.ShortText,
     title: "Twilio Auth Token",
     description: "Auth Token for your Twilio Account",
+    example: "your-twilio-auth-token",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -419,6 +430,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     type: TableColumnType.Phone,
     title: "Twilio Primary Phone Number",
     description: "Primary Phone Number for your Twilio account",
+    example: "+15551234567",
   })
   @Column({
     type: ColumnType.Phone,
@@ -451,6 +463,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
     type: TableColumnType.LongText,
     title: "Twilio Secondary Phone Numbers",
     description: "Secondary Phone Number for your Twilio account",
+    example: "+15551234568,+15551234569",
   })
   @Column({
     type: ColumnType.LongText,