@oneuptime/common 8.0.5183 → 8.0.5199

package/Models/DatabaseModels/Project.ts

@@ -1292,6 +1292,30 @@ export default class Project extends TenantModel {
   })
   public letCustomerSupportAccessProject?: boolean = undefined;
 
+  // This is an internal field. This is used for internal analytics for example: Metabase.
+  // Values can be between 0 and 100.
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    required: true,
+    type: TableColumnType.Number,
+    isDefaultValueColumn: true,
+    hideColumnInDocumentation: true,
+    title: "Discount Percent",
+    description: "Discount percentage applied to the project billing",
+    defaultValue: 0,
+  })
+  @Column({
+    type: ColumnType.Number,
+    nullable: false,
+    unique: false,
+    default: 0,
+  })
+  public discountPercent?: number = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [

package/Server/API/BillingAPI.ts

@@ -0,0 +1,123 @@
+import { IsBillingEnabled } from "../EnvironmentConfig";
+import UserMiddleware from "../Middleware/UserAuthorization";
+import BillingService from "../Services/BillingService";
+import ProjectService from "../Services/ProjectService";
+import Express, {
+  ExpressRequest,
+  ExpressResponse,
+  ExpressRouter,
+  NextFunction,
+  OneUptimeRequest,
+} from "../Utils/Express";
+import Response from "../Utils/Response";
+import BadDataException from "../../Types/Exception/BadDataException";
+import Permission, { UserPermission } from "../../Types/Permission";
+import Project from "../../Models/DatabaseModels/Project";
+import CommonAPI from "./CommonAPI";
+import ObjectID from "../../Types/ObjectID";
+import DatabaseCommonInteractionProps from "../../Types/BaseDatabase/DatabaseCommonInteractionProps";
+
+export default class BillingAPI {
+  public router: ExpressRouter;
+
+  public constructor() {
+    this.router = Express.getRouter();
+
+    this.router.get(
+      `/billing/customer-balance`,
+      UserMiddleware.getUserMiddleware,
+      async (req: ExpressRequest, res: ExpressResponse, next: NextFunction) => {
+        try {
+          if (!IsBillingEnabled) {
+            throw new BadDataException(
+              "Billing is not enabled for this server",
+            );
+          }
+
+          const userPermissions: Array<UserPermission> = (
+            await this.getPermissionsForTenant(req)
+          ).filter((permission: UserPermission) => {
+            return (
+              permission.permission.toString() ===
+                Permission.ProjectOwner.toString() ||
+              permission.permission.toString() ===
+                Permission.ManageProjectBilling.toString()
+            );
+          });
+
+          if (
+            userPermissions.length === 0 &&
+            !(req as OneUptimeRequest).userAuthorization?.isMasterAdmin
+          ) {
+            throw new BadDataException(
+              `You need ${Permission.ProjectOwner} or ${Permission.ManageProjectBilling} permission to view billing balance.`,
+            );
+          }
+
+          const project: Project | null = await ProjectService.findOneById({
+            id: this.getTenantId(req)!,
+            props: {
+              isRoot: true,
+            },
+            select: {
+              _id: true,
+              paymentProviderCustomerId: true,
+            },
+          });
+
+          if (!project) {
+            throw new BadDataException("Project not found");
+          }
+
+          if (!project.paymentProviderCustomerId) {
+            throw new BadDataException("Payment Provider customer not found");
+          }
+
+          const balance: number = await BillingService.getCustomerBalance(
+            project.paymentProviderCustomerId,
+          );
+
+          return Response.sendJsonObjectResponse(req, res, {
+            balance: balance,
+          });
+        } catch (err) {
+          next(err);
+        }
+      },
+    );
+  }
+
+  public async getPermissionsForTenant(
+    req: ExpressRequest,
+  ): Promise<Array<UserPermission>> {
+    const permissions: Array<UserPermission> = [];
+
+    const props: DatabaseCommonInteractionProps =
+      await CommonAPI.getDatabaseCommonInteractionProps(req);
+
+    if (
+      props &&
+      props.userTenantAccessPermission &&
+      props.userTenantAccessPermission[props.tenantId?.toString() || ""]
+    ) {
+      return (
+        props.userTenantAccessPermission[props.tenantId?.toString() || ""]
+          ?.permissions || []
+      );
+    }
+
+    return permissions;
+  }
+
+  public getTenantId(req: ExpressRequest): ObjectID | null {
+    if ((req as OneUptimeRequest).tenantId) {
+      return (req as OneUptimeRequest).tenantId as ObjectID;
+    }
+
+    return null;
+  }
+
+  public getRouter(): ExpressRouter {
+    return this.router;
+  }
+}

package/Server/API/SlackAPI.ts

@@ -157,13 +157,13 @@ export default class SlackAPI {
         // send the request to slack api to get the access token https://slack.com/api/oauth.v2.access
 
         const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-          await API.post(
-            URL.fromString("https://slack.com/api/oauth.v2.access"),
-            requestBody,
-            {
+          await API.post({
+            url: URL.fromString("https://slack.com/api/oauth.v2.access"),
+            data: requestBody,
+            headers: {
               "Content-Type": "application/x-www-form-urlencoded",
             },
-          );
+          });
 
         if (response instanceof HTTPErrorResponse) {
           throw response;
@@ -369,13 +369,13 @@ export default class SlackAPI {
         // send the request to slack api to get the access token https://slack.com/api/oauth.v2.access
 
         const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-          await API.post(
-            URL.fromString("https://slack.com/api/openid.connect.token"),
-            requestBody,
-            {
+          await API.post({
+            url: URL.fromString("https://slack.com/api/openid.connect.token"),
+            data: requestBody,
+            headers: {
               "Content-Type": "application/x-www-form-urlencoded",
             },
-          );
+          });
 
         if (response instanceof HTTPErrorResponse) {
           throw response;

package/Server/API/StatusPageAPI.ts

@@ -1100,7 +1100,7 @@ export default class StatusPageAPI extends BaseAPI<
                 },
                 select: select,
                 sort: {
-                  createdAt: SortOrder.Ascending,
+                  createdAt: SortOrder.Descending,
                 },
 
                 skip: 0,

package/Server/Infrastructure/ClickhouseDatabase.ts

@@ -122,7 +122,9 @@ export default class ClickhouseDatabase {
       }
 
       const result: HTTPErrorResponse | HTTPResponse<JSONObject> =
-        await API.get(URL.fromString(dbUrl.toString()));
+        await API.get({
+          url: URL.fromString(dbUrl.toString()),
+        });
 
       logger.debug("Clickhouse Connection Status Result");
       logger.debug(result);

package/Server/Infrastructure/Postgres/SchemaMigrations/1758313975491-MigrationName.ts

@@ -0,0 +1,17 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class MigrationName1758313975491 implements MigrationInterface {
+  public name = "MigrationName1758313975491";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "Project" ADD "discountPercent" integer NOT NULL DEFAULT '0'`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "Project" DROP COLUMN "discountPercent"`,
+    );
+  }
+}

package/Server/Infrastructure/Postgres/SchemaMigrations/Index.ts

@@ -167,6 +167,7 @@ import { MigrationName1756300358095 } from "./1756300358095-MigrationName";
 import { MigrationName1756821449686 } from "./1756821449686-MigrationName";
 import { MigrationName1757416939595 } from "./1757416939595-MigrationName";
 import { MigrationName1757423505855 } from "./1757423505855-MigrationName";
+import { MigrationName1758313975491 } from "./1758313975491-MigrationName";
 
 export default [
   InitialMigration,
@@ -338,4 +339,5 @@ export default [
   MigrationName1756821449686,
   MigrationName1757416939595,
   MigrationName1757423505855,
+  MigrationName1758313975491,
 ];

package/Server/Services/AnalyticsDatabaseService.ts

@@ -1122,8 +1122,8 @@ export default class AnalyticsDatabaseService<
     triggerType: DatabaseTriggerType
   ): Promise<void> {
     if (this.getModel().enableWorkflowOn) {
-      API.post(
-        new URL(
+      API.post({
+        url: new URL(
           Protocol.HTTP,
           WorkflowHostname,
           new Route(
@@ -1132,15 +1132,13 @@ export default class AnalyticsDatabaseService<
             )}/${triggerType}`
           )
         ),
-        {
-          data: {
-            _id: id.toString(),
-          },
+        data: {
+          _id: id.toString(),
         },
-        {
+        headers: {
           ...ClusterKeyAuthorization.getClusterKeyHeaders(),
-        }
-      ).catch((error: Error) => {
+        },
+      }).catch((error: Error) => {
         logger.error(error);
       });
     }

package/Server/Services/BillingService.ts

@@ -763,6 +763,23 @@ export class BillingService extends BaseService {
     return setupIntent.client_secret;
   }
 
+  @CaptureSpan()
+  public async getCustomerBalance(customerId: string): Promise<number> {
+    if (!this.isBillingEnabled()) {
+      throw new BadDataException(Errors.BillingService.BILLING_NOT_ENABLED);
+    }
+
+    const customer: Stripe.Response<Stripe.Customer | Stripe.DeletedCustomer> =
+      await this.stripe.customers.retrieve(customerId);
+
+    if (!customer || customer.deleted) {
+      throw new BadDataException(Errors.BillingService.CUSTOMER_NOT_FOUND);
+    }
+
+    // Balance is in cents, convert to dollars
+    return ((customer as Stripe.Customer).balance || 0) / 100;
+  }
+
   @CaptureSpan()
   public async cancelSubscription(subscriptionId: string): Promise<void> {
     if (!this.isBillingEnabled()) {

package/Server/Services/CallService.ts

@@ -70,17 +70,17 @@ export class CallService extends BaseService {
       onCallScheduleId: options.onCallScheduleId?.toString(),
     };
 
-    return await API.post<EmptyResponseData>(
-      new URL(
+    return await API.post<EmptyResponseData>({
+      url: new URL(
         Protocol.HTTP,
         AppApiHostname,
         new Route("/api/notification/call/make-call"),
       ),
-      body,
-      {
+      data: body,
+      headers: {
         ...ClusterKeyAuthorization.getClusterKeyHeaders(),
       },
-    );
+    });
   }
 }
 

package/Server/Services/DatabaseService.ts

@@ -617,8 +617,8 @@ class DatabaseService<TBaseModel extends BaseModel> extends BaseService {
     miscData?: JSONObject | undefined, // miscData is used for passing data to workflow.
   ): Promise<void> {
     if (this.getModel().enableWorkflowOn) {
-      API.post(
-        new URL(
+      API.post({
+        url: new URL(
           Protocol.HTTP,
           WorkflowHostname,
           new Route(
@@ -627,16 +627,16 @@ class DatabaseService<TBaseModel extends BaseModel> extends BaseService {
             )}/${triggerType}`,
           ),
         ),
-        {
+        data: {
           data: {
             _id: id.toString(),
             miscData: miscData,
           },
         },
-        {
+        headers: {
           ...ClusterKeyAuthorization.getClusterKeyHeaders(),
         },
-      ).catch((error: Error) => {
+      }).catch((error: Error) => {
         logger.error(error);
       });
     }

package/Server/Services/MailService.ts

@@ -108,17 +108,17 @@ export class MailService extends BaseService {
       body["teamId"] = options.teamId.toString();
     }
 
-    return await API.post<EmptyResponseData>(
-      new URL(
+    return await API.post<EmptyResponseData>({
+      url: new URL(
         Protocol.HTTP,
         AppApiHostname,
         new Route("/api/notification/email/send"),
       ),
-      body,
-      {
+      data: body,
+      headers: {
         ...ClusterKeyAuthorization.getClusterKeyHeaders(),
       },
-    );
+    });
   }
 }
 

package/Server/Services/SmsService.ts

@@ -71,17 +71,17 @@ export class SmsService extends BaseService {
       teamId: options.teamId?.toString(),
     };
 
-    return await API.post<EmptyResponseData>(
-      new URL(
+    return await API.post<EmptyResponseData>({
+      url: new URL(
         Protocol.HTTP,
         AppApiHostname,
         new Route("/api/notification/sms/send"),
       ),
-      body,
-      {
+      data: body,
+      headers: {
         ...ClusterKeyAuthorization.getClusterKeyHeaders(),
       },
-    );
+    });
   }
 }
 

package/Server/Services/StatusPageCertificateService.ts

@@ -23,10 +23,14 @@ export class StatusPageCertificateService extends BaseService {
 
     const httpProtocol: Protocol = await DatabaseConfig.getHttpProtocol();
 
-    return await API.post<EmptyResponseData>(
-      new URL(httpProtocol, AppApiHostname, new Route("/api/workers/cert")),
-      body,
-    );
+    return await API.post<EmptyResponseData>({
+      url: new URL(
+        httpProtocol,
+        AppApiHostname,
+        new Route("/api/workers/cert"),
+      ),
+      data: body,
+    });
   }
 
   @CaptureSpan()
@@ -39,10 +43,14 @@ export class StatusPageCertificateService extends BaseService {
       domain: domain,
     };
 
-    return await API.delete<EmptyResponseData>(
-      new URL(httpProtocol, AppApiHostname, new Route("/api/workers/cert")),
-      body,
-    );
+    return await API.delete<EmptyResponseData>({
+      url: new URL(
+        httpProtocol,
+        AppApiHostname,
+        new Route("/api/workers/cert"),
+      ),
+      data: body,
+    });
   }
 
   @CaptureSpan()
@@ -53,10 +61,14 @@ export class StatusPageCertificateService extends BaseService {
 
     const httpProtocol: Protocol = await DatabaseConfig.getHttpProtocol();
 
-    return await API.get<JSONObject>(
-      new URL(httpProtocol, AppApiHostname, new Route("/api/workers/cert")),
-      body,
-    );
+    return await API.get<JSONObject>({
+      url: new URL(
+        httpProtocol,
+        AppApiHostname,
+        new Route("/api/workers/cert"),
+      ),
+      data: body,
+    });
   }
 }
 

package/Server/Services/StatusPageDomainService.ts

@@ -222,14 +222,14 @@ export class Service extends DatabaseService<StatusPageDomain> {
   ): Promise<boolean> {
     try {
       const result: HTTPErrorResponse | HTTPResponse<JSONObject> =
-        await API.get(
-          URL.fromString(
+        await API.get({
+          url: URL.fromString(
             "https://" +
               fulldomain +
               "/status-page-api/cname-verification/" +
               token,
           ),
-        );
+        });
 
       if (result.isFailure()) {
         return false;
@@ -306,14 +306,14 @@ export class Service extends DatabaseService<StatusPageDomain> {
 
       try {
         const result: HTTPErrorResponse | HTTPResponse<JSONObject> =
-          await API.get(
-            URL.fromString(
+          await API.get({
+            url: URL.fromString(
               "http://" +
                 fullDomain +
                 "/status-page-api/cname-verification/" +
                 token,
             ),
-          );
+          });
 
         logger.debug("CNAME verification result");
         logger.debug(result);
@@ -335,14 +335,14 @@ export class Service extends DatabaseService<StatusPageDomain> {
 
       try {
         const resultHttps: HTTPErrorResponse | HTTPResponse<JSONObject> =
-          await API.get(
-            URL.fromString(
+          await API.get({
+            url: URL.fromString(
               "https://" +
                 fullDomain +
                 "/status-page-api/cname-verification/" +
                 token,
             ),
-          );
+          });
 
         logger.debug("CNAME verification result for https");
         logger.debug(resultHttps);

package/Server/Services/WorkflowService.ts

@@ -68,17 +68,17 @@ export class Service extends DatabaseService<Model> {
 
     logger.debug("Updating workflow on the workflow service");
 
-    await API.post<EmptyResponseData>(
-      new URL(
+    await API.post<EmptyResponseData>({
+      url: new URL(
         Protocol.HTTP,
         WorkflowHostname,
         new Route("/workflow/update/" + onUpdate.updateBy.query._id!),
       ),
-      {},
-      {
+      data: {},
+      headers: {
         ...ClusterKeyAuthorization.getClusterKeyHeaders(),
       },
-    );
+    });
 
     logger.debug("Updated workflow on the workflow service");
 

package/Server/Types/Workflow/Components/API/Delete.ts

@@ -42,11 +42,11 @@ export default class ApiDelete extends ComponentCode {
     let apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null = null;
 
     try {
-      apiResult = await API.delete(
-        args["url"] as URL,
-        args["request-body"] as JSONObject,
-        args["request-headers"] as Dictionary<string>,
-      );
+      apiResult = await API.delete({
+        url: args["url"] as URL,
+        data: args["request-body"] as JSONObject,
+        headers: args["request-headers"] as Dictionary<string>,
+      });
 
       return Promise.resolve({
         returnValues: ApiComponentUtils.getReturnValues(apiResult),

package/Server/Types/Workflow/Components/API/Get.ts

@@ -42,11 +42,11 @@ export default class ApiGet extends ComponentCode {
     let apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null = null;
 
     try {
-      apiResult = await API.get(
-        args["url"] as URL,
-        args["request-body"] as JSONObject,
-        args["request-headers"] as Dictionary<string>,
-      );
+      apiResult = await API.get({
+        url: args["url"] as URL,
+        data: args["request-body"] as JSONObject,
+        headers: args["request-headers"] as Dictionary<string>,
+      });
 
       return Promise.resolve({
         returnValues: ApiComponentUtils.getReturnValues(apiResult),

package/Server/Types/Workflow/Components/API/Patch.ts

@@ -42,11 +42,11 @@ export default class ApiPut extends ComponentCode {
     let apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null = null;
 
     try {
-      apiResult = await API.patch(
-        args["url"] as URL,
-        args["request-body"] as JSONObject,
-        args["request-headers"] as Dictionary<string>,
-      );
+      apiResult = await API.patch({
+        url: args["url"] as URL,
+        data: args["request-body"] as JSONObject,
+        headers: args["request-headers"] as Dictionary<string>,
+      });
 
       return Promise.resolve({
         returnValues: ApiComponentUtils.getReturnValues(apiResult),

package/Server/Types/Workflow/Components/API/Post.ts

@@ -62,11 +62,11 @@ export default class ApiPost extends ComponentCode {
     logger.debug(`Request Headers: ${JSON.stringify(requestHeaders)}`);
 
     try {
-      apiResult = await API.post(
-        args["url"] as URL,
-        args["request-body"] as JSONObject,
-        args["request-headers"] as Dictionary<string>,
-      );
+      apiResult = await API.post({
+        url: args["url"] as URL,
+        data: args["request-body"] as JSONObject,
+        headers: args["request-headers"] as Dictionary<string>,
+      });
 
       logger.debug("API Post Component is done.");
 

package/Server/Types/Workflow/Components/API/Put.ts

@@ -42,11 +42,11 @@ export default class ApiPut extends ComponentCode {
     let apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null = null;
 
     try {
-      apiResult = await API.put(
-        args["url"] as URL,
-        args["request-body"] as JSONObject,
-        args["request-headers"] as Dictionary<string>,
-      );
+      apiResult = await API.put({
+        url: args["url"] as URL,
+        data: args["request-body"] as JSONObject,
+        headers: args["request-headers"] as Dictionary<string>,
+      });
 
       return Promise.resolve({
         returnValues: ApiComponentUtils.getReturnValues(apiResult),