@polar-sh/sdk 0.32.4 → 0.32.7

package/src/models/components/customermeter.ts

@@ -0,0 +1,161 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+import {
+  Customer,
+  Customer$inboundSchema,
+  Customer$Outbound,
+  Customer$outboundSchema,
+} from "./customer.js";
+import {
+  Meter,
+  Meter$inboundSchema,
+  Meter$Outbound,
+  Meter$outboundSchema,
+} from "./meter.js";
+
+/**
+ * An active customer meter, with current consumed and credited units.
+ */
+export type CustomerMeter = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * The ID of the customer.
+   */
+  customerId: string;
+  /**
+   * The ID of the meter.
+   */
+  meterId: string;
+  /**
+   * The number of consumed units.
+   */
+  consumedUnits: number;
+  /**
+   * The number of credited units.
+   */
+  creditedUnits: number;
+  /**
+   * The balance of the meter, i.e. the difference between credited and consumed units. Never goes negative.
+   */
+  balance: number;
+  /**
+   * A customer in an organization.
+   */
+  customer: Customer;
+  meter: Meter;
+};
+
+/** @internal */
+export const CustomerMeter$inboundSchema: z.ZodType<
+  CustomerMeter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  modified_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  customer_id: z.string(),
+  meter_id: z.string(),
+  consumed_units: z.number(),
+  credited_units: z.number().int(),
+  balance: z.number(),
+  customer: Customer$inboundSchema,
+  meter: Meter$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "modified_at": "modifiedAt",
+    "customer_id": "customerId",
+    "meter_id": "meterId",
+    "consumed_units": "consumedUnits",
+    "credited_units": "creditedUnits",
+  });
+});
+
+/** @internal */
+export type CustomerMeter$Outbound = {
+  id: string;
+  created_at: string;
+  modified_at: string | null;
+  customer_id: string;
+  meter_id: string;
+  consumed_units: number;
+  credited_units: number;
+  balance: number;
+  customer: Customer$Outbound;
+  meter: Meter$Outbound;
+};
+
+/** @internal */
+export const CustomerMeter$outboundSchema: z.ZodType<
+  CustomerMeter$Outbound,
+  z.ZodTypeDef,
+  CustomerMeter
+> = z.object({
+  id: z.string(),
+  createdAt: z.date().transform(v => v.toISOString()),
+  modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  customerId: z.string(),
+  meterId: z.string(),
+  consumedUnits: z.number(),
+  creditedUnits: z.number().int(),
+  balance: z.number(),
+  customer: Customer$outboundSchema,
+  meter: Meter$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    modifiedAt: "modified_at",
+    customerId: "customer_id",
+    meterId: "meter_id",
+    consumedUnits: "consumed_units",
+    creditedUnits: "credited_units",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerMeter$ {
+  /** @deprecated use `CustomerMeter$inboundSchema` instead. */
+  export const inboundSchema = CustomerMeter$inboundSchema;
+  /** @deprecated use `CustomerMeter$outboundSchema` instead. */
+  export const outboundSchema = CustomerMeter$outboundSchema;
+  /** @deprecated use `CustomerMeter$Outbound` instead. */
+  export type Outbound = CustomerMeter$Outbound;
+}
+
+export function customerMeterToJSON(customerMeter: CustomerMeter): string {
+  return JSON.stringify(CustomerMeter$outboundSchema.parse(customerMeter));
+}
+
+export function customerMeterFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerMeter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerMeter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerMeter' from JSON`,
+  );
+}

package/src/models/components/customermetersortproperty.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const CustomerMeterSortProperty = {
+  CreatedAt: "created_at",
+  MinusCreatedAt: "-created_at",
+  ModifiedAt: "modified_at",
+  MinusModifiedAt: "-modified_at",
+  CustomerId: "customer_id",
+  MinusCustomerId: "-customer_id",
+  CustomerName: "customer_name",
+  MinusCustomerName: "-customer_name",
+  MeterId: "meter_id",
+  MinusMeterId: "-meter_id",
+  MeterName: "meter_name",
+  MinusMeterName: "-meter_name",
+  ConsumedUnits: "consumed_units",
+  MinusConsumedUnits: "-consumed_units",
+  CreditedUnits: "credited_units",
+  MinusCreditedUnits: "-credited_units",
+  Balance: "balance",
+  MinusBalance: "-balance",
+} as const;
+export type CustomerMeterSortProperty = ClosedEnum<
+  typeof CustomerMeterSortProperty
+>;
+
+/** @internal */
+export const CustomerMeterSortProperty$inboundSchema: z.ZodNativeEnum<
+  typeof CustomerMeterSortProperty
+> = z.nativeEnum(CustomerMeterSortProperty);
+
+/** @internal */
+export const CustomerMeterSortProperty$outboundSchema: z.ZodNativeEnum<
+  typeof CustomerMeterSortProperty
+> = CustomerMeterSortProperty$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerMeterSortProperty$ {
+  /** @deprecated use `CustomerMeterSortProperty$inboundSchema` instead. */
+  export const inboundSchema = CustomerMeterSortProperty$inboundSchema;
+  /** @deprecated use `CustomerMeterSortProperty$outboundSchema` instead. */
+  export const outboundSchema = CustomerMeterSortProperty$outboundSchema;
+}

package/src/models/components/customerstate.ts

@@ -19,6 +19,12 @@ import {
   CustomerStateBenefitGrant$Outbound,
   CustomerStateBenefitGrant$outboundSchema,
 } from "./customerstatebenefitgrant.js";
+import {
+  CustomerStateMeter,
+  CustomerStateMeter$inboundSchema,
+  CustomerStateMeter$Outbound,
+  CustomerStateMeter$outboundSchema,
+} from "./customerstatemeter.js";
 import {
   CustomerStateSubscription,
   CustomerStateSubscription$inboundSchema,
@@ -41,7 +47,8 @@ export type CustomerStateTaxId = string | TaxIDFormat;
  * @remarks
  *
  * * Active subscriptions
- * * Active benefits
+ * * Granted benefits
+ * * Active meters
  */
 export type CustomerState = {
   /**
@@ -91,6 +98,10 @@ export type CustomerState = {
    * The customer's active benefit grants.
    */
   grantedBenefits: Array<CustomerStateBenefitGrant>;
+  /**
+   * The customer's active meters.
+   */
+  activeMeters: Array<CustomerStateMeter>;
   avatarUrl: string;
 };
 
@@ -216,6 +227,7 @@ export const CustomerState$inboundSchema: z.ZodType<
   ),
   active_subscriptions: z.array(CustomerStateSubscription$inboundSchema),
   granted_benefits: z.array(CustomerStateBenefitGrant$inboundSchema),
+  active_meters: z.array(CustomerStateMeter$inboundSchema),
   avatar_url: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -229,6 +241,7 @@ export const CustomerState$inboundSchema: z.ZodType<
     "deleted_at": "deletedAt",
     "active_subscriptions": "activeSubscriptions",
     "granted_benefits": "grantedBenefits",
+    "active_meters": "activeMeters",
     "avatar_url": "avatarUrl",
   });
 });
@@ -249,6 +262,7 @@ export type CustomerState$Outbound = {
   deleted_at: string | null;
   active_subscriptions: Array<CustomerStateSubscription$Outbound>;
   granted_benefits: Array<CustomerStateBenefitGrant$Outbound>;
+  active_meters: Array<CustomerStateMeter$Outbound>;
   avatar_url: string;
 };
 
@@ -274,6 +288,7 @@ export const CustomerState$outboundSchema: z.ZodType<
   deletedAt: z.nullable(z.date().transform(v => v.toISOString())),
   activeSubscriptions: z.array(CustomerStateSubscription$outboundSchema),
   grantedBenefits: z.array(CustomerStateBenefitGrant$outboundSchema),
+  activeMeters: z.array(CustomerStateMeter$outboundSchema),
   avatarUrl: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -287,6 +302,7 @@ export const CustomerState$outboundSchema: z.ZodType<
     deletedAt: "deleted_at",
     activeSubscriptions: "active_subscriptions",
     grantedBenefits: "granted_benefits",
+    activeMeters: "active_meters",
     avatarUrl: "avatar_url",
   });
 });

package/src/models/components/customerstatemeter.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+/**
+ * An active meter for a customer, with latest consumed and credited units.
+ */
+export type CustomerStateMeter = {
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * The ID of the meter.
+   */
+  meterId: string;
+  /**
+   * The number of consumed units.
+   */
+  consumedUnits: number;
+  /**
+   * The number of credited units.
+   */
+  creditedUnits: number;
+  /**
+   * The balance of the meter, i.e. the difference between credited and consumed units. Never goes negative.
+   */
+  balance: number;
+};
+
+/** @internal */
+export const CustomerStateMeter$inboundSchema: z.ZodType<
+  CustomerStateMeter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  modified_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  meter_id: z.string(),
+  consumed_units: z.number(),
+  credited_units: z.number().int(),
+  balance: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "modified_at": "modifiedAt",
+    "meter_id": "meterId",
+    "consumed_units": "consumedUnits",
+    "credited_units": "creditedUnits",
+  });
+});
+
+/** @internal */
+export type CustomerStateMeter$Outbound = {
+  created_at: string;
+  modified_at: string | null;
+  meter_id: string;
+  consumed_units: number;
+  credited_units: number;
+  balance: number;
+};
+
+/** @internal */
+export const CustomerStateMeter$outboundSchema: z.ZodType<
+  CustomerStateMeter$Outbound,
+  z.ZodTypeDef,
+  CustomerStateMeter
+> = z.object({
+  createdAt: z.date().transform(v => v.toISOString()),
+  modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  meterId: z.string(),
+  consumedUnits: z.number(),
+  creditedUnits: z.number().int(),
+  balance: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    modifiedAt: "modified_at",
+    meterId: "meter_id",
+    consumedUnits: "consumed_units",
+    creditedUnits: "credited_units",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerStateMeter$ {
+  /** @deprecated use `CustomerStateMeter$inboundSchema` instead. */
+  export const inboundSchema = CustomerStateMeter$inboundSchema;
+  /** @deprecated use `CustomerStateMeter$outboundSchema` instead. */
+  export const outboundSchema = CustomerStateMeter$outboundSchema;
+  /** @deprecated use `CustomerStateMeter$Outbound` instead. */
+  export type Outbound = CustomerStateMeter$Outbound;
+}
+
+export function customerStateMeterToJSON(
+  customerStateMeter: CustomerStateMeter,
+): string {
+  return JSON.stringify(
+    CustomerStateMeter$outboundSchema.parse(customerStateMeter),
+  );
+}
+
+export function customerStateMeterFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerStateMeter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerStateMeter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerStateMeter' from JSON`,
+  );
+}

package/src/models/components/eventname.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+export type EventName = {
+  /**
+   * The name of the event.
+   */
+  name: string;
+  /**
+   * Number of times the event has occurred.
+   */
+  occurrences: number;
+  /**
+   * The first time the event occurred.
+   */
+  firstSeen: Date;
+  /**
+   * The last time the event occurred.
+   */
+  lastSeen: Date;
+};
+
+/** @internal */
+export const EventName$inboundSchema: z.ZodType<
+  EventName,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  occurrences: z.number().int(),
+  first_seen: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  last_seen: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "first_seen": "firstSeen",
+    "last_seen": "lastSeen",
+  });
+});
+
+/** @internal */
+export type EventName$Outbound = {
+  name: string;
+  occurrences: number;
+  first_seen: string;
+  last_seen: string;
+};
+
+/** @internal */
+export const EventName$outboundSchema: z.ZodType<
+  EventName$Outbound,
+  z.ZodTypeDef,
+  EventName
+> = z.object({
+  name: z.string(),
+  occurrences: z.number().int(),
+  firstSeen: z.date().transform(v => v.toISOString()),
+  lastSeen: z.date().transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    firstSeen: "first_seen",
+    lastSeen: "last_seen",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EventName$ {
+  /** @deprecated use `EventName$inboundSchema` instead. */
+  export const inboundSchema = EventName$inboundSchema;
+  /** @deprecated use `EventName$outboundSchema` instead. */
+  export const outboundSchema = EventName$outboundSchema;
+  /** @deprecated use `EventName$Outbound` instead. */
+  export type Outbound = EventName$Outbound;
+}
+
+export function eventNameToJSON(eventName: EventName): string {
+  return JSON.stringify(EventName$outboundSchema.parse(eventName));
+}
+
+export function eventNameFromJSON(
+  jsonString: string,
+): SafeParseResult<EventName, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventName$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventName' from JSON`,
+  );
+}

package/src/models/components/eventnamessortproperty.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const EventNamesSortProperty = {
+  Name: "name",
+  MinusName: "-name",
+  Occurrences: "occurrences",
+  MinusOccurrences: "-occurrences",
+  FirstSeen: "first_seen",
+  MinusFirstSeen: "-first_seen",
+  LastSeen: "last_seen",
+  MinusLastSeen: "-last_seen",
+} as const;
+export type EventNamesSortProperty = ClosedEnum<typeof EventNamesSortProperty>;
+
+/** @internal */
+export const EventNamesSortProperty$inboundSchema: z.ZodNativeEnum<
+  typeof EventNamesSortProperty
+> = z.nativeEnum(EventNamesSortProperty);
+
+/** @internal */
+export const EventNamesSortProperty$outboundSchema: z.ZodNativeEnum<
+  typeof EventNamesSortProperty
+> = EventNamesSortProperty$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EventNamesSortProperty$ {
+  /** @deprecated use `EventNamesSortProperty$inboundSchema` instead. */
+  export const inboundSchema = EventNamesSortProperty$inboundSchema;
+  /** @deprecated use `EventNamesSortProperty$outboundSchema` instead. */
+  export const outboundSchema = EventNamesSortProperty$outboundSchema;
+}

package/src/models/components/listresourcecustomercustomermeter.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomerCustomerMeter,
+  CustomerCustomerMeter$inboundSchema,
+  CustomerCustomerMeter$Outbound,
+  CustomerCustomerMeter$outboundSchema,
+} from "./customercustomermeter.js";
+import {
+  Pagination,
+  Pagination$inboundSchema,
+  Pagination$Outbound,
+  Pagination$outboundSchema,
+} from "./pagination.js";
+
+export type ListResourceCustomerCustomerMeter = {
+  items: Array<CustomerCustomerMeter>;
+  pagination: Pagination;
+};
+
+/** @internal */
+export const ListResourceCustomerCustomerMeter$inboundSchema: z.ZodType<
+  ListResourceCustomerCustomerMeter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(CustomerCustomerMeter$inboundSchema),
+  pagination: Pagination$inboundSchema,
+});
+
+/** @internal */
+export type ListResourceCustomerCustomerMeter$Outbound = {
+  items: Array<CustomerCustomerMeter$Outbound>;
+  pagination: Pagination$Outbound;
+};
+
+/** @internal */
+export const ListResourceCustomerCustomerMeter$outboundSchema: z.ZodType<
+  ListResourceCustomerCustomerMeter$Outbound,
+  z.ZodTypeDef,
+  ListResourceCustomerCustomerMeter
+> = z.object({
+  items: z.array(CustomerCustomerMeter$outboundSchema),
+  pagination: Pagination$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListResourceCustomerCustomerMeter$ {
+  /** @deprecated use `ListResourceCustomerCustomerMeter$inboundSchema` instead. */
+  export const inboundSchema = ListResourceCustomerCustomerMeter$inboundSchema;
+  /** @deprecated use `ListResourceCustomerCustomerMeter$outboundSchema` instead. */
+  export const outboundSchema =
+    ListResourceCustomerCustomerMeter$outboundSchema;
+  /** @deprecated use `ListResourceCustomerCustomerMeter$Outbound` instead. */
+  export type Outbound = ListResourceCustomerCustomerMeter$Outbound;
+}
+
+export function listResourceCustomerCustomerMeterToJSON(
+  listResourceCustomerCustomerMeter: ListResourceCustomerCustomerMeter,
+): string {
+  return JSON.stringify(
+    ListResourceCustomerCustomerMeter$outboundSchema.parse(
+      listResourceCustomerCustomerMeter,
+    ),
+  );
+}
+
+export function listResourceCustomerCustomerMeterFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResourceCustomerCustomerMeter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResourceCustomerCustomerMeter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResourceCustomerCustomerMeter' from JSON`,
+  );
+}