@polar-sh/sdk 0.32.13 → 0.32.15

package/src/mcp-server/tools/paymentsGet.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { paymentsGet } from "../../funcs/paymentsGet.js";
+import { PaymentsGetRequest$inboundSchema } from "../../models/operations/paymentsget.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: PaymentsGetRequest$inboundSchema,
+};
+
+export const tool$paymentsGet: ToolDefinition<typeof args> = {
+  name: "payments-get",
+  description: `Get Payment
+
+Get a payment by ID.
+
+**Scopes**: \`payments:read\``,
+  scopes: ["read", "payments"],
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await paymentsGet(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/paymentsList.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { paymentsList } from "../../funcs/paymentsList.js";
+import { PaymentsListRequest$inboundSchema } from "../../models/operations/paymentslist.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: PaymentsListRequest$inboundSchema,
+};
+
+export const tool$paymentsList: ToolDefinition<typeof args> = {
+  name: "payments-list",
+  description: `List Payments
+
+List payments.
+
+**Scopes**: \`payments:read\``,
+  scopes: ["read", "payments"],
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await paymentsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/models/components/benefitgrant.ts

@@ -25,6 +25,12 @@ import {
   BenefitGrantDownloadablesProperties$Outbound,
   BenefitGrantDownloadablesProperties$outboundSchema,
 } from "./benefitgrantdownloadablesproperties.js";
+import {
+  BenefitGrantError,
+  BenefitGrantError$inboundSchema,
+  BenefitGrantError$Outbound,
+  BenefitGrantError$outboundSchema,
+} from "./benefitgranterror.js";
 import {
   BenefitGrantGitHubRepositoryProperties,
   BenefitGrantGitHubRepositoryProperties$inboundSchema,
@@ -96,6 +102,10 @@ export type BenefitGrant = {
    * The ID of the benefit concerned by this grant.
    */
   benefitId: string;
+  /**
+   * The error information if the benefit grant failed with an unrecoverable error.
+   */
+  error?: BenefitGrantError | null | undefined;
   /**
    * A customer in an organization.
    */
@@ -192,6 +202,7 @@ export const BenefitGrant$inboundSchema: z.ZodType<
   order_id: z.nullable(z.string()),
   customer_id: z.string(),
   benefit_id: z.string(),
+  error: z.nullable(BenefitGrantError$inboundSchema).optional(),
   customer: Customer$inboundSchema,
   properties: z.union([
     BenefitGrantCustomProperties$inboundSchema,
@@ -228,6 +239,7 @@ export type BenefitGrant$Outbound = {
   order_id: string | null;
   customer_id: string;
   benefit_id: string;
+  error?: BenefitGrantError$Outbound | null | undefined;
   customer: Customer$Outbound;
   properties:
     | BenefitGrantCustomProperties$Outbound
@@ -254,6 +266,7 @@ export const BenefitGrant$outboundSchema: z.ZodType<
   orderId: z.nullable(z.string()),
   customerId: z.string(),
   benefitId: z.string(),
+  error: z.nullable(BenefitGrantError$outboundSchema).optional(),
   customer: Customer$outboundSchema,
   properties: z.union([
     BenefitGrantCustomProperties$outboundSchema,

package/src/models/components/benefitgranterror.ts

@@ -0,0 +1,74 @@
+/*
+ * 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";
+
+export type BenefitGrantError = {
+  message: string;
+  type: string;
+  timestamp: string;
+};
+
+/** @internal */
+export const BenefitGrantError$inboundSchema: z.ZodType<
+  BenefitGrantError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  type: z.string(),
+  timestamp: z.string(),
+});
+
+/** @internal */
+export type BenefitGrantError$Outbound = {
+  message: string;
+  type: string;
+  timestamp: string;
+};
+
+/** @internal */
+export const BenefitGrantError$outboundSchema: z.ZodType<
+  BenefitGrantError$Outbound,
+  z.ZodTypeDef,
+  BenefitGrantError
+> = z.object({
+  message: z.string(),
+  type: z.string(),
+  timestamp: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BenefitGrantError$ {
+  /** @deprecated use `BenefitGrantError$inboundSchema` instead. */
+  export const inboundSchema = BenefitGrantError$inboundSchema;
+  /** @deprecated use `BenefitGrantError$outboundSchema` instead. */
+  export const outboundSchema = BenefitGrantError$outboundSchema;
+  /** @deprecated use `BenefitGrantError$Outbound` instead. */
+  export type Outbound = BenefitGrantError$Outbound;
+}
+
+export function benefitGrantErrorToJSON(
+  benefitGrantError: BenefitGrantError,
+): string {
+  return JSON.stringify(
+    BenefitGrantError$outboundSchema.parse(benefitGrantError),
+  );
+}
+
+export function benefitGrantErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitGrantError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitGrantError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitGrantError' from JSON`,
+  );
+}

package/src/models/components/benefitgrantwebhook.ts

@@ -31,6 +31,12 @@ import {
   BenefitGrantDownloadablesProperties$Outbound,
   BenefitGrantDownloadablesProperties$outboundSchema,
 } from "./benefitgrantdownloadablesproperties.js";
+import {
+  BenefitGrantError,
+  BenefitGrantError$inboundSchema,
+  BenefitGrantError$Outbound,
+  BenefitGrantError$outboundSchema,
+} from "./benefitgranterror.js";
 import {
   BenefitGrantGitHubRepositoryProperties,
   BenefitGrantGitHubRepositoryProperties$inboundSchema,
@@ -109,6 +115,10 @@ export type BenefitGrantWebhook = {
    * The ID of the benefit concerned by this grant.
    */
   benefitId: string;
+  /**
+   * The error information if the benefit grant failed with an unrecoverable error.
+   */
+  error?: BenefitGrantError | null | undefined;
   /**
    * A customer in an organization.
    */
@@ -285,6 +295,7 @@ export const BenefitGrantWebhook$inboundSchema: z.ZodType<
   order_id: z.nullable(z.string()),
   customer_id: z.string(),
   benefit_id: z.string(),
+  error: z.nullable(BenefitGrantError$inboundSchema).optional(),
   customer: Customer$inboundSchema,
   properties: z.union([
     BenefitGrantCustomProperties$inboundSchema,
@@ -332,6 +343,7 @@ export type BenefitGrantWebhook$Outbound = {
   order_id: string | null;
   customer_id: string;
   benefit_id: string;
+  error?: BenefitGrantError$Outbound | null | undefined;
   customer: Customer$Outbound;
   properties:
     | BenefitGrantCustomProperties$Outbound
@@ -367,6 +379,7 @@ export const BenefitGrantWebhook$outboundSchema: z.ZodType<
   orderId: z.nullable(z.string()),
   customerId: z.string(),
   benefitId: z.string(),
+  error: z.nullable(BenefitGrantError$outboundSchema).optional(),
   customer: Customer$outboundSchema,
   properties: z.union([
     BenefitGrantCustomProperties$outboundSchema,

package/src/models/components/benefitmetercreditcreateproperties.ts

@@ -13,6 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type BenefitMeterCreditCreateProperties = {
   units: number;
+  rollover: boolean;
   meterId: string;
 };
 
@@ -23,6 +24,7 @@ export const BenefitMeterCreditCreateProperties$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   units: z.number().int(),
+  rollover: z.boolean(),
   meter_id: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -33,6 +35,7 @@ export const BenefitMeterCreditCreateProperties$inboundSchema: z.ZodType<
 /** @internal */
 export type BenefitMeterCreditCreateProperties$Outbound = {
   units: number;
+  rollover: boolean;
   meter_id: string;
 };
 
@@ -43,6 +46,7 @@ export const BenefitMeterCreditCreateProperties$outboundSchema: z.ZodType<
   BenefitMeterCreditCreateProperties
 > = z.object({
   units: z.number().int(),
+  rollover: z.boolean(),
   meterId: z.string(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/benefitmetercreditproperties.ts

@@ -13,6 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type BenefitMeterCreditProperties = {
   units: number;
+  rollover: boolean;
   meterId: string;
 };
 
@@ -23,6 +24,7 @@ export const BenefitMeterCreditProperties$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   units: z.number().int(),
+  rollover: z.boolean(),
   meter_id: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -33,6 +35,7 @@ export const BenefitMeterCreditProperties$inboundSchema: z.ZodType<
 /** @internal */
 export type BenefitMeterCreditProperties$Outbound = {
   units: number;
+  rollover: boolean;
   meter_id: string;
 };
 
@@ -43,6 +46,7 @@ export const BenefitMeterCreditProperties$outboundSchema: z.ZodType<
   BenefitMeterCreditProperties
 > = z.object({
   units: z.number().int(),
+  rollover: z.boolean(),
   meterId: z.string(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/benefitmetercreditsubscriberproperties.ts

@@ -13,6 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type BenefitMeterCreditSubscriberProperties = {
   units: number;
+  rollover: boolean;
   meterId: string;
 };
 
@@ -23,6 +24,7 @@ export const BenefitMeterCreditSubscriberProperties$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   units: z.number().int(),
+  rollover: z.boolean(),
   meter_id: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -33,6 +35,7 @@ export const BenefitMeterCreditSubscriberProperties$inboundSchema: z.ZodType<
 /** @internal */
 export type BenefitMeterCreditSubscriberProperties$Outbound = {
   units: number;
+  rollover: boolean;
   meter_id: string;
 };
 
@@ -43,6 +46,7 @@ export const BenefitMeterCreditSubscriberProperties$outboundSchema: z.ZodType<
   BenefitMeterCreditSubscriberProperties
 > = z.object({
   units: z.number().int(),
+  rollover: z.boolean(),
   meterId: z.string(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/cardpayment.ts

@@ -0,0 +1,194 @@
+/*
+ * 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 {
+  CardPaymentMetadata,
+  CardPaymentMetadata$inboundSchema,
+  CardPaymentMetadata$Outbound,
+  CardPaymentMetadata$outboundSchema,
+} from "./cardpaymentmetadata.js";
+import {
+  PaymentProcessor,
+  PaymentProcessor$inboundSchema,
+  PaymentProcessor$outboundSchema,
+} from "./paymentprocessor.js";
+import {
+  PaymentStatus,
+  PaymentStatus$inboundSchema,
+  PaymentStatus$outboundSchema,
+} from "./paymentstatus.js";
+
+/**
+ * Schema of a payment with a card payment method.
+ */
+export type CardPayment = {
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  processor: PaymentProcessor;
+  status: PaymentStatus;
+  /**
+   * The payment amount in cents.
+   */
+  amount: number;
+  /**
+   * The payment currency. Currently, only `usd` is supported.
+   */
+  currency: string;
+  /**
+   * The payment method used.
+   */
+  method?: "card" | undefined;
+  /**
+   * Error code, if the payment was declined.
+   */
+  declineReason: string | null;
+  /**
+   * Human-reasable error message, if the payment was declined.
+   */
+  declineMessage: string | null;
+  /**
+   * The ID of the organization that owns the payment.
+   */
+  organizationId: string;
+  /**
+   * The ID of the checkout session associated with this payment.
+   */
+  checkoutId: string | null;
+  /**
+   * The ID of the order associated with this payment.
+   */
+  orderId: string | null;
+  /**
+   * Additional metadata for a card payment method.
+   */
+  methodMetadata: CardPaymentMetadata;
+};
+
+/** @internal */
+export const CardPayment$inboundSchema: z.ZodType<
+  CardPayment,
+  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(),
+  processor: PaymentProcessor$inboundSchema,
+  status: PaymentStatus$inboundSchema,
+  amount: z.number().int(),
+  currency: z.string(),
+  method: z.literal("card").optional(),
+  decline_reason: z.nullable(z.string()),
+  decline_message: z.nullable(z.string()),
+  organization_id: z.string(),
+  checkout_id: z.nullable(z.string()),
+  order_id: z.nullable(z.string()),
+  method_metadata: CardPaymentMetadata$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "modified_at": "modifiedAt",
+    "decline_reason": "declineReason",
+    "decline_message": "declineMessage",
+    "organization_id": "organizationId",
+    "checkout_id": "checkoutId",
+    "order_id": "orderId",
+    "method_metadata": "methodMetadata",
+  });
+});
+
+/** @internal */
+export type CardPayment$Outbound = {
+  created_at: string;
+  modified_at: string | null;
+  id: string;
+  processor: string;
+  status: string;
+  amount: number;
+  currency: string;
+  method: "card";
+  decline_reason: string | null;
+  decline_message: string | null;
+  organization_id: string;
+  checkout_id: string | null;
+  order_id: string | null;
+  method_metadata: CardPaymentMetadata$Outbound;
+};
+
+/** @internal */
+export const CardPayment$outboundSchema: z.ZodType<
+  CardPayment$Outbound,
+  z.ZodTypeDef,
+  CardPayment
+> = z.object({
+  createdAt: z.date().transform(v => v.toISOString()),
+  modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  id: z.string(),
+  processor: PaymentProcessor$outboundSchema,
+  status: PaymentStatus$outboundSchema,
+  amount: z.number().int(),
+  currency: z.string(),
+  method: z.literal("card").default("card" as const),
+  declineReason: z.nullable(z.string()),
+  declineMessage: z.nullable(z.string()),
+  organizationId: z.string(),
+  checkoutId: z.nullable(z.string()),
+  orderId: z.nullable(z.string()),
+  methodMetadata: CardPaymentMetadata$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    modifiedAt: "modified_at",
+    declineReason: "decline_reason",
+    declineMessage: "decline_message",
+    organizationId: "organization_id",
+    checkoutId: "checkout_id",
+    orderId: "order_id",
+    methodMetadata: "method_metadata",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CardPayment$ {
+  /** @deprecated use `CardPayment$inboundSchema` instead. */
+  export const inboundSchema = CardPayment$inboundSchema;
+  /** @deprecated use `CardPayment$outboundSchema` instead. */
+  export const outboundSchema = CardPayment$outboundSchema;
+  /** @deprecated use `CardPayment$Outbound` instead. */
+  export type Outbound = CardPayment$Outbound;
+}
+
+export function cardPaymentToJSON(cardPayment: CardPayment): string {
+  return JSON.stringify(CardPayment$outboundSchema.parse(cardPayment));
+}
+
+export function cardPaymentFromJSON(
+  jsonString: string,
+): SafeParseResult<CardPayment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CardPayment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CardPayment' from JSON`,
+  );
+}

package/src/models/components/cardpaymentmetadata.ts

@@ -0,0 +1,79 @@
+/*
+ * 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";
+
+/**
+ * Additional metadata for a card payment method.
+ */
+export type CardPaymentMetadata = {
+  /**
+   * The brand of the card used for the payment.
+   */
+  brand: string;
+  /**
+   * The last 4 digits of the card number.
+   */
+  last4: string;
+};
+
+/** @internal */
+export const CardPaymentMetadata$inboundSchema: z.ZodType<
+  CardPaymentMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  brand: z.string(),
+  last4: z.string(),
+});
+
+/** @internal */
+export type CardPaymentMetadata$Outbound = {
+  brand: string;
+  last4: string;
+};
+
+/** @internal */
+export const CardPaymentMetadata$outboundSchema: z.ZodType<
+  CardPaymentMetadata$Outbound,
+  z.ZodTypeDef,
+  CardPaymentMetadata
+> = z.object({
+  brand: z.string(),
+  last4: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CardPaymentMetadata$ {
+  /** @deprecated use `CardPaymentMetadata$inboundSchema` instead. */
+  export const inboundSchema = CardPaymentMetadata$inboundSchema;
+  /** @deprecated use `CardPaymentMetadata$outboundSchema` instead. */
+  export const outboundSchema = CardPaymentMetadata$outboundSchema;
+  /** @deprecated use `CardPaymentMetadata$Outbound` instead. */
+  export type Outbound = CardPaymentMetadata$Outbound;
+}
+
+export function cardPaymentMetadataToJSON(
+  cardPaymentMetadata: CardPaymentMetadata,
+): string {
+  return JSON.stringify(
+    CardPaymentMetadata$outboundSchema.parse(cardPaymentMetadata),
+  );
+}
+
+export function cardPaymentMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<CardPaymentMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CardPaymentMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CardPaymentMetadata' from JSON`,
+  );
+}

package/src/models/components/checkoutsortproperty.ts

@@ -10,6 +10,8 @@ export const CheckoutSortProperty = {
   MinusCreatedAt: "-created_at",
   ExpiresAt: "expires_at",
   MinusExpiresAt: "-expires_at",
+  Status: "status",
+  MinusStatus: "-status",
 } as const;
 export type CheckoutSortProperty = ClosedEnum<typeof CheckoutSortProperty>;
 

package/src/models/components/customercustomermeter.ts

@@ -44,7 +44,7 @@ export type CustomerCustomerMeter = {
    */
   creditedUnits: number;
   /**
-   * The balance of the meter, i.e. the difference between credited and consumed units. Never goes negative.
+   * The balance of the meter, i.e. the difference between credited and consumed units.
    */
   balance: number;
   meter: CustomerCustomerMeterMeter;

package/src/models/components/customermeter.ts

@@ -53,7 +53,7 @@ export type CustomerMeter = {
    */
   creditedUnits: number;
   /**
-   * The balance of the meter, i.e. the difference between credited and consumed units. Never goes negative.
+   * The balance of the meter, i.e. the difference between credited and consumed units.
    */
   balance: number;
   /**

package/src/models/components/customerstatemeter.ts

@@ -33,7 +33,7 @@ export type CustomerStateMeter = {
    */
   creditedUnits: number;
   /**
-   * The balance of the meter, i.e. the difference between credited and consumed units. Never goes negative.
+   * The balance of the meter, i.e. the difference between credited and consumed units.
    */
   balance: number;
 };