@polar-sh/sdk 0.32.1 → 0.32.3

package/src/models/components/productpricemeteredunitcreate.ts

@@ -0,0 +1,125 @@
+/*
+ * 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";
+
+/**
+ * Schema to create a metered price with a fixed unit price.
+ */
+export type ProductPriceMeteredUnitCreate = {
+  amountType?: "metered_unit" | undefined;
+  /**
+   * The ID of the meter associated to the price.
+   */
+  meterId: string;
+  /**
+   * The currency. Currently, only `usd` is supported.
+   */
+  priceCurrency?: string | undefined;
+  /**
+   * The price per unit in cents.
+   */
+  unitAmount: number;
+  /**
+   * The number of units included in the price. They will be deducted from the total.
+   */
+  includedUnits: number;
+  /**
+   * Optional maximum amount in cents that can be charged, regardless of the number of units consumed.
+   */
+  capAmount?: number | null | undefined;
+};
+
+/** @internal */
+export const ProductPriceMeteredUnitCreate$inboundSchema: z.ZodType<
+  ProductPriceMeteredUnitCreate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount_type: z.literal("metered_unit").optional(),
+  meter_id: z.string(),
+  price_currency: z.string().default("usd"),
+  unit_amount: z.number().int(),
+  included_units: z.number().int(),
+  cap_amount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "amount_type": "amountType",
+    "meter_id": "meterId",
+    "price_currency": "priceCurrency",
+    "unit_amount": "unitAmount",
+    "included_units": "includedUnits",
+    "cap_amount": "capAmount",
+  });
+});
+
+/** @internal */
+export type ProductPriceMeteredUnitCreate$Outbound = {
+  amount_type: "metered_unit";
+  meter_id: string;
+  price_currency: string;
+  unit_amount: number;
+  included_units: number;
+  cap_amount?: number | null | undefined;
+};
+
+/** @internal */
+export const ProductPriceMeteredUnitCreate$outboundSchema: z.ZodType<
+  ProductPriceMeteredUnitCreate$Outbound,
+  z.ZodTypeDef,
+  ProductPriceMeteredUnitCreate
+> = z.object({
+  amountType: z.literal("metered_unit").default("metered_unit" as const),
+  meterId: z.string(),
+  priceCurrency: z.string().default("usd"),
+  unitAmount: z.number().int(),
+  includedUnits: z.number().int(),
+  capAmount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    amountType: "amount_type",
+    meterId: "meter_id",
+    priceCurrency: "price_currency",
+    unitAmount: "unit_amount",
+    includedUnits: "included_units",
+    capAmount: "cap_amount",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductPriceMeteredUnitCreate$ {
+  /** @deprecated use `ProductPriceMeteredUnitCreate$inboundSchema` instead. */
+  export const inboundSchema = ProductPriceMeteredUnitCreate$inboundSchema;
+  /** @deprecated use `ProductPriceMeteredUnitCreate$outboundSchema` instead. */
+  export const outboundSchema = ProductPriceMeteredUnitCreate$outboundSchema;
+  /** @deprecated use `ProductPriceMeteredUnitCreate$Outbound` instead. */
+  export type Outbound = ProductPriceMeteredUnitCreate$Outbound;
+}
+
+export function productPriceMeteredUnitCreateToJSON(
+  productPriceMeteredUnitCreate: ProductPriceMeteredUnitCreate,
+): string {
+  return JSON.stringify(
+    ProductPriceMeteredUnitCreate$outboundSchema.parse(
+      productPriceMeteredUnitCreate,
+    ),
+  );
+}
+
+export function productPriceMeteredUnitCreateFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductPriceMeteredUnitCreate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductPriceMeteredUnitCreate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductPriceMeteredUnitCreate' from JSON`,
+  );
+}

package/src/models/components/productupdate.ts

@@ -37,6 +37,12 @@ import {
   ProductPriceFreeCreate$Outbound,
   ProductPriceFreeCreate$outboundSchema,
 } from "./productpricefreecreate.js";
+import {
+  ProductPriceMeteredUnitCreate,
+  ProductPriceMeteredUnitCreate$inboundSchema,
+  ProductPriceMeteredUnitCreate$Outbound,
+  ProductPriceMeteredUnitCreate$outboundSchema,
+} from "./productpricemeteredunitcreate.js";
 import {
   SubscriptionRecurringInterval,
   SubscriptionRecurringInterval$inboundSchema,
@@ -49,13 +55,28 @@ export type ProductUpdatePrices =
   | ExistingProductPrice
   | ProductPriceFreeCreate
   | ProductPriceFixedCreate
-  | ProductPriceCustomCreate;
+  | ProductPriceCustomCreate
+  | ProductPriceMeteredUnitCreate;
 
 /**
  * Schema to update a product.
  */
 export type ProductUpdate = {
-  metadata?: { [k: string]: string | number | boolean } | null | undefined;
+  /**
+   * Key-value object allowing you to store additional information.
+   *
+   * @remarks
+   *
+   * The key must be a string with a maximum length of **40 characters**.
+   * The value must be either:
+   *
+   * * A string with a maximum length of **500 characters**
+   * * An integer
+   * * A boolean
+   *
+   * You can store up to **50 key-value pairs**.
+   */
+  metadata?: { [k: string]: string | number | boolean } | undefined;
   name?: string | null | undefined;
   /**
    * The description of the product.
@@ -78,6 +99,7 @@ export type ProductUpdate = {
       | ProductPriceFreeCreate
       | ProductPriceFixedCreate
       | ProductPriceCustomCreate
+      | ProductPriceMeteredUnitCreate
     >
     | null
     | undefined;
@@ -146,6 +168,7 @@ export const ProductUpdatePrices$inboundSchema: z.ZodType<
   ProductPriceFreeCreate$inboundSchema,
   ProductPriceFixedCreate$inboundSchema,
   ProductPriceCustomCreate$inboundSchema,
+  ProductPriceMeteredUnitCreate$inboundSchema,
 ]);
 
 /** @internal */
@@ -153,7 +176,8 @@ export type ProductUpdatePrices$Outbound =
   | ExistingProductPrice$Outbound
   | ProductPriceFreeCreate$Outbound
   | ProductPriceFixedCreate$Outbound
-  | ProductPriceCustomCreate$Outbound;
+  | ProductPriceCustomCreate$Outbound
+  | ProductPriceMeteredUnitCreate$Outbound;
 
 /** @internal */
 export const ProductUpdatePrices$outboundSchema: z.ZodType<
@@ -165,6 +189,7 @@ export const ProductUpdatePrices$outboundSchema: z.ZodType<
   ProductPriceFreeCreate$outboundSchema,
   ProductPriceFixedCreate$outboundSchema,
   ProductPriceCustomCreate$outboundSchema,
+  ProductPriceMeteredUnitCreate$outboundSchema,
 ]);
 
 /**
@@ -204,9 +229,8 @@ export const ProductUpdate$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  metadata: z.nullable(
-    z.record(z.union([z.string(), z.number().int(), z.boolean()])),
-  ).optional(),
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()]))
+    .optional(),
   name: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
   recurring_interval: z.nullable(SubscriptionRecurringInterval$inboundSchema)
@@ -219,6 +243,7 @@ export const ProductUpdate$inboundSchema: z.ZodType<
         ProductPriceFreeCreate$inboundSchema,
         ProductPriceFixedCreate$inboundSchema,
         ProductPriceCustomCreate$inboundSchema,
+        ProductPriceMeteredUnitCreate$inboundSchema,
       ]),
     ),
   ).optional(),
@@ -236,7 +261,7 @@ export const ProductUpdate$inboundSchema: z.ZodType<
 
 /** @internal */
 export type ProductUpdate$Outbound = {
-  metadata?: { [k: string]: string | number | boolean } | null | undefined;
+  metadata?: { [k: string]: string | number | boolean } | undefined;
   name?: string | null | undefined;
   description?: string | null | undefined;
   recurring_interval?: string | null | undefined;
@@ -247,6 +272,7 @@ export type ProductUpdate$Outbound = {
       | ProductPriceFreeCreate$Outbound
       | ProductPriceFixedCreate$Outbound
       | ProductPriceCustomCreate$Outbound
+      | ProductPriceMeteredUnitCreate$Outbound
     >
     | null
     | undefined;
@@ -263,9 +289,8 @@ export const ProductUpdate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ProductUpdate
 > = z.object({
-  metadata: z.nullable(
-    z.record(z.union([z.string(), z.number().int(), z.boolean()])),
-  ).optional(),
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()]))
+    .optional(),
   name: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
   recurringInterval: z.nullable(SubscriptionRecurringInterval$outboundSchema)
@@ -278,6 +303,7 @@ export const ProductUpdate$outboundSchema: z.ZodType<
         ProductPriceFreeCreate$outboundSchema,
         ProductPriceFixedCreate$outboundSchema,
         ProductPriceCustomCreate$outboundSchema,
+        ProductPriceMeteredUnitCreate$outboundSchema,
       ]),
     ),
   ).optional(),

package/src/models/operations/benefitslist.ts

@@ -6,6 +6,11 @@ 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 {
+  BenefitSortProperty,
+  BenefitSortProperty$inboundSchema,
+  BenefitSortProperty$outboundSchema,
+} from "../components/benefitsortproperty.js";
 import {
   BenefitType,
   BenefitType$inboundSchema,
@@ -50,6 +55,10 @@ export type BenefitsListRequest = {
    * Size of a page, defaults to 10. Maximum is 100.
    */
   limit?: number | undefined;
+  /**
+   * Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
+   */
+  sorting?: Array<BenefitSortProperty> | null | undefined;
 };
 
 export type BenefitsListResponse = {
@@ -178,6 +187,7 @@ export const BenefitsListRequest$inboundSchema: z.ZodType<
   query: z.nullable(z.string()).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
+  sorting: z.nullable(z.array(BenefitSortProperty$inboundSchema)).optional(),
 }).transform((v) => {
   return remap$(v, {
     "organization_id": "organizationId",
@@ -192,6 +202,7 @@ export type BenefitsListRequest$Outbound = {
   query?: string | null | undefined;
   page: number;
   limit: number;
+  sorting?: Array<string> | null | undefined;
 };
 
 /** @internal */
@@ -208,6 +219,7 @@ export const BenefitsListRequest$outboundSchema: z.ZodType<
   query: z.nullable(z.string()).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
+  sorting: z.nullable(z.array(BenefitSortProperty$outboundSchema)).optional(),
 }).transform((v) => {
   return remap$(v, {
     organizationId: "organization_id",