feat(api): add event subject list endpoint

Author: tothandras

api/spec/packages/aip-client-javascript/README.md

@@ -113,10 +113,11 @@ The full call path, HTTP route, and a short description are listed below.
 
 ### Events
 
-| Method                 | HTTP                     | Description                                                                  |
-| ---------------------- | ------------------------ | ---------------------------------------------------------------------------- |
-| `client.events.list`   | `GET /openmeter/events`  | List ingested events.                                                        |
-| `client.events.ingest` | `POST /openmeter/events` | Ingests an event or batch of events following the CloudEvents specification. |
+| Method                       | HTTP                             | Description                                                                           |
+| ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------- |
+| `client.events.list`         | `GET /openmeter/events`          | List ingested events.                                                                 |
+| `client.events.ingest`       | `POST /openmeter/events`         | Ingests an event or batch of events following the CloudEvents specification.          |
+| `client.events.listSubjects` | `GET /openmeter/events/subjects` | List the subjects of the ingested events. Subjects are ordered by key alphabetically. |
 
 ### Meters
 

api/spec/packages/aip-client-javascript/src/funcs/events.ts

@@ -7,6 +7,8 @@ import type {
   ListMeteringEventsResponse,
   IngestMeteringEventsRequest,
   IngestMeteringEventsResponse,
+  ListEventSubjectsRequest,
+  ListEventSubjectsResponse,
 } from '../models/operations/events.js'
 
 export function listMeteringEvents(
@@ -35,3 +37,19 @@ export function ingestMeteringEvents(
     await http(client).post('openmeter/events', { ...options, json: req })
   })
 }
+
+export function listEventSubjects(
+  client: Client,
+  req: ListEventSubjectsRequest = {},
+  options?: RequestOptions,
+): Promise<Result<ListEventSubjectsResponse>> {
+  const searchParams = toURLSearchParams({
+    page: req.page,
+    filter: req.filter,
+  })
+  return request(() =>
+    http(client)
+      .get('openmeter/events/subjects', { ...options, searchParams })
+      .json<ListEventSubjectsResponse>(),
+  )
+}

api/spec/packages/aip-client-javascript/src/index.ts

@@ -138,6 +138,7 @@ export type {
   Internal,
   NotImplemented,
   NotAvailable,
+  ListSubjectsParamsFilter,
   CreateCreditGrantFilters,
   CreditGrantFilters,
   UpsertPlanAddonRequest,
@@ -146,7 +147,6 @@ export type {
   Meter,
   PaginatedMeta,
   QueryFilterStringMapItem,
-  SubscriptionCreate,
   CustomerKeyReference,
   CustomerUsageAttribution,
   BillingAddress,
@@ -165,6 +165,7 @@ export type {
   GetCreditBalanceParamsFilter,
   ListChargesParamsFilter,
   ListPlansParamsFilter,
+  SubscriptionCreate,
   RateCardProrationConfiguration,
   Subscription,
   AppCatalogItem,
@@ -193,6 +194,7 @@ export type {
   ListSubscriptionsParamsFilter,
   ListFeatureParamsFilter,
   ListAddonsParamsFilter,
+  EventSubject,
   CreateCreditGrantTaxConfig,
   CreditGrantTaxConfig,
   TaxConfig,
@@ -239,6 +241,7 @@ export type {
   PriceGraduated,
   PriceVolume,
   PricePagePaginatedResponse,
+  SubjectPaginatedResponse,
   CreateCreditGrantRequest,
   CreditGrant,
   WorkflowTaxSettings,
@@ -303,10 +306,15 @@ export type {
   AppStripeCreateCheckoutSessionTaxIdCollectionInput,
   CreateCreditGrantPurchaseInput,
   CreditGrantPurchaseInput,
+  SubscriptionCreateInput,
+  SubscriptionInput,
   GovernanceQueryRequestInput,
   UnitConfigInput,
   IngestedEventInput,
+  SubscriptionPagePaginatedResponseInput,
+  SubscriptionChangeResponseInput,
   SubscriptionCancelInput,
+  SubscriptionChangeInput,
   InvoiceUsageQuantityDetailInput,
   CreateCreditGrantRequestInput,
   CreditGrantInput,

api/spec/packages/aip-client-javascript/src/models/operations/events.ts

@@ -5,7 +5,9 @@ import type {
   EventInput,
   IngestedEventPaginatedResponse,
   ListEventsParamsFilter,
+  ListSubjectsParamsFilter,
   SortQueryInput,
+  SubjectPaginatedResponse,
 } from '../types.js'
 
 export interface ListMeteringEventsQuery {
@@ -21,3 +23,12 @@ export type ListMeteringEventsResponse = IngestedEventPaginatedResponse
 
 export type IngestMeteringEventsRequest = EventInput | EventInput[]
 export type IngestMeteringEventsResponse = void
+
+export interface ListEventSubjectsQuery {
+  page?: CursorPaginationQueryPage
+  /** Filter subjects returned in the response. To filter subjects by key add the following query param: filter[key][contains]=customer */
+  filter?: ListSubjectsParamsFilter
+}
+
+export type ListEventSubjectsRequest = ListEventSubjectsQuery
+export type ListEventSubjectsResponse = SubjectPaginatedResponse

api/spec/packages/aip-client-javascript/src/models/operations/subscriptions.ts

@@ -7,13 +7,13 @@ import type {
   SubscriptionAddon,
   SubscriptionAddonPagePaginatedResponse,
   SubscriptionCancelInput,
-  SubscriptionChange,
+  SubscriptionChangeInput,
   SubscriptionChangeResponse,
-  SubscriptionCreate,
+  SubscriptionCreateInput,
   SubscriptionPagePaginatedResponse,
 } from '../types.js'
 
-export type CreateSubscriptionRequest = SubscriptionCreate
+export type CreateSubscriptionRequest = SubscriptionCreateInput
 export type CreateSubscriptionResponse = Subscription
 
 export interface ListSubscriptionsQuery {
@@ -46,7 +46,7 @@ export type UnscheduleCancelationResponse = Subscription
 
 export type ChangeSubscriptionRequest = {
   subscriptionId: string
-  body: SubscriptionChange
+  body: SubscriptionChangeInput
 }
 export type ChangeSubscriptionResponse = SubscriptionChangeResponse
 

api/spec/packages/aip-client-javascript/src/models/schemas.ts

@@ -253,6 +253,17 @@ export const baseError = z
   )
   .describe('Standard error response.')
 
+export const booleanFieldFilter = z
+  .union([
+    z.boolean(),
+    z.object({
+      eq: z
+        .boolean()
+        .describe('Value strictly equals the given boolean value.'),
+    }),
+  ])
+  .describe('Filter by a boolean value (true/false).')
+
 export const resourceKey = z
   .string()
   .min(1)
@@ -1025,17 +1036,6 @@ export const publicLabels = z
     'Public labels store information about an entity that can be used for filtering a list of objects.',
   )
 
-export const booleanFieldFilter = z
-  .union([
-    z.boolean(),
-    z.object({
-      eq: z
-        .boolean()
-        .describe('Value strictly equals the given boolean value.'),
-    }),
-  ])
-  .describe('Filter by a boolean value (true/false).')
-
 export const numericFieldFilter = z
   .union([
     z.number(),
@@ -1907,6 +1907,13 @@ export const notImplemented = baseError.describe('Not Implemented.')
 
 export const notAvailable = baseError.describe('Not Available.')
 
+export const listSubjectsParamsFilter = z
+  .object({
+    key: stringFieldFilter.optional(),
+    attributed: booleanFieldFilter.optional(),
+  })
+  .describe('Filter options for listing subjects.')
+
 export const createCreditGrantFilters = z
   .object({
     features: z
@@ -2132,33 +2139,6 @@ export const queryFilterStringMapItem = z
     'A query filter for an item in a string map attribute. Operators are mutually exclusive, only one operator is allowed at a time.',
   )
 
-export const subscriptionCreate = z
-  .object({
-    labels: labels.optional(),
-    customer: z
-      .object({
-        id: ulid.optional(),
-        key: externalResourceKey.optional(),
-      })
-      .describe('The customer to create the subscription for.'),
-    plan: z
-      .object({
-        id: ulid.optional(),
-        key: resourceKey.optional(),
-        version: z
-          .number()
-          .int()
-          .optional()
-
-          .describe(
-            'The plan version of the subscription, if any. If not provided, the latest version of the plan will be used.',
-          ),
-      })
-      .describe('The plan reference of the subscription.'),
-    billing_anchor: dateTime.optional(),
-  })
-  .describe('Subscription create request.')
-
 export const ulidOrExternalResourceKey = z
   .union([ulid, externalResourceKey])
   .describe('ULID ID or External Resource Key.')
@@ -2415,6 +2395,34 @@ export const listPlansParamsFilter = z
   })
   .describe('Filter options for listing plans.')
 
+export const subscriptionCreate = z
+  .object({
+    labels: labels.optional(),
+    settlement_mode: settlementMode.optional().default('credit_then_invoice'),
+    customer: z
+      .object({
+        id: ulid.optional(),
+        key: externalResourceKey.optional(),
+      })
+      .describe('The customer to create the subscription for.'),
+    plan: z
+      .object({
+        id: ulid.optional(),
+        key: resourceKey.optional(),
+        version: z
+          .number()
+          .int()
+          .optional()
+
+          .describe(
+            'The plan version of the subscription, if any. If not provided, the latest version of the plan will be used.',
+          ),
+      })
+      .describe('The plan reference of the subscription.'),
+    billing_anchor: dateTime.optional(),
+  })
+  .describe('Subscription create request.')
+
 export const rateCardProrationConfiguration = z
   .object({
     mode: rateCardProrationMode,
@@ -2432,6 +2440,7 @@ export const subscription = z
     plan_id: ulid.optional(),
     billing_anchor: dateTime,
     status: subscriptionStatus,
+    settlement_mode: settlementMode.optional().default('credit_then_invoice'),
   })
   .describe('Subscription.')
 
@@ -2865,6 +2874,13 @@ export const listAddonsParamsFilter = z
   })
   .describe('Filter options for listing add-ons.')
 
+export const eventSubject = z
+  .object({
+    key: z.string().min(1).describe('The key of the subject.'),
+    customer: customerReference.optional(),
+  })
+  .describe('Subject of an event.')
+
 export const createCreditGrantTaxConfig = z
   .object({
     behavior: taxBehavior.optional(),
@@ -3296,6 +3312,7 @@ export const subscriptionCancel = z
 export const subscriptionChange = z
   .object({
     labels: labels.optional(),
+    settlement_mode: settlementMode.optional().default('credit_then_invoice'),
     customer: z
       .object({
         id: ulid.optional(),
@@ -3615,6 +3632,13 @@ export const pricePagePaginatedResponse = z
   })
   .describe('Page paginated response.')
 
+export const subjectPaginatedResponse = z
+  .object({
+    data: z.array(eventSubject),
+    meta: cursorMeta,
+  })
+  .describe('Cursor paginated response.')
+
 export const createCreditGrantRequest = z
   .object({
     name: z
@@ -4454,6 +4478,7 @@ export const plan = z
       .describe(
         'The plan phases define the pricing ramp for a subscription. A phase switch occurs only at the end of a billing period. At least one phase is required.',
       ),
+    settlement_mode: settlementMode.optional().default('credit_then_invoice'),
     validation_errors: z
       .array(productCatalogValidationError)
       .optional()
@@ -4563,6 +4588,16 @@ export const listMeteringEventsResponse = z.object({
 
 export const ingestMeteringEventsBody = event
 
+export const listEventSubjectsQueryParams = z.object({
+  page: cursorPaginationQueryPage.optional(),
+  filter: listSubjectsParamsFilter.optional(),
+})
+
+export const listEventSubjectsResponse = z.object({
+  data: z.array(eventSubject),
+  meta: cursorMeta,
+})
+
 export const createMeterBody = createMeterRequest
 
 export const createMeterResponse = meter