@polar-sh/sdk 0.30.0 → 0.32.0

package/src/models/components/order.ts

@@ -54,12 +54,23 @@ import {
   OrderCustomer$Outbound,
   OrderCustomer$outboundSchema,
 } from "./ordercustomer.js";
+import {
+  OrderItemSchema,
+  OrderItemSchema$inboundSchema,
+  OrderItemSchema$Outbound,
+  OrderItemSchema$outboundSchema,
+} from "./orderitemschema.js";
 import {
   OrderProduct,
   OrderProduct$inboundSchema,
   OrderProduct$Outbound,
   OrderProduct$outboundSchema,
 } from "./orderproduct.js";
+import {
+  OrderStatus,
+  OrderStatus$inboundSchema,
+  OrderStatus$outboundSchema,
+} from "./orderstatus.js";
 import {
   OrderSubscription,
   OrderSubscription$inboundSchema,
@@ -83,6 +94,9 @@ export type OrderMetadata = string | number | boolean;
 
 export type OrderCustomFieldData = string | number | boolean | Date;
 
+/**
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
 export type OrderProductPrice = LegacyRecurringProductPrice | ProductPrice;
 
 export type OrderDiscount =
@@ -111,15 +125,43 @@ export type Order = {
   customFieldData?:
     | { [k: string]: string | number | boolean | Date | null }
     | undefined;
-  status: string;
+  status: OrderStatus;
+  /**
+   * Whether the order has been paid for.
+   */
+  paid: boolean;
+  /**
+   * Amount in cents, before discounts and taxes.
+   */
+  subtotalAmount: number;
+  /**
+   * Discount amount in cents.
+   */
+  discountAmount: number;
+  /**
+   * Amount in cents, after discounts but before taxes.
+   */
+  netAmount: number;
+  /**
+   * Amount in cents, after discounts but before taxes.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   amount: number;
+  /**
+   * Sales tax amount in cents.
+   */
   taxAmount: number;
   /**
-   * Amount refunded
+   * Amount in cents, after discounts and taxes.
+   */
+  totalAmount: number;
+  /**
+   * Amount refunded in cents.
    */
   refundedAmount: number;
   /**
-   * Sales tax refunded
+   * Sales tax refunded in cents.
    */
   refundedTaxAmount: number;
   currency: string;
@@ -127,6 +169,9 @@ export type Order = {
   billingAddress: Address | null;
   customerId: string;
   productId: string;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   productPriceId: string;
   discountId: string | null;
   subscriptionId: string | null;
@@ -138,6 +183,9 @@ export type Order = {
   userId: string;
   user: OrderUser;
   product: OrderProduct;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   productPrice: LegacyRecurringProductPrice | ProductPrice;
   discount:
     | DiscountPercentageOnceForeverDurationBase
@@ -146,6 +194,10 @@ export type Order = {
     | DiscountFixedRepeatDurationBase
     | null;
   subscription: OrderSubscription | null;
+  /**
+   * Line items composing the order.
+   */
+  items: Array<OrderItemSchema>;
 };
 
 /** @internal */
@@ -385,9 +437,14 @@ export const Order$inboundSchema: z.ZodType<Order, z.ZodTypeDef, unknown> = z
         ]),
       ),
     ).optional(),
-    status: z.string(),
+    status: OrderStatus$inboundSchema,
+    paid: z.boolean(),
+    subtotal_amount: z.number().int(),
+    discount_amount: z.number().int(),
+    net_amount: z.number().int(),
     amount: z.number().int(),
     tax_amount: z.number().int(),
+    total_amount: z.number().int(),
     refunded_amount: z.number().int(),
     refunded_tax_amount: z.number().int(),
     currency: z.string(),
@@ -416,12 +473,17 @@ export const Order$inboundSchema: z.ZodType<Order, z.ZodTypeDef, unknown> = z
       ]),
     ),
     subscription: z.nullable(OrderSubscription$inboundSchema),
+    items: z.array(OrderItemSchema$inboundSchema),
   }).transform((v) => {
     return remap$(v, {
       "created_at": "createdAt",
       "modified_at": "modifiedAt",
       "custom_field_data": "customFieldData",
+      "subtotal_amount": "subtotalAmount",
+      "discount_amount": "discountAmount",
+      "net_amount": "netAmount",
       "tax_amount": "taxAmount",
+      "total_amount": "totalAmount",
       "refunded_amount": "refundedAmount",
       "refunded_tax_amount": "refundedTaxAmount",
       "billing_reason": "billingReason",
@@ -447,8 +509,13 @@ export type Order$Outbound = {
     | { [k: string]: string | number | boolean | string | null }
     | undefined;
   status: string;
+  paid: boolean;
+  subtotal_amount: number;
+  discount_amount: number;
+  net_amount: number;
   amount: number;
   tax_amount: number;
+  total_amount: number;
   refunded_amount: number;
   refunded_tax_amount: number;
   currency: string;
@@ -472,6 +539,7 @@ export type Order$Outbound = {
     | DiscountFixedRepeatDurationBase$Outbound
     | null;
   subscription: OrderSubscription$Outbound | null;
+  items: Array<OrderItemSchema$Outbound>;
 };
 
 /** @internal */
@@ -494,9 +562,14 @@ export const Order$outboundSchema: z.ZodType<
       ]),
     ),
   ).optional(),
-  status: z.string(),
+  status: OrderStatus$outboundSchema,
+  paid: z.boolean(),
+  subtotalAmount: z.number().int(),
+  discountAmount: z.number().int(),
+  netAmount: z.number().int(),
   amount: z.number().int(),
   taxAmount: z.number().int(),
+  totalAmount: z.number().int(),
   refundedAmount: z.number().int(),
   refundedTaxAmount: z.number().int(),
   currency: z.string(),
@@ -525,12 +598,17 @@ export const Order$outboundSchema: z.ZodType<
     ]),
   ),
   subscription: z.nullable(OrderSubscription$outboundSchema),
+  items: z.array(OrderItemSchema$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
     createdAt: "created_at",
     modifiedAt: "modified_at",
     customFieldData: "custom_field_data",
+    subtotalAmount: "subtotal_amount",
+    discountAmount: "discount_amount",
+    netAmount: "net_amount",
     taxAmount: "tax_amount",
+    totalAmount: "total_amount",
     refundedAmount: "refunded_amount",
     refundedTaxAmount: "refunded_tax_amount",
     billingReason: "billing_reason",

package/src/models/components/ordercustomer.ts

@@ -59,6 +59,10 @@ export type OrderCustomer = {
    * The ID of the organization owning the customer.
    */
   organizationId: string;
+  /**
+   * Timestamp for when the customer was soft deleted.
+   */
+  deletedAt: Date | null;
   avatarUrl: string;
 };
 
@@ -179,6 +183,9 @@ export const OrderCustomer$inboundSchema: z.ZodType<
     z.array(z.nullable(z.union([z.string(), TaxIDFormat$inboundSchema]))),
   ),
   organization_id: z.string(),
+  deleted_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   avatar_url: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -189,6 +196,7 @@ export const OrderCustomer$inboundSchema: z.ZodType<
     "billing_address": "billingAddress",
     "tax_id": "taxId",
     "organization_id": "organizationId",
+    "deleted_at": "deletedAt",
     "avatar_url": "avatarUrl",
   });
 });
@@ -206,6 +214,7 @@ export type OrderCustomer$Outbound = {
   billing_address: Address$Outbound | null;
   tax_id: Array<string | string | null> | null;
   organization_id: string;
+  deleted_at: string | null;
   avatar_url: string;
 };
 
@@ -228,6 +237,7 @@ export const OrderCustomer$outboundSchema: z.ZodType<
     z.array(z.nullable(z.union([z.string(), TaxIDFormat$outboundSchema]))),
   ),
   organizationId: z.string(),
+  deletedAt: z.nullable(z.date().transform(v => v.toISOString())),
   avatarUrl: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -238,6 +248,7 @@ export const OrderCustomer$outboundSchema: z.ZodType<
     billingAddress: "billing_address",
     taxId: "tax_id",
     organizationId: "organization_id",
+    deletedAt: "deleted_at",
     avatarUrl: "avatar_url",
   });
 });

package/src/models/components/orderitemschema.ts

@@ -0,0 +1,136 @@
+/*
+ * 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 order line item.
+ */
+export type OrderItemSchema = {
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * Description of the line item charge.
+   */
+  label: string;
+  /**
+   * Amount in cents, before discounts and taxes.
+   */
+  amount: number;
+  /**
+   * Sales tax amount in cents.
+   */
+  taxAmount: number;
+  /**
+   * Whether this charge is due to a proration.
+   */
+  proration: boolean;
+  /**
+   * Associated price ID, if any.
+   */
+  productPriceId: string | null;
+};
+
+/** @internal */
+export const OrderItemSchema$inboundSchema: z.ZodType<
+  OrderItemSchema,
+  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)),
+  ),
+  id: z.string(),
+  label: z.string(),
+  amount: z.number().int(),
+  tax_amount: z.number().int(),
+  proration: z.boolean(),
+  product_price_id: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "modified_at": "modifiedAt",
+    "tax_amount": "taxAmount",
+    "product_price_id": "productPriceId",
+  });
+});
+
+/** @internal */
+export type OrderItemSchema$Outbound = {
+  created_at: string;
+  modified_at: string | null;
+  id: string;
+  label: string;
+  amount: number;
+  tax_amount: number;
+  proration: boolean;
+  product_price_id: string | null;
+};
+
+/** @internal */
+export const OrderItemSchema$outboundSchema: z.ZodType<
+  OrderItemSchema$Outbound,
+  z.ZodTypeDef,
+  OrderItemSchema
+> = z.object({
+  createdAt: z.date().transform(v => v.toISOString()),
+  modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  id: z.string(),
+  label: z.string(),
+  amount: z.number().int(),
+  taxAmount: z.number().int(),
+  proration: z.boolean(),
+  productPriceId: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    modifiedAt: "modified_at",
+    taxAmount: "tax_amount",
+    productPriceId: "product_price_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrderItemSchema$ {
+  /** @deprecated use `OrderItemSchema$inboundSchema` instead. */
+  export const inboundSchema = OrderItemSchema$inboundSchema;
+  /** @deprecated use `OrderItemSchema$outboundSchema` instead. */
+  export const outboundSchema = OrderItemSchema$outboundSchema;
+  /** @deprecated use `OrderItemSchema$Outbound` instead. */
+  export type Outbound = OrderItemSchema$Outbound;
+}
+
+export function orderItemSchemaToJSON(
+  orderItemSchema: OrderItemSchema,
+): string {
+  return JSON.stringify(OrderItemSchema$outboundSchema.parse(orderItemSchema));
+}
+
+export function orderItemSchemaFromJSON(
+  jsonString: string,
+): SafeParseResult<OrderItemSchema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OrderItemSchema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OrderItemSchema' from JSON`,
+  );
+}

package/src/models/components/ordersortproperty.ts

@@ -10,6 +10,8 @@ export const OrderSortProperty = {
   MinusCreatedAt: "-created_at",
   Amount: "amount",
   MinusAmount: "-amount",
+  NetAmount: "net_amount",
+  MinusNetAmount: "-net_amount",
   Customer: "customer",
   MinusCustomer: "-customer",
   Product: "product",

package/src/models/components/orderstatus.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const OrderStatus = {
+  Pending: "pending",
+  Paid: "paid",
+  Refunded: "refunded",
+  PartiallyRefunded: "partially_refunded",
+} as const;
+export type OrderStatus = ClosedEnum<typeof OrderStatus>;
+
+/** @internal */
+export const OrderStatus$inboundSchema: z.ZodNativeEnum<typeof OrderStatus> = z
+  .nativeEnum(OrderStatus);
+
+/** @internal */
+export const OrderStatus$outboundSchema: z.ZodNativeEnum<typeof OrderStatus> =
+  OrderStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrderStatus$ {
+  /** @deprecated use `OrderStatus$inboundSchema` instead. */
+  export const inboundSchema = OrderStatus$inboundSchema;
+  /** @deprecated use `OrderStatus$outboundSchema` instead. */
+  export const outboundSchema = OrderStatus$outboundSchema;
+}

package/src/models/components/ordersubscription.ts

@@ -42,11 +42,11 @@ export type OrderSubscription = {
   /**
    * The amount of the subscription.
    */
-  amount: number | null;
+  amount: number;
   /**
    * The currency of the subscription.
    */
-  currency: string | null;
+  currency: string;
   recurringInterval: SubscriptionRecurringInterval;
   status: SubscriptionStatus;
   /**
@@ -85,10 +85,6 @@ export type OrderSubscription = {
    * The ID of the subscribed product.
    */
   productId: string;
-  /**
-   * The ID of the subscribed price.
-   */
-  priceId: string;
   /**
    * The ID of the applied discount, if any.
    */
@@ -96,6 +92,10 @@ export type OrderSubscription = {
   checkoutId: string | null;
   customerCancellationReason: CustomerCancellationReason | null;
   customerCancellationComment: string | null;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  priceId: string;
   /**
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -162,8 +162,8 @@ export const OrderSubscription$inboundSchema: z.ZodType<
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
   id: z.string(),
-  amount: z.nullable(z.number().int()),
-  currency: z.nullable(z.string()),
+  amount: z.number().int(),
+  currency: z.string(),
   recurring_interval: SubscriptionRecurringInterval$inboundSchema,
   status: SubscriptionStatus$inboundSchema,
   current_period_start: z.string().datetime({ offset: true }).transform(v =>
@@ -187,13 +187,13 @@ export const OrderSubscription$inboundSchema: z.ZodType<
   ),
   customer_id: z.string(),
   product_id: z.string(),
-  price_id: z.string(),
   discount_id: z.nullable(z.string()),
   checkout_id: z.nullable(z.string()),
   customer_cancellation_reason: z.nullable(
     CustomerCancellationReason$inboundSchema,
   ),
   customer_cancellation_comment: z.nullable(z.string()),
+  price_id: z.string(),
   user_id: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -209,11 +209,11 @@ export const OrderSubscription$inboundSchema: z.ZodType<
     "ended_at": "endedAt",
     "customer_id": "customerId",
     "product_id": "productId",
-    "price_id": "priceId",
     "discount_id": "discountId",
     "checkout_id": "checkoutId",
     "customer_cancellation_reason": "customerCancellationReason",
     "customer_cancellation_comment": "customerCancellationComment",
+    "price_id": "priceId",
     "user_id": "userId",
   });
 });
@@ -224,8 +224,8 @@ export type OrderSubscription$Outbound = {
   created_at: string;
   modified_at: string | null;
   id: string;
-  amount: number | null;
-  currency: string | null;
+  amount: number;
+  currency: string;
   recurring_interval: string;
   status: string;
   current_period_start: string;
@@ -237,11 +237,11 @@ export type OrderSubscription$Outbound = {
   ended_at: string | null;
   customer_id: string;
   product_id: string;
-  price_id: string;
   discount_id: string | null;
   checkout_id: string | null;
   customer_cancellation_reason: string | null;
   customer_cancellation_comment: string | null;
+  price_id: string;
   user_id: string;
 };
 
@@ -255,8 +255,8 @@ export const OrderSubscription$outboundSchema: z.ZodType<
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
   id: z.string(),
-  amount: z.nullable(z.number().int()),
-  currency: z.nullable(z.string()),
+  amount: z.number().int(),
+  currency: z.string(),
   recurringInterval: SubscriptionRecurringInterval$outboundSchema,
   status: SubscriptionStatus$outboundSchema,
   currentPeriodStart: z.date().transform(v => v.toISOString()),
@@ -268,13 +268,13 @@ export const OrderSubscription$outboundSchema: z.ZodType<
   endedAt: z.nullable(z.date().transform(v => v.toISOString())),
   customerId: z.string(),
   productId: z.string(),
-  priceId: z.string(),
   discountId: z.nullable(z.string()),
   checkoutId: z.nullable(z.string()),
   customerCancellationReason: z.nullable(
     CustomerCancellationReason$outboundSchema,
   ),
   customerCancellationComment: z.nullable(z.string()),
+  priceId: z.string(),
   userId: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -290,11 +290,11 @@ export const OrderSubscription$outboundSchema: z.ZodType<
     endedAt: "ended_at",
     customerId: "customer_id",
     productId: "product_id",
-    priceId: "price_id",
     discountId: "discount_id",
     checkoutId: "checkout_id",
     customerCancellationReason: "customer_cancellation_reason",
     customerCancellationComment: "customer_cancellation_comment",
+    priceId: "price_id",
     userId: "user_id",
   });
 });