@polar-sh/sdk 0.32.13 → 0.32.14

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;
 };

package/src/models/components/genericpayment.ts

@@ -0,0 +1,179 @@
+/*
+ * 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 {
+  PaymentProcessor,
+  PaymentProcessor$inboundSchema,
+  PaymentProcessor$outboundSchema,
+} from "./paymentprocessor.js";
+import {
+  PaymentStatus,
+  PaymentStatus$inboundSchema,
+  PaymentStatus$outboundSchema,
+} from "./paymentstatus.js";
+
+/**
+ * Schema of a payment with a generic payment method.
+ */
+export type GenericPayment = {
+  /**
+   * 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: string;
+  /**
+   * 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;
+};
+
+/** @internal */
+export const GenericPayment$inboundSchema: z.ZodType<
+  GenericPayment,
+  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.string(),
+  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()),
+}).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",
+  });
+});
+
+/** @internal */
+export type GenericPayment$Outbound = {
+  created_at: string;
+  modified_at: string | null;
+  id: string;
+  processor: string;
+  status: string;
+  amount: number;
+  currency: string;
+  method: string;
+  decline_reason: string | null;
+  decline_message: string | null;
+  organization_id: string;
+  checkout_id: string | null;
+  order_id: string | null;
+};
+
+/** @internal */
+export const GenericPayment$outboundSchema: z.ZodType<
+  GenericPayment$Outbound,
+  z.ZodTypeDef,
+  GenericPayment
+> = 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.string(),
+  declineReason: z.nullable(z.string()),
+  declineMessage: z.nullable(z.string()),
+  organizationId: z.string(),
+  checkoutId: z.nullable(z.string()),
+  orderId: z.nullable(z.string()),
+}).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",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GenericPayment$ {
+  /** @deprecated use `GenericPayment$inboundSchema` instead. */
+  export const inboundSchema = GenericPayment$inboundSchema;
+  /** @deprecated use `GenericPayment$outboundSchema` instead. */
+  export const outboundSchema = GenericPayment$outboundSchema;
+  /** @deprecated use `GenericPayment$Outbound` instead. */
+  export type Outbound = GenericPayment$Outbound;
+}
+
+export function genericPaymentToJSON(genericPayment: GenericPayment): string {
+  return JSON.stringify(GenericPayment$outboundSchema.parse(genericPayment));
+}
+
+export function genericPaymentFromJSON(
+  jsonString: string,
+): SafeParseResult<GenericPayment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GenericPayment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GenericPayment' from JSON`,
+  );
+}

package/src/models/components/listresource.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 {
+  Pagination,
+  Pagination$inboundSchema,
+  Pagination$Outbound,
+  Pagination$outboundSchema,
+} from "./pagination.js";
+import {
+  Payment,
+  Payment$inboundSchema,
+  Payment$Outbound,
+  Payment$outboundSchema,
+} from "./payment.js";
+
+export type ListResource = {
+  items: Array<Payment>;
+  pagination: Pagination;
+};
+
+/** @internal */
+export const ListResource$inboundSchema: z.ZodType<
+  ListResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(Payment$inboundSchema),
+  pagination: Pagination$inboundSchema,
+});
+
+/** @internal */
+export type ListResource$Outbound = {
+  items: Array<Payment$Outbound>;
+  pagination: Pagination$Outbound;
+};
+
+/** @internal */
+export const ListResource$outboundSchema: z.ZodType<
+  ListResource$Outbound,
+  z.ZodTypeDef,
+  ListResource
+> = z.object({
+  items: z.array(Payment$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 ListResource$ {
+  /** @deprecated use `ListResource$inboundSchema` instead. */
+  export const inboundSchema = ListResource$inboundSchema;
+  /** @deprecated use `ListResource$outboundSchema` instead. */
+  export const outboundSchema = ListResource$outboundSchema;
+  /** @deprecated use `ListResource$Outbound` instead. */
+  export type Outbound = ListResource$Outbound;
+}
+
+export function listResourceToJSON(listResource: ListResource): string {
+  return JSON.stringify(ListResource$outboundSchema.parse(listResource));
+}
+
+export function listResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResource' from JSON`,
+  );
+}