@polar-sh/sdk 0.46.7 → 0.47.1

package/src/models/components/metricperiod.ts

@@ -15,8 +15,12 @@ export type CommittedSubscriptions = number | number;
 
 export type MonthlyRecurringRevenue = number | number;
 
+export type TrialMonthlyRecurringRevenue = number | number;
+
 export type CommittedMonthlyRecurringRevenue = number | number;
 
+export type TrialCommittedMonthlyRecurringRevenue = number | number;
+
 export type AverageRevenuePerUser = number | number;
 
 export type Checkouts = number | number;
@@ -27,6 +31,18 @@ export type ChurnedSubscriptions = number | number;
 
 export type ChurnRate = number | number;
 
+export type SeatsTotal = number | number;
+
+export type SeatsClaimed = number | number;
+
+export type SeatsPending = number | number;
+
+export type SeatCustomers = number | number;
+
+export type NewSeatCustomers = number | number;
+
+export type ChurnedSeatCustomers = number | number;
+
 export type Orders = number | number;
 
 export type Revenue = number | number;
@@ -85,6 +101,10 @@ export type CanceledSubscriptionsUnused = number | number;
 
 export type CanceledSubscriptionsOther = number | number;
 
+export type AnnualRecurringRevenue = number | number;
+
+export type CommittedAnnualRecurringRevenue = number | number;
+
 export type CheckoutsConversion = number | number;
 
 export type Ltv = number | number;
@@ -95,6 +115,10 @@ export type GrossMarginPercentage = number | number;
 
 export type Cashflow = number | number;
 
+export type AverageSeatsPerCustomer = number | number;
+
+export type SeatUtilizationRate = number | number;
+
 export type MetricPeriod = {
   /**
    * Timestamp of this period data.
@@ -103,12 +127,20 @@ export type MetricPeriod = {
   activeSubscriptions?: number | number | null | undefined;
   committedSubscriptions?: number | number | null | undefined;
   monthlyRecurringRevenue?: number | number | null | undefined;
+  trialMonthlyRecurringRevenue?: number | number | null | undefined;
   committedMonthlyRecurringRevenue?: number | number | null | undefined;
+  trialCommittedMonthlyRecurringRevenue?: number | number | null | undefined;
   averageRevenuePerUser?: number | number | null | undefined;
   checkouts?: number | number | null | undefined;
   succeededCheckouts?: number | number | null | undefined;
   churnedSubscriptions?: number | number | null | undefined;
   churnRate?: number | number | null | undefined;
+  seatsTotal?: number | number | null | undefined;
+  seatsClaimed?: number | number | null | undefined;
+  seatsPending?: number | number | null | undefined;
+  seatCustomers?: number | number | null | undefined;
+  newSeatCustomers?: number | number | null | undefined;
+  churnedSeatCustomers?: number | number | null | undefined;
   orders?: number | number | null | undefined;
   revenue?: number | number | null | undefined;
   netRevenue?: number | number | null | undefined;
@@ -138,11 +170,15 @@ export type MetricPeriod = {
   canceledSubscriptionsTooExpensive?: number | number | null | undefined;
   canceledSubscriptionsUnused?: number | number | null | undefined;
   canceledSubscriptionsOther?: number | number | null | undefined;
+  annualRecurringRevenue?: number | number | null | undefined;
+  committedAnnualRecurringRevenue?: number | number | null | undefined;
   checkoutsConversion?: number | number | null | undefined;
   ltv?: number | number | null | undefined;
   grossMargin?: number | number | null | undefined;
   grossMarginPercentage?: number | number | null | undefined;
   cashflow?: number | number | null | undefined;
+  averageSeatsPerCustomer?: number | number | null | undefined;
+  seatUtilizationRate?: number | number | null | undefined;
 };
 
 /** @internal */
@@ -193,6 +229,22 @@ export function monthlyRecurringRevenueFromJSON(
   );
 }
 
+/** @internal */
+export const TrialMonthlyRecurringRevenue$inboundSchema: z.ZodMiniType<
+  TrialMonthlyRecurringRevenue,
+  unknown
+> = smartUnion([z.int(), z.number()]);
+
+export function trialMonthlyRecurringRevenueFromJSON(
+  jsonString: string,
+): SafeParseResult<TrialMonthlyRecurringRevenue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TrialMonthlyRecurringRevenue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TrialMonthlyRecurringRevenue' from JSON`,
+  );
+}
+
 /** @internal */
 export const CommittedMonthlyRecurringRevenue$inboundSchema: z.ZodMiniType<
   CommittedMonthlyRecurringRevenue,
@@ -209,6 +261,23 @@ export function committedMonthlyRecurringRevenueFromJSON(
   );
 }
 
+/** @internal */
+export const TrialCommittedMonthlyRecurringRevenue$inboundSchema: z.ZodMiniType<
+  TrialCommittedMonthlyRecurringRevenue,
+  unknown
+> = smartUnion([z.int(), z.number()]);
+
+export function trialCommittedMonthlyRecurringRevenueFromJSON(
+  jsonString: string,
+): SafeParseResult<TrialCommittedMonthlyRecurringRevenue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TrialCommittedMonthlyRecurringRevenue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TrialCommittedMonthlyRecurringRevenue' from JSON`,
+  );
+}
+
 /** @internal */
 export const AverageRevenuePerUser$inboundSchema: z.ZodMiniType<
   AverageRevenuePerUser,
@@ -285,6 +354,96 @@ export function churnRateFromJSON(
   );
 }
 
+/** @internal */
+export const SeatsTotal$inboundSchema: z.ZodMiniType<SeatsTotal, unknown> =
+  smartUnion([z.int(), z.number()]);
+
+export function seatsTotalFromJSON(
+  jsonString: string,
+): SafeParseResult<SeatsTotal, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SeatsTotal$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SeatsTotal' from JSON`,
+  );
+}
+
+/** @internal */
+export const SeatsClaimed$inboundSchema: z.ZodMiniType<SeatsClaimed, unknown> =
+  smartUnion([z.int(), z.number()]);
+
+export function seatsClaimedFromJSON(
+  jsonString: string,
+): SafeParseResult<SeatsClaimed, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SeatsClaimed$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SeatsClaimed' from JSON`,
+  );
+}
+
+/** @internal */
+export const SeatsPending$inboundSchema: z.ZodMiniType<SeatsPending, unknown> =
+  smartUnion([z.int(), z.number()]);
+
+export function seatsPendingFromJSON(
+  jsonString: string,
+): SafeParseResult<SeatsPending, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SeatsPending$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SeatsPending' from JSON`,
+  );
+}
+
+/** @internal */
+export const SeatCustomers$inboundSchema: z.ZodMiniType<
+  SeatCustomers,
+  unknown
+> = smartUnion([z.int(), z.number()]);
+
+export function seatCustomersFromJSON(
+  jsonString: string,
+): SafeParseResult<SeatCustomers, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SeatCustomers$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SeatCustomers' from JSON`,
+  );
+}
+
+/** @internal */
+export const NewSeatCustomers$inboundSchema: z.ZodMiniType<
+  NewSeatCustomers,
+  unknown
+> = smartUnion([z.int(), z.number()]);
+
+export function newSeatCustomersFromJSON(
+  jsonString: string,
+): SafeParseResult<NewSeatCustomers, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NewSeatCustomers$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NewSeatCustomers' from JSON`,
+  );
+}
+
+/** @internal */
+export const ChurnedSeatCustomers$inboundSchema: z.ZodMiniType<
+  ChurnedSeatCustomers,
+  unknown
+> = smartUnion([z.int(), z.number()]);
+
+export function churnedSeatCustomersFromJSON(
+  jsonString: string,
+): SafeParseResult<ChurnedSeatCustomers, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChurnedSeatCustomers$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChurnedSeatCustomers' from JSON`,
+  );
+}
+
 /** @internal */
 export const Orders$inboundSchema: z.ZodMiniType<Orders, unknown> = smartUnion([
   z.int(),
@@ -746,6 +905,38 @@ export function canceledSubscriptionsOtherFromJSON(
   );
 }
 
+/** @internal */
+export const AnnualRecurringRevenue$inboundSchema: z.ZodMiniType<
+  AnnualRecurringRevenue,
+  unknown
+> = smartUnion([z.int(), z.number()]);
+
+export function annualRecurringRevenueFromJSON(
+  jsonString: string,
+): SafeParseResult<AnnualRecurringRevenue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnnualRecurringRevenue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnnualRecurringRevenue' from JSON`,
+  );
+}
+
+/** @internal */
+export const CommittedAnnualRecurringRevenue$inboundSchema: z.ZodMiniType<
+  CommittedAnnualRecurringRevenue,
+  unknown
+> = smartUnion([z.int(), z.number()]);
+
+export function committedAnnualRecurringRevenueFromJSON(
+  jsonString: string,
+): SafeParseResult<CommittedAnnualRecurringRevenue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommittedAnnualRecurringRevenue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommittedAnnualRecurringRevenue' from JSON`,
+  );
+}
+
 /** @internal */
 export const CheckoutsConversion$inboundSchema: z.ZodMiniType<
   CheckoutsConversion,
@@ -822,6 +1013,38 @@ export function cashflowFromJSON(
   );
 }
 
+/** @internal */
+export const AverageSeatsPerCustomer$inboundSchema: z.ZodMiniType<
+  AverageSeatsPerCustomer,
+  unknown
+> = smartUnion([z.int(), z.number()]);
+
+export function averageSeatsPerCustomerFromJSON(
+  jsonString: string,
+): SafeParseResult<AverageSeatsPerCustomer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AverageSeatsPerCustomer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AverageSeatsPerCustomer' from JSON`,
+  );
+}
+
+/** @internal */
+export const SeatUtilizationRate$inboundSchema: z.ZodMiniType<
+  SeatUtilizationRate,
+  unknown
+> = smartUnion([z.int(), z.number()]);
+
+export function seatUtilizationRateFromJSON(
+  jsonString: string,
+): SafeParseResult<SeatUtilizationRate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SeatUtilizationRate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SeatUtilizationRate' from JSON`,
+  );
+}
+
 /** @internal */
 export const MetricPeriod$inboundSchema: z.ZodMiniType<MetricPeriod, unknown> =
   z.pipe(
@@ -839,9 +1062,15 @@ export const MetricPeriod$inboundSchema: z.ZodMiniType<MetricPeriod, unknown> =
       monthly_recurring_revenue: z.optional(
         z.nullable(smartUnion([z.int(), z.number()])),
       ),
+      trial_monthly_recurring_revenue: z.optional(
+        z.nullable(smartUnion([z.int(), z.number()])),
+      ),
       committed_monthly_recurring_revenue: z.optional(
         z.nullable(smartUnion([z.int(), z.number()])),
       ),
+      trial_committed_monthly_recurring_revenue: z.optional(
+        z.nullable(smartUnion([z.int(), z.number()])),
+      ),
       average_revenue_per_user: z.optional(
         z.nullable(smartUnion([z.int(), z.number()])),
       ),
@@ -853,6 +1082,16 @@ export const MetricPeriod$inboundSchema: z.ZodMiniType<MetricPeriod, unknown> =
         z.nullable(smartUnion([z.int(), z.number()])),
       ),
       churn_rate: z.optional(z.nullable(smartUnion([z.int(), z.number()]))),
+      seats_total: z.optional(z.nullable(smartUnion([z.int(), z.number()]))),
+      seats_claimed: z.optional(z.nullable(smartUnion([z.int(), z.number()]))),
+      seats_pending: z.optional(z.nullable(smartUnion([z.int(), z.number()]))),
+      seat_customers: z.optional(z.nullable(smartUnion([z.int(), z.number()]))),
+      new_seat_customers: z.optional(
+        z.nullable(smartUnion([z.int(), z.number()])),
+      ),
+      churned_seat_customers: z.optional(
+        z.nullable(smartUnion([z.int(), z.number()])),
+      ),
       orders: z.optional(z.nullable(smartUnion([z.int(), z.number()]))),
       revenue: z.optional(z.nullable(smartUnion([z.int(), z.number()]))),
       net_revenue: z.optional(z.nullable(smartUnion([z.int(), z.number()]))),
@@ -930,6 +1169,12 @@ export const MetricPeriod$inboundSchema: z.ZodMiniType<MetricPeriod, unknown> =
       canceled_subscriptions_other: z.optional(
         z.nullable(smartUnion([z.int(), z.number()])),
       ),
+      annual_recurring_revenue: z.optional(
+        z.nullable(smartUnion([z.int(), z.number()])),
+      ),
+      committed_annual_recurring_revenue: z.optional(
+        z.nullable(smartUnion([z.int(), z.number()])),
+      ),
       checkouts_conversion: z.optional(
         z.nullable(smartUnion([z.int(), z.number()])),
       ),
@@ -939,18 +1184,33 @@ export const MetricPeriod$inboundSchema: z.ZodMiniType<MetricPeriod, unknown> =
         z.nullable(smartUnion([z.int(), z.number()])),
       ),
       cashflow: z.optional(z.nullable(smartUnion([z.int(), z.number()]))),
+      average_seats_per_customer: z.optional(
+        z.nullable(smartUnion([z.int(), z.number()])),
+      ),
+      seat_utilization_rate: z.optional(
+        z.nullable(smartUnion([z.int(), z.number()])),
+      ),
     }),
     z.transform((v) => {
       return remap$(v, {
         "active_subscriptions": "activeSubscriptions",
         "committed_subscriptions": "committedSubscriptions",
         "monthly_recurring_revenue": "monthlyRecurringRevenue",
+        "trial_monthly_recurring_revenue": "trialMonthlyRecurringRevenue",
         "committed_monthly_recurring_revenue":
           "committedMonthlyRecurringRevenue",
+        "trial_committed_monthly_recurring_revenue":
+          "trialCommittedMonthlyRecurringRevenue",
         "average_revenue_per_user": "averageRevenuePerUser",
         "succeeded_checkouts": "succeededCheckouts",
         "churned_subscriptions": "churnedSubscriptions",
         "churn_rate": "churnRate",
+        "seats_total": "seatsTotal",
+        "seats_claimed": "seatsClaimed",
+        "seats_pending": "seatsPending",
+        "seat_customers": "seatCustomers",
+        "new_seat_customers": "newSeatCustomers",
+        "churned_seat_customers": "churnedSeatCustomers",
         "net_revenue": "netRevenue",
         "cumulative_revenue": "cumulativeRevenue",
         "net_cumulative_revenue": "netCumulativeRevenue",
@@ -981,9 +1241,13 @@ export const MetricPeriod$inboundSchema: z.ZodMiniType<MetricPeriod, unknown> =
           "canceledSubscriptionsTooExpensive",
         "canceled_subscriptions_unused": "canceledSubscriptionsUnused",
         "canceled_subscriptions_other": "canceledSubscriptionsOther",
+        "annual_recurring_revenue": "annualRecurringRevenue",
+        "committed_annual_recurring_revenue": "committedAnnualRecurringRevenue",
         "checkouts_conversion": "checkoutsConversion",
         "gross_margin": "grossMargin",
         "gross_margin_percentage": "grossMarginPercentage",
+        "average_seats_per_customer": "averageSeatsPerCustomer",
+        "seat_utilization_rate": "seatUtilizationRate",
       });
     }),
   );

package/src/models/components/metrics.ts

@@ -13,12 +13,20 @@ export type Metrics = {
   activeSubscriptions?: Metric | null | undefined;
   committedSubscriptions?: Metric | null | undefined;
   monthlyRecurringRevenue?: Metric | null | undefined;
+  trialMonthlyRecurringRevenue?: Metric | null | undefined;
   committedMonthlyRecurringRevenue?: Metric | null | undefined;
+  trialCommittedMonthlyRecurringRevenue?: Metric | null | undefined;
   averageRevenuePerUser?: Metric | null | undefined;
   checkouts?: Metric | null | undefined;
   succeededCheckouts?: Metric | null | undefined;
   churnedSubscriptions?: Metric | null | undefined;
   churnRate?: Metric | null | undefined;
+  seatsTotal?: Metric | null | undefined;
+  seatsClaimed?: Metric | null | undefined;
+  seatsPending?: Metric | null | undefined;
+  seatCustomers?: Metric | null | undefined;
+  newSeatCustomers?: Metric | null | undefined;
+  churnedSeatCustomers?: Metric | null | undefined;
   orders?: Metric | null | undefined;
   revenue?: Metric | null | undefined;
   netRevenue?: Metric | null | undefined;
@@ -48,11 +56,15 @@ export type Metrics = {
   canceledSubscriptionsTooExpensive?: Metric | null | undefined;
   canceledSubscriptionsUnused?: Metric | null | undefined;
   canceledSubscriptionsOther?: Metric | null | undefined;
+  annualRecurringRevenue?: Metric | null | undefined;
+  committedAnnualRecurringRevenue?: Metric | null | undefined;
   checkoutsConversion?: Metric | null | undefined;
   ltv?: Metric | null | undefined;
   grossMargin?: Metric | null | undefined;
   grossMarginPercentage?: Metric | null | undefined;
   cashflow?: Metric | null | undefined;
+  averageSeatsPerCustomer?: Metric | null | undefined;
+  seatUtilizationRate?: Metric | null | undefined;
 };
 
 /** @internal */
@@ -61,14 +73,26 @@ export const Metrics$inboundSchema: z.ZodMiniType<Metrics, unknown> = z.pipe(
     active_subscriptions: z.optional(z.nullable(Metric$inboundSchema)),
     committed_subscriptions: z.optional(z.nullable(Metric$inboundSchema)),
     monthly_recurring_revenue: z.optional(z.nullable(Metric$inboundSchema)),
+    trial_monthly_recurring_revenue: z.optional(
+      z.nullable(Metric$inboundSchema),
+    ),
     committed_monthly_recurring_revenue: z.optional(
       z.nullable(Metric$inboundSchema),
     ),
+    trial_committed_monthly_recurring_revenue: z.optional(
+      z.nullable(Metric$inboundSchema),
+    ),
     average_revenue_per_user: z.optional(z.nullable(Metric$inboundSchema)),
     checkouts: z.optional(z.nullable(Metric$inboundSchema)),
     succeeded_checkouts: z.optional(z.nullable(Metric$inboundSchema)),
     churned_subscriptions: z.optional(z.nullable(Metric$inboundSchema)),
     churn_rate: z.optional(z.nullable(Metric$inboundSchema)),
+    seats_total: z.optional(z.nullable(Metric$inboundSchema)),
+    seats_claimed: z.optional(z.nullable(Metric$inboundSchema)),
+    seats_pending: z.optional(z.nullable(Metric$inboundSchema)),
+    seat_customers: z.optional(z.nullable(Metric$inboundSchema)),
+    new_seat_customers: z.optional(z.nullable(Metric$inboundSchema)),
+    churned_seat_customers: z.optional(z.nullable(Metric$inboundSchema)),
     orders: z.optional(z.nullable(Metric$inboundSchema)),
     revenue: z.optional(z.nullable(Metric$inboundSchema)),
     net_revenue: z.optional(z.nullable(Metric$inboundSchema)),
@@ -112,22 +136,37 @@ export const Metrics$inboundSchema: z.ZodMiniType<Metrics, unknown> = z.pipe(
     ),
     canceled_subscriptions_unused: z.optional(z.nullable(Metric$inboundSchema)),
     canceled_subscriptions_other: z.optional(z.nullable(Metric$inboundSchema)),
+    annual_recurring_revenue: z.optional(z.nullable(Metric$inboundSchema)),
+    committed_annual_recurring_revenue: z.optional(
+      z.nullable(Metric$inboundSchema),
+    ),
     checkouts_conversion: z.optional(z.nullable(Metric$inboundSchema)),
     ltv: z.optional(z.nullable(Metric$inboundSchema)),
     gross_margin: z.optional(z.nullable(Metric$inboundSchema)),
     gross_margin_percentage: z.optional(z.nullable(Metric$inboundSchema)),
     cashflow: z.optional(z.nullable(Metric$inboundSchema)),
+    average_seats_per_customer: z.optional(z.nullable(Metric$inboundSchema)),
+    seat_utilization_rate: z.optional(z.nullable(Metric$inboundSchema)),
   }),
   z.transform((v) => {
     return remap$(v, {
       "active_subscriptions": "activeSubscriptions",
       "committed_subscriptions": "committedSubscriptions",
       "monthly_recurring_revenue": "monthlyRecurringRevenue",
+      "trial_monthly_recurring_revenue": "trialMonthlyRecurringRevenue",
       "committed_monthly_recurring_revenue": "committedMonthlyRecurringRevenue",
+      "trial_committed_monthly_recurring_revenue":
+        "trialCommittedMonthlyRecurringRevenue",
       "average_revenue_per_user": "averageRevenuePerUser",
       "succeeded_checkouts": "succeededCheckouts",
       "churned_subscriptions": "churnedSubscriptions",
       "churn_rate": "churnRate",
+      "seats_total": "seatsTotal",
+      "seats_claimed": "seatsClaimed",
+      "seats_pending": "seatsPending",
+      "seat_customers": "seatCustomers",
+      "new_seat_customers": "newSeatCustomers",
+      "churned_seat_customers": "churnedSeatCustomers",
       "net_revenue": "netRevenue",
       "cumulative_revenue": "cumulativeRevenue",
       "net_cumulative_revenue": "netCumulativeRevenue",
@@ -158,9 +197,13 @@ export const Metrics$inboundSchema: z.ZodMiniType<Metrics, unknown> = z.pipe(
         "canceledSubscriptionsTooExpensive",
       "canceled_subscriptions_unused": "canceledSubscriptionsUnused",
       "canceled_subscriptions_other": "canceledSubscriptionsOther",
+      "annual_recurring_revenue": "annualRecurringRevenue",
+      "committed_annual_recurring_revenue": "committedAnnualRecurringRevenue",
       "checkouts_conversion": "checkoutsConversion",
       "gross_margin": "grossMargin",
       "gross_margin_percentage": "grossMarginPercentage",
+      "average_seats_per_customer": "averageSeatsPerCustomer",
+      "seat_utilization_rate": "seatUtilizationRate",
     });
   }),
 );