fix(api): move subjects back to OpenMeter

Signed-off-by: Mark Sagi-Kazar <[email protected]>

Author: sagikazarmark

api/spec/src/cloud/subjects.tsp

@@ -16,14 +16,14 @@ interface Subjects {
    */
   @get
   @operationId("listSubjects")
-  list(): Subject[] | OpenMeter.CommonErrors;
+  list(): OpenMeter.Subject[] | OpenMeter.CommonErrors;
 
   /**
    * Get subject by ID or key.
    */
   @get
   @operationId("getSubject")
-  get(@path subjectIdOrKey: string): Subject | OpenMeter.NotFoundError | OpenMeter.CommonErrors;
+  get(@path subjectIdOrKey: string): OpenMeter.Subject | OpenMeter.NotFoundError | OpenMeter.CommonErrors;
 
   /**
    * Upserts a subject. Creates or updates subject.
@@ -33,7 +33,7 @@ interface Subjects {
    */
   @post
   @operationId("upsertSubject")
-  upsert(@body subject: Subject[]): Subject[] | OpenMeter.CommonErrors;
+  upsert(@body subject: OpenMeter.Subject[]): OpenMeter.Subject[] | OpenMeter.CommonErrors;
 
   /**
    * Delete subject by ID or key.
@@ -42,53 +42,3 @@ interface Subjects {
   @operationId("deleteSubject")
   delete(@path subjectIdOrKey: string): void | OpenMeter.CommonErrors;
 }
-
-/**
- * A subject is a unique identifier for a user or entity.
- */
-@friendlyName("Subject")
-@example(#{
-  id: "01G65Z755AFWAKHE12NY0CQ9FH",
-  key: "customer-id",
-  displayName: "Customer Name",
-  metadata: #{ hubspotId: "123456" },
-  currentPeriodStart: DateTime.fromISO("2023-01-01T00:00:00Z"),
-  currentPeriodEnd: DateTime.fromISO("2023-02-01T00:00:00Z"),
-  stripeCustomerId: "cus_JMOlctsKV8",
-})
-model Subject {
-  // Validator doesn't obey required for readOnly properties
-  // See: https://github.com/stoplightio/spectral/issues/1274
-
-  /**
-   * A unique identifier for the subject.
-   */
-  @visibility("read")
-  @example("01G65Z755AFWAKHE12NY0CQ9FH")
-  id: ULID;
-
-  /**
-   * A unique, human-readable identifier for the subject.
-   * Must consist only alphanumeric and underscore characters.
-   */
-  @example("customer-id")
-  key: Key;
-
-  /**
-   * A human-readable display name for the subject.
-   */
-  @example("Customer Name")
-  displayName?: string;
-
-  @example(#{ hubspotId: "123456" })
-  metadata?: Record<string>;
-
-  @example(DateTime.fromISO("2023-01-01T00:00:00Z"))
-  currentPeriodStart?: DateTime;
-
-  @example(DateTime.fromISO("2023-02-01T00:00:00Z"))
-  currentPeriodEnd?: DateTime;
-
-  @example("cus_JMOlctsKV8")
-  stripeCustomerId?: string;
-}

api/spec/src/main.tsp

@@ -13,6 +13,7 @@ import "./customer.tsp";
 import "./events.tsp";
 import "./meters.tsp";
 import "./portal.tsp";
+import "./subjects.tsp";
 import "./debug.tsp";
 import "./notification";
 import "./entitlements";

api/spec/src/notification/event.tsp

@@ -108,7 +108,7 @@ model EventBalanceThresholdPayloadData {
 
   @visibility("read")
   @summary("Subject")
-  subject: Subject;
+  subject: OpenMeter.Subject;
 
   @visibility("read")
   @summary("Entitlement Value")
@@ -119,12 +119,6 @@ model EventBalanceThresholdPayloadData {
   threshold: RuleBalanceThresholdValue;
 }
 
-/**
- * FIXME: move subject api to OpenMeter so Subject model is avaiable here.
- */
-@friendlyName("DummySubject")
-model Subject {}
-
 /**
  * Type of the notification event.
  */

api/spec/src/subjects.tsp

@@ -0,0 +1,59 @@
+import "@typespec/http";
+import "@typespec/rest";
+import "@typespec/openapi3";
+
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using TypeSpec.OpenAPI;
+
+namespace OpenMeter;
+
+/**
+ * A subject is a unique identifier for a user or entity.
+ */
+@friendlyName("Subject")
+@example(#{
+  id: "01G65Z755AFWAKHE12NY0CQ9FH",
+  key: "customer-id",
+  displayName: "Customer Name",
+  metadata: #{ hubspotId: "123456" },
+  currentPeriodStart: DateTime.fromISO("2023-01-01T00:00:00Z"),
+  currentPeriodEnd: DateTime.fromISO("2023-02-01T00:00:00Z"),
+  stripeCustomerId: "cus_JMOlctsKV8",
+})
+model Subject {
+  // Validator doesn't obey required for readOnly properties
+  // See: https://github.com/stoplightio/spectral/issues/1274
+
+  /**
+   * A unique identifier for the subject.
+   */
+  @visibility("read")
+  @example("01G65Z755AFWAKHE12NY0CQ9FH")
+  id: ULID;
+
+  /**
+   * A unique, human-readable identifier for the subject.
+   * Must consist only alphanumeric and underscore characters.
+   */
+  @example("customer-id")
+  key: Key;
+
+  /**
+   * A human-readable display name for the subject.
+   */
+  @example("Customer Name")
+  displayName?: string;
+
+  @example(#{ hubspotId: "123456" })
+  metadata?: Record<string>;
+
+  @example(DateTime.fromISO("2023-01-01T00:00:00Z"))
+  currentPeriodStart?: DateTime;
+
+  @example(DateTime.fromISO("2023-02-01T00:00:00Z"))
+  currentPeriodEnd?: DateTime;
+
+  @example("cus_JMOlctsKV8")
+  stripeCustomerId?: string;
+}