@polar-sh/sdk 0.46.7 → 0.47.1

package/src/models/components/meter.ts

@@ -25,6 +25,11 @@ import {
   MetadataOutputType$Outbound,
   MetadataOutputType$outboundSchema,
 } from "./metadataoutputtype.js";
+import {
+  MeterUnit,
+  MeterUnit$inboundSchema,
+  MeterUnit$outboundSchema,
+} from "./meterunit.js";
 import {
   PropertyAggregation,
   PropertyAggregation$inboundSchema,
@@ -67,6 +72,15 @@ export type Meter = {
    * The name of the meter. Will be shown on customer's invoices and usage.
    */
   name: string;
+  unit: MeterUnit;
+  /**
+   * The label for the custom unit.
+   */
+  customLabel?: string | null | undefined;
+  /**
+   * The multiplier to convert from base unit to display scale.
+   */
+  customMultiplier?: number | null | undefined;
   filter: Filter;
   /**
    * The aggregation to apply on the filtered events to calculate the meter.
@@ -176,6 +190,9 @@ export const Meter$inboundSchema: z.ZodMiniType<Meter, unknown> = z.pipe(
     ),
     id: z.string(),
     name: z.string(),
+    unit: MeterUnit$inboundSchema,
+    custom_label: z.optional(z.nullable(z.string())),
+    custom_multiplier: z.optional(z.nullable(z.int())),
     filter: Filter$inboundSchema,
     aggregation: z.union([
       z.intersection(
@@ -209,6 +226,8 @@ export const Meter$inboundSchema: z.ZodMiniType<Meter, unknown> = z.pipe(
     return remap$(v, {
       "created_at": "createdAt",
       "modified_at": "modifiedAt",
+      "custom_label": "customLabel",
+      "custom_multiplier": "customMultiplier",
       "organization_id": "organizationId",
       "archived_at": "archivedAt",
     });
@@ -221,6 +240,9 @@ export type Meter$Outbound = {
   modified_at: string | null;
   id: string;
   name: string;
+  unit: string;
+  custom_label?: string | null | undefined;
+  custom_multiplier?: number | null | undefined;
   filter: Filter$Outbound;
   aggregation:
     | (PropertyAggregation$Outbound & { func: "avg" })
@@ -244,6 +266,9 @@ export const Meter$outboundSchema: z.ZodMiniType<Meter$Outbound, Meter> = z
       ),
       id: z.string(),
       name: z.string(),
+      unit: MeterUnit$outboundSchema,
+      customLabel: z.optional(z.nullable(z.string())),
+      customMultiplier: z.optional(z.nullable(z.int())),
       filter: Filter$outboundSchema,
       aggregation: z.union([
         z.intersection(
@@ -274,6 +299,8 @@ export const Meter$outboundSchema: z.ZodMiniType<Meter$Outbound, Meter> = z
       return remap$(v, {
         createdAt: "created_at",
         modifiedAt: "modified_at",
+        customLabel: "custom_label",
+        customMultiplier: "custom_multiplier",
         organizationId: "organization_id",
         archivedAt: "archived_at",
       });

package/src/models/components/metercreate.ts

@@ -11,6 +11,7 @@ import {
   CountAggregation$outboundSchema,
 } from "./countaggregation.js";
 import { Filter, Filter$Outbound, Filter$outboundSchema } from "./filter.js";
+import { MeterUnit, MeterUnit$outboundSchema } from "./meterunit.js";
 import {
   PropertyAggregation,
   PropertyAggregation$Outbound,
@@ -56,6 +57,15 @@ export type MeterCreate = {
    * The name of the meter. Will be shown on customer's invoices and usage.
    */
   name: string;
+  unit?: MeterUnit | undefined;
+  /**
+   * The label for the custom unit, e.g. 'request'. Required when unit is 'custom'.
+   */
+  customLabel?: string | null | undefined;
+  /**
+   * The multiplier to convert from the base unit to display scale, e.g. 1000 to display per 1000 units. Defaults to 1 when not provided.
+   */
+  customMultiplier?: number | null | undefined;
   filter: Filter;
   /**
    * The aggregation to apply on the filtered events to calculate the meter.
@@ -136,6 +146,9 @@ export function meterCreateAggregationToJSON(
 export type MeterCreate$Outbound = {
   metadata?: { [k: string]: string | number | number | boolean } | undefined;
   name: string;
+  unit?: string | undefined;
+  custom_label?: string | null | undefined;
+  custom_multiplier?: number | null | undefined;
   filter: Filter$Outbound;
   aggregation:
     | (PropertyAggregation$Outbound & { func: "avg" })
@@ -160,6 +173,9 @@ export const MeterCreate$outboundSchema: z.ZodMiniType<
       ),
     ),
     name: z.string(),
+    unit: z.optional(MeterUnit$outboundSchema),
+    customLabel: z.optional(z.nullable(z.string())),
+    customMultiplier: z.optional(z.nullable(z.int())),
     filter: Filter$outboundSchema,
     aggregation: z.union([
       z.intersection(
@@ -185,6 +201,8 @@ export const MeterCreate$outboundSchema: z.ZodMiniType<
   }),
   z.transform((v) => {
     return remap$(v, {
+      customLabel: "custom_label",
+      customMultiplier: "custom_multiplier",
       organizationId: "organization_id",
     });
   }),

package/src/models/components/meterunit.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const MeterUnit = {
+  Scalar: "scalar",
+  Token: "token",
+  Custom: "custom",
+} as const;
+export type MeterUnit = OpenEnum<typeof MeterUnit>;
+
+/** @internal */
+export const MeterUnit$inboundSchema: z.ZodMiniType<MeterUnit, unknown> =
+  openEnums.inboundSchema(MeterUnit);
+/** @internal */
+export const MeterUnit$outboundSchema: z.ZodMiniType<string, MeterUnit> =
+  openEnums.outboundSchema(MeterUnit);

package/src/models/components/meterupdate.ts

@@ -11,6 +11,7 @@ import {
   CountAggregation$outboundSchema,
 } from "./countaggregation.js";
 import { Filter, Filter$Outbound, Filter$outboundSchema } from "./filter.js";
+import { MeterUnit, MeterUnit$outboundSchema } from "./meterunit.js";
 import {
   PropertyAggregation,
   PropertyAggregation$Outbound,
@@ -53,6 +54,18 @@ export type MeterUpdate = {
    * The name of the meter. Will be shown on customer's invoices and usage.
    */
   name?: string | null | undefined;
+  /**
+   * The unit of the meter.
+   */
+  unit?: MeterUnit | null | undefined;
+  /**
+   * The label for the custom unit. Required when unit is 'custom'.
+   */
+  customLabel?: string | null | undefined;
+  /**
+   * The multiplier to convert from base unit to display scale. Required when unit is 'custom'.
+   */
+  customMultiplier?: number | null | undefined;
   /**
    * The filter to apply on events that'll be used to calculate the meter.
    */
@@ -134,6 +147,9 @@ export function aggregationToJSON(aggregation: Aggregation): string {
 export type MeterUpdate$Outbound = {
   metadata?: { [k: string]: string | number | number | boolean } | undefined;
   name?: string | null | undefined;
+  unit?: string | null | undefined;
+  custom_label?: string | null | undefined;
+  custom_multiplier?: number | null | undefined;
   filter?: Filter$Outbound | null | undefined;
   aggregation?:
     | (PropertyAggregation$Outbound & { func: "avg" })
@@ -160,6 +176,9 @@ export const MeterUpdate$outboundSchema: z.ZodMiniType<
       ),
     ),
     name: z.optional(z.nullable(z.string())),
+    unit: z.optional(z.nullable(MeterUnit$outboundSchema)),
+    customLabel: z.optional(z.nullable(z.string())),
+    customMultiplier: z.optional(z.nullable(z.int())),
     filter: z.optional(z.nullable(Filter$outboundSchema)),
     aggregation: z.optional(
       z.nullable(
@@ -189,6 +208,8 @@ export const MeterUpdate$outboundSchema: z.ZodMiniType<
   }),
   z.transform((v) => {
     return remap$(v, {
+      customLabel: "custom_label",
+      customMultiplier: "custom_multiplier",
       isArchived: "is_archived",
     });
   }),

package/src/models/components/metricdashboardcreate.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Schema for creating a metrics dashboard.
+ */
+export type MetricDashboardCreate = {
+  /**
+   * Display name for the dashboard.
+   */
+  name: string;
+  /**
+   * List of metric slugs to display in this dashboard.
+   */
+  metrics?: Array<string> | undefined;
+  /**
+   * The ID of the organization owning this dashboard. **Required unless you use an organization token.**
+   */
+  organizationId?: string | null | undefined;
+};
+
+/** @internal */
+export type MetricDashboardCreate$Outbound = {
+  name: string;
+  metrics?: Array<string> | undefined;
+  organization_id?: string | null | undefined;
+};
+
+/** @internal */
+export const MetricDashboardCreate$outboundSchema: z.ZodMiniType<
+  MetricDashboardCreate$Outbound,
+  MetricDashboardCreate
+> = z.pipe(
+  z.object({
+    name: z.string(),
+    metrics: z.optional(z.array(z.string())),
+    organizationId: z.optional(z.nullable(z.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      organizationId: "organization_id",
+    });
+  }),
+);
+
+export function metricDashboardCreateToJSON(
+  metricDashboardCreate: MetricDashboardCreate,
+): string {
+  return JSON.stringify(
+    MetricDashboardCreate$outboundSchema.parse(metricDashboardCreate),
+  );
+}

package/src/models/components/metricdashboardschema.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * A user-defined metrics dashboard.
+ */
+export type MetricDashboardSchema = {
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * Display name for the dashboard.
+   */
+  name: string;
+  /**
+   * List of metric slugs displayed in this dashboard.
+   */
+  metrics: Array<string>;
+  /**
+   * The ID of the organization owning this dashboard.
+   */
+  organizationId: string;
+};
+
+/** @internal */
+export const MetricDashboardSchema$inboundSchema: z.ZodMiniType<
+  MetricDashboardSchema,
+  unknown
+> = z.pipe(
+  z.object({
+    created_at: z.pipe(
+      z.iso.datetime({ offset: true }),
+      z.transform(v => new Date(v)),
+    ),
+    modified_at: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
+    id: z.string(),
+    name: z.string(),
+    metrics: z.array(z.string()),
+    organization_id: z.string(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "modified_at": "modifiedAt",
+      "organization_id": "organizationId",
+    });
+  }),
+);
+
+export function metricDashboardSchemaFromJSON(
+  jsonString: string,
+): SafeParseResult<MetricDashboardSchema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetricDashboardSchema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetricDashboardSchema' from JSON`,
+  );
+}

package/src/models/components/metricdashboardupdate.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+/**
+ * Schema for updating a metrics dashboard.
+ */
+export type MetricDashboardUpdate = {
+  /**
+   * Display name for the dashboard.
+   */
+  name?: string | null | undefined;
+  /**
+   * List of metric slugs to display in this dashboard.
+   */
+  metrics?: Array<string> | null | undefined;
+};
+
+/** @internal */
+export type MetricDashboardUpdate$Outbound = {
+  name?: string | null | undefined;
+  metrics?: Array<string> | null | undefined;
+};
+
+/** @internal */
+export const MetricDashboardUpdate$outboundSchema: z.ZodMiniType<
+  MetricDashboardUpdate$Outbound,
+  MetricDashboardUpdate
+> = z.object({
+  name: z.optional(z.nullable(z.string())),
+  metrics: z.optional(z.nullable(z.array(z.string()))),
+});
+
+export function metricDashboardUpdateToJSON(
+  metricDashboardUpdate: MetricDashboardUpdate,
+): string {
+  return JSON.stringify(
+    MetricDashboardUpdate$outboundSchema.parse(metricDashboardUpdate),
+  );
+}