Merge pull request #1686 from openmeterio/feat/plan-api-typespec

feat: add Plan API to  typespec

api/spec/src/billing/invoices/invoice.tsp

@@ -1,12 +1,13 @@
 import "@typespec/http";
 import "@typespec/rest";
 import "@typespec/openapi3";
-import "../../ratecards.tsp";
 
 using TypeSpec.Http;
 using TypeSpec.Rest;
 using TypeSpec.OpenAPI;
 
+using OpenMeter.ProductCatalog;
+
 namespace Invoices;
 
 /**
@@ -282,7 +283,7 @@ model UnitPriceLine extends Line {
   type: LineTypes.unitPrice;
 
   @summary("Details about what is being sold.")
-  item: OpenMeter.RateCard;
+  item: RateCard;
 
   @summary("Quantity of the item being sold.")
   quantity: Numeric;

api/spec/src/billing/invoices/main.tsp

@@ -5,6 +5,7 @@ import "@typespec/openapi3";
 import "@typespec/versioning";
 
 import "../..";
+import "../../productcatalog";
 
 // Package Contents
 import "./invoice.tsp";

api/spec/src/cloud/main.tsp

@@ -175,3 +175,25 @@ namespace OpenMeterCloud.Billing {
   @tag("Billing (Experimental)")
   interface CustomerInvoiceEndpoints extends OpenMeter.Billing.CustomerInvoiceEndpoints {}
 }
+
+namespace OpenMeterCloud.ProductCatalog {
+  @route("/api/v1/plans")
+  @tag("Plan (Experimental)")
+  interface PlansById extends OpenMeter.ProductCatalog.Plans {}
+
+  @route("/api/v1/plans/{planId}/publish")
+  @tag("Plan (Experimental)")
+  interface PlanPublishById extends OpenMeter.ProductCatalog.PlanPublish {}
+
+  @route("/api/v1/plans/{planId}/unpublish")
+  @tag("Plan (Experimental)")
+  interface PlanUnpublishById extends OpenMeter.ProductCatalog.PlanUnpublish {}
+
+  @route("/api/v1/plans/{planId}/next")
+  @tag("Plan (Experimental)")
+  interface PlanNewDraftVersion extends OpenMeter.ProductCatalog.PlanNewDraftVersion {}
+
+  @route("/api/v1/plans/{planId}/phases")
+  @tag("Plan (Experimental)")
+  interface PlanByIdPhases extends OpenMeter.ProductCatalog.PlanPhases {}
+}

api/spec/src/main.tsp

@@ -19,6 +19,7 @@ import "./debug.tsp";
 import "./notification";
 import "./entitlements";
 import "./billing";
+import "./productcatalog";
 
 using TypeSpec.Http;
 using TypeSpec.Rest;

api/spec/src/productcatalog/discounts.tsp

@@ -0,0 +1,86 @@
+namespace OpenMeter.ProductCatalog;
+
+/**
+ * The type of the discount.
+ */
+@friendlyName("DiscountType")
+enum DiscountType {
+  percentage: "percentage",
+  amount: "amount",
+  usage: "usage",
+}
+
+/**
+ * A discount on a price.
+ * One of: percentage, amount, or usage.
+ */
+@discriminator("type")
+@friendlyName("Discount")
+union Discount {
+  @summary("Percentage discount")
+  percentage: DiscountPercentage,
+
+  // @summary("Amount discount")
+  // amount: DiscountAmount,
+
+  // @summary("Usage discount")
+  // usage: DiscountUsage,
+}
+
+/**
+ * Percentage discount.
+ */
+@friendlyName("DiscountPercentage")
+model DiscountPercentage {
+  /**
+   * The type of the discount.
+   */
+  @summary("Type")
+  type: DiscountType.percentage;
+
+  /**
+   * The percentage of the discount.
+   */
+  @summary("Percentage")
+  @minValue(0)
+  @maxValue(100)
+  percentage: float;
+}
+
+// NOTE(chrisgacsal): amount discount is going to be implemented in future releases
+// /**
+//  * Amount discount.
+//  */
+// @friendlyName("DiscountAmount")
+// model DiscountAmount {
+//   /**
+//    * The type of the discount.
+//    */
+//   @summary("Type")
+//   type: DiscountType.amount;
+
+//   /**
+//    * The amount of the discount.
+//    */
+//   @summary("Amount")
+//   amount: Money;
+// }
+
+// NOTE(chrisgacsal): usage discount is going to be implemented in future releases
+// /**
+//  * Usage discount.
+//  */
+// @friendlyName("UsageDiscount")
+// model DiscountUsage {
+//   /**
+//    * The type of the discount.
+//    */
+//   @summary("Type")
+//   type: DiscountType.usage;
+
+//   /**
+//    * The usage discount.
+//    */
+//   @summary("Usage")
+//   usage: float64;
+// }

api/spec/src/productcatalog/main.tsp

@@ -0,0 +1,14 @@
+import "@typespec/http";
+import "@typespec/openapi";
+import "@typespec/openapi3";
+
+import "..";
+
+// Package Contents
+import "./discounts.tsp";
+import "./plan.tsp";
+import "./prices.tsp";
+import "./ratecards.tsp";
+import "./routes.tsp";
+
+namespace OpenMeter.ProductCatalog;