@openmeter/sdk 1.0.0-beta-57d3f3ffb1f9 → 1.0.0-beta-8a61dd435b87

package/dist/cjs/src/client/schemas.d.cts

@@ -8889,7 +8889,11 @@ export interface components {
             message?: string;
         };
         /**
-         * @description A subject is a unique identifier for a user or entity.
+         * @description A subject is a unique identifier for a usage attribution by its key.
+         *     Subjects only exist in the concept of metering.
+         *     Subjects are optional to create and work as an enrichment for the subject key like displayName, metadata, etc.
+         *     Subjects are useful when you are reporting usage events with your own database ID but want to enrich the subject with a human-readable name or metadata.
+         *     For most use cases, a subject is equivalent to a customer.
          * @example {
          *       "id": "01G65Z755AFWAKHE12NY0CQ9FH",
          *       "key": "customer-id",
@@ -8897,8 +8901,6 @@ export interface components {
          *       "metadata": {
          *         "hubspotId": "123456"
          *       },
-         *       "currentPeriodStart": "2023-01-01T00:00:00Z",
-         *       "currentPeriodEnd": "2023-02-01T00:00:00Z",
          *       "stripeCustomerId": "cus_JMOlctsKV8"
          *     }
          */
@@ -8910,7 +8912,8 @@ export interface components {
             readonly id: string;
             /**
              * @description A unique, human-readable identifier for the subject.
-             * @example customer-id
+             *     This is typically a database ID or a customer key.
+             * @example customer-db-id-123
              */
             key: string;
             /**
@@ -8918,25 +8921,34 @@ export interface components {
              * @example Customer Name
              */
             displayName?: string | null;
-            /** @example {
+            /**
+             * @description Metadata for the subject.
+             * @example {
              *       "hubspotId": "123456"
-             *     } */
+             *     }
+             */
             metadata?: {
-                [key: string]: unknown;
+                [key: string]: string;
             } | null;
             /**
              * Format: date-time
-             * @description [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
+             * @deprecated
+             * @description The start of the current period for the subject.
              * @example 2023-01-01T00:00:00Z
              */
             currentPeriodStart?: Date;
             /**
              * Format: date-time
-             * @description [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
+             * @deprecated
+             * @description The end of the current period for the subject.
              * @example 2023-02-01T00:00:00Z
              */
             currentPeriodEnd?: Date;
-            /** @example cus_JMOlctsKV8 */
+            /**
+             * @deprecated
+             * @description The Stripe customer ID for the subject.
+             * @example cus_JMOlctsKV8
+             */
             stripeCustomerId?: string | null;
         };
         /**
@@ -8947,15 +8959,14 @@ export interface components {
          *       "metadata": {
          *         "hubspotId": "123456"
          *       },
-         *       "currentPeriodStart": "2023-01-01T00:00:00Z",
-         *       "currentPeriodEnd": "2023-02-01T00:00:00Z",
          *       "stripeCustomerId": "cus_JMOlctsKV8"
          *     }
          */
         SubjectUpsert: {
             /**
              * @description A unique, human-readable identifier for the subject.
-             * @example customer-id
+             *     This is typically a database ID or a customer key.
+             * @example customer-db-id-123
              */
             key: string;
             /**
@@ -8963,25 +8974,34 @@ export interface components {
              * @example Customer Name
              */
             displayName?: string | null;
-            /** @example {
+            /**
+             * @description Metadata for the subject.
+             * @example {
              *       "hubspotId": "123456"
-             *     } */
+             *     }
+             */
             metadata?: {
-                [key: string]: unknown;
+                [key: string]: string;
             } | null;
             /**
              * Format: date-time
-             * @description [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
+             * @deprecated
+             * @description The start of the current period for the subject.
              * @example 2023-01-01T00:00:00Z
              */
             currentPeriodStart?: Date;
             /**
              * Format: date-time
-             * @description [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
+             * @deprecated
+             * @description The end of the current period for the subject.
              * @example 2023-02-01T00:00:00Z
              */
             currentPeriodEnd?: Date;
-            /** @example cus_JMOlctsKV8 */
+            /**
+             * @deprecated
+             * @description The Stripe customer ID for the subject.
+             * @example cus_JMOlctsKV8
+             */
             stripeCustomerId?: string | null;
         };
         /** @description Subscription is an exact subscription instance. */

package/dist/cjs/src/client/subjects.d.cts

@@ -21,7 +21,7 @@ export declare class Subjects {
         key: string;
         displayName?: string | null;
         metadata?: {
-            [key: string]: unknown;
+            [key: string]: string;
         } | null;
         currentPeriodStart?: Date;
         currentPeriodEnd?: Date;
@@ -38,7 +38,7 @@ export declare class Subjects {
         key: string;
         displayName?: string | null;
         metadata?: {
-            [key: string]: unknown;
+            [key: string]: string;
         } | null;
         currentPeriodStart?: Date;
         currentPeriodEnd?: Date;
@@ -54,7 +54,7 @@ export declare class Subjects {
         key: string;
         displayName?: string | null;
         metadata?: {
-            [key: string]: unknown;
+            [key: string]: string;
         } | null;
         currentPeriodStart?: Date;
         currentPeriodEnd?: Date;

package/dist/cjs/src/zod/index.cjs

@@ -8727,20 +8727,26 @@ exports.upsertSubjectBodyItem = zod_1.z
     currentPeriodEnd: zod_1.z
         .date()
         .optional()
-        .describe('[RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.'),
+        .describe('The end of the current period for the subject.'),
     currentPeriodStart: zod_1.z
         .date()
         .optional()
-        .describe('[RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.'),
+        .describe('The start of the current period for the subject.'),
     displayName: zod_1.z
         .string()
         .nullish()
         .describe('A human-readable display name for the subject.'),
     key: zod_1.z
         .string()
-        .describe('A unique, human-readable identifier for the subject.'),
-    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).nullish(),
-    stripeCustomerId: zod_1.z.string().nullish(),
+        .describe('A unique, human-readable identifier for the subject.\nThis is typically a database ID or a customer key.'),
+    metadata: zod_1.z
+        .record(zod_1.z.string(), zod_1.z.string())
+        .nullish()
+        .describe('Metadata for the subject.'),
+    stripeCustomerId: zod_1.z
+        .string()
+        .nullish()
+        .describe('The Stripe customer ID for the subject.'),
 })
     .describe('A subject is a unique identifier for a user or entity.');
 exports.upsertSubjectBody = zod_1.z.array(exports.upsertSubjectBodyItem);

package/dist/cjs/src/zod/index.d.cts

@@ -14128,18 +14128,18 @@ export declare const upsertSubjectBodyItem: zod.ZodObject<{
     currentPeriodStart: zod.ZodOptional<zod.ZodDate>;
     displayName: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
     key: zod.ZodString;
-    metadata: zod.ZodOptional<zod.ZodNullable<zod.ZodRecord<zod.ZodString, zod.ZodAny>>>;
+    metadata: zod.ZodOptional<zod.ZodNullable<zod.ZodRecord<zod.ZodString, zod.ZodString>>>;
     stripeCustomerId: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
 }, "strip", zod.ZodTypeAny, {
     key: string;
-    metadata?: Record<string, any> | null | undefined;
+    metadata?: Record<string, string> | null | undefined;
     stripeCustomerId?: string | null | undefined;
     currentPeriodEnd?: Date | undefined;
     currentPeriodStart?: Date | undefined;
     displayName?: string | null | undefined;
 }, {
     key: string;
-    metadata?: Record<string, any> | null | undefined;
+    metadata?: Record<string, string> | null | undefined;
     stripeCustomerId?: string | null | undefined;
     currentPeriodEnd?: Date | undefined;
     currentPeriodStart?: Date | undefined;
@@ -14150,18 +14150,18 @@ export declare const upsertSubjectBody: zod.ZodArray<zod.ZodObject<{
     currentPeriodStart: zod.ZodOptional<zod.ZodDate>;
     displayName: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
     key: zod.ZodString;
-    metadata: zod.ZodOptional<zod.ZodNullable<zod.ZodRecord<zod.ZodString, zod.ZodAny>>>;
+    metadata: zod.ZodOptional<zod.ZodNullable<zod.ZodRecord<zod.ZodString, zod.ZodString>>>;
     stripeCustomerId: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
 }, "strip", zod.ZodTypeAny, {
     key: string;
-    metadata?: Record<string, any> | null | undefined;
+    metadata?: Record<string, string> | null | undefined;
     stripeCustomerId?: string | null | undefined;
     currentPeriodEnd?: Date | undefined;
     currentPeriodStart?: Date | undefined;
     displayName?: string | null | undefined;
 }, {
     key: string;
-    metadata?: Record<string, any> | null | undefined;
+    metadata?: Record<string, string> | null | undefined;
     stripeCustomerId?: string | null | undefined;
     currentPeriodEnd?: Date | undefined;
     currentPeriodStart?: Date | undefined;