@paygentic/sdk 0.4.1 → 0.5.1-beta.1

package/src/models/invoice.ts

@@ -0,0 +1,527 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  InvoiceLineItem,
+  InvoiceLineItem$inboundSchema,
+  InvoiceLineItem$Outbound,
+  InvoiceLineItem$outboundSchema,
+} from "./invoicelineitem.js";
+
+/**
+ * The object type
+ */
+export const InvoiceObject = {
+  Invoice: "invoice",
+} as const;
+/**
+ * The object type
+ */
+export type InvoiceObject = ClosedEnum<typeof InvoiceObject>;
+
+/**
+ * The current status of the invoice
+ */
+export const InvoiceStatus = {
+  Active: "ACTIVE",
+  Closing: "CLOSING",
+  Closed: "CLOSED",
+  Calculating: "CALCULATING",
+  Draft: "DRAFT",
+  Issued: "ISSUED",
+  PaymentFailed: "PAYMENT_FAILED",
+  Paid: "PAID",
+  Cancelled: "CANCELLED",
+  WrittenOff: "WRITTEN_OFF",
+  Failed: "FAILED",
+} as const;
+/**
+ * The current status of the invoice
+ */
+export type InvoiceStatus = ClosedEnum<typeof InvoiceStatus>;
+
+/**
+ * Line items (only present if expand=lineItems query parameter is provided)
+ */
+export type LineItems = {
+  /**
+   * The invoice ID
+   */
+  invoiceId: string;
+  /**
+   * Array of line items for this page
+   */
+  lineItems: Array<InvoiceLineItem>;
+  /**
+   * Token for fetching the next page, null if no more pages
+   */
+  nextPageToken?: string | null | undefined;
+  /**
+   * Total number of line items across all pages
+   */
+  totalCount: number;
+};
+
+/**
+ * Tax reconciliation metadata (only present when plan has taxEnabled)
+ */
+export type Tax = {
+  /**
+   * Tax estimated from subscription rate (in nanodollars)
+   */
+  estimatedTax?: string | undefined;
+  /**
+   * Actual tax calculated (in nanodollars)
+   */
+  actualTax?: string | undefined;
+  /**
+   * Difference between actual and estimated (in nanodollars)
+   */
+  difference?: string | undefined;
+  /**
+   * Whether reconciliation was performed
+   */
+  reconciled?: boolean | undefined;
+  /**
+   * When reconciliation occurred
+   */
+  reconciledAt?: Date | undefined;
+  /**
+   * Whether wallet adjustment is needed (difference >= $0.01)
+   */
+  adjustmentNeeded?: boolean | undefined;
+  /**
+   * Whether wallet adjustment was applied during tax reconciliation
+   */
+  adjustmentApplied?: boolean | undefined;
+};
+
+export type Invoice = {
+  /**
+   * The invoice ID
+   */
+  id: string;
+  /**
+   * The object type
+   */
+  object: InvoiceObject;
+  /**
+   * The subscription ID this invoice belongs to
+   */
+  subscriptionId: string;
+  /**
+   * The sequence number of this invoice period
+   */
+  sequenceNumber: number;
+  /**
+   * The current status of the invoice
+   */
+  status: InvoiceStatus;
+  /**
+   * The start of the billing period
+   */
+  periodStart: Date;
+  /**
+   * The end of the billing period
+   */
+  periodEnd: Date;
+  /**
+   * The end of the grace period for accepting usage events
+   */
+  gracePeriodEnd: Date;
+  /**
+   * The billing anchor date used for period calculations
+   */
+  billingAnchor: Date;
+  /**
+   * ISO 8601 duration string for billing frequency
+   */
+  billingCadence: string;
+  /**
+   * Whether this invoice auto-approves after calculation
+   */
+  autoApprove: boolean;
+  /**
+   * When the next scheduled action should occur
+   */
+  nextActionAt?: Date | null | undefined;
+  /**
+   * Number of billing items (real-time for ACTIVE/CLOSING/CLOSED, cached otherwise)
+   */
+  itemCount: number;
+  /**
+   * Subtotal in decimal dollars (real-time for ACTIVE/CLOSING/CLOSED, cached otherwise)
+   */
+  subtotal: string;
+  /**
+   * Total tax in decimal dollars (real-time for ACTIVE/CLOSING/CLOSED, cached otherwise)
+   */
+  totalTax: string;
+  /**
+   * Grand total (subtotal + tax) in decimal dollars (real-time for ACTIVE/CLOSING/CLOSED, cached otherwise)
+   */
+  grandTotal: string;
+  /**
+   * Amount already paid via wallet (account_type='main') in decimal dollars
+   */
+  paidAmount: string;
+  /**
+   * Amount accrued as liability (account_type='usage') in decimal dollars
+   */
+  unpaidAmount: string;
+  /**
+   * Line items (only present if expand=lineItems query parameter is provided)
+   */
+  lineItems?: LineItems | null | undefined;
+  /**
+   * The invoice number
+   */
+  invoiceNumber?: string | null | undefined;
+  /**
+   * Payment URL for completing payment (only present when status is ISSUED and unpaidAmount > 0)
+   */
+  paymentUrl?: string | null | undefined;
+  /**
+   * Public URL to view tax invoice
+   */
+  permalink?: string | null | undefined;
+  /**
+   * Direct PDF download link for tax invoice
+   */
+  pdfUrl?: string | null | undefined;
+  /**
+   * Tax reconciliation metadata (only present when plan has taxEnabled)
+   */
+  tax?: Tax | null | undefined;
+  /**
+   * Additional metadata including transition history
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * When the invoice was paid (null if not yet paid)
+   */
+  paidAt?: Date | null | undefined;
+  /**
+   * When the invoice was created
+   */
+  createdAt: Date;
+  /**
+   * When the invoice was last updated
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const InvoiceObject$inboundSchema: z.ZodNativeEnum<
+  typeof InvoiceObject
+> = z.nativeEnum(InvoiceObject);
+
+/** @internal */
+export const InvoiceObject$outboundSchema: z.ZodNativeEnum<
+  typeof InvoiceObject
+> = InvoiceObject$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InvoiceObject$ {
+  /** @deprecated use `InvoiceObject$inboundSchema` instead. */
+  export const inboundSchema = InvoiceObject$inboundSchema;
+  /** @deprecated use `InvoiceObject$outboundSchema` instead. */
+  export const outboundSchema = InvoiceObject$outboundSchema;
+}
+
+/** @internal */
+export const InvoiceStatus$inboundSchema: z.ZodNativeEnum<
+  typeof InvoiceStatus
+> = z.nativeEnum(InvoiceStatus);
+
+/** @internal */
+export const InvoiceStatus$outboundSchema: z.ZodNativeEnum<
+  typeof InvoiceStatus
+> = InvoiceStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InvoiceStatus$ {
+  /** @deprecated use `InvoiceStatus$inboundSchema` instead. */
+  export const inboundSchema = InvoiceStatus$inboundSchema;
+  /** @deprecated use `InvoiceStatus$outboundSchema` instead. */
+  export const outboundSchema = InvoiceStatus$outboundSchema;
+}
+
+/** @internal */
+export const LineItems$inboundSchema: z.ZodType<
+  LineItems,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  invoiceId: z.string(),
+  lineItems: z.array(InvoiceLineItem$inboundSchema),
+  nextPageToken: z.nullable(z.string()).optional(),
+  totalCount: z.number().int(),
+});
+
+/** @internal */
+export type LineItems$Outbound = {
+  invoiceId: string;
+  lineItems: Array<InvoiceLineItem$Outbound>;
+  nextPageToken?: string | null | undefined;
+  totalCount: number;
+};
+
+/** @internal */
+export const LineItems$outboundSchema: z.ZodType<
+  LineItems$Outbound,
+  z.ZodTypeDef,
+  LineItems
+> = z.object({
+  invoiceId: z.string(),
+  lineItems: z.array(InvoiceLineItem$outboundSchema),
+  nextPageToken: z.nullable(z.string()).optional(),
+  totalCount: z.number().int(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LineItems$ {
+  /** @deprecated use `LineItems$inboundSchema` instead. */
+  export const inboundSchema = LineItems$inboundSchema;
+  /** @deprecated use `LineItems$outboundSchema` instead. */
+  export const outboundSchema = LineItems$outboundSchema;
+  /** @deprecated use `LineItems$Outbound` instead. */
+  export type Outbound = LineItems$Outbound;
+}
+
+export function lineItemsToJSON(lineItems: LineItems): string {
+  return JSON.stringify(LineItems$outboundSchema.parse(lineItems));
+}
+
+export function lineItemsFromJSON(
+  jsonString: string,
+): SafeParseResult<LineItems, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LineItems$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LineItems' from JSON`,
+  );
+}
+
+/** @internal */
+export const Tax$inboundSchema: z.ZodType<Tax, z.ZodTypeDef, unknown> = z
+  .object({
+    estimatedTax: z.string().optional(),
+    actualTax: z.string().optional(),
+    difference: z.string().optional(),
+    reconciled: z.boolean().optional(),
+    reconciledAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+    adjustmentNeeded: z.boolean().optional(),
+    adjustmentApplied: z.boolean().optional(),
+  });
+
+/** @internal */
+export type Tax$Outbound = {
+  estimatedTax?: string | undefined;
+  actualTax?: string | undefined;
+  difference?: string | undefined;
+  reconciled?: boolean | undefined;
+  reconciledAt?: string | undefined;
+  adjustmentNeeded?: boolean | undefined;
+  adjustmentApplied?: boolean | undefined;
+};
+
+/** @internal */
+export const Tax$outboundSchema: z.ZodType<Tax$Outbound, z.ZodTypeDef, Tax> = z
+  .object({
+    estimatedTax: z.string().optional(),
+    actualTax: z.string().optional(),
+    difference: z.string().optional(),
+    reconciled: z.boolean().optional(),
+    reconciledAt: z.date().transform(v => v.toISOString()).optional(),
+    adjustmentNeeded: z.boolean().optional(),
+    adjustmentApplied: z.boolean().optional(),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Tax$ {
+  /** @deprecated use `Tax$inboundSchema` instead. */
+  export const inboundSchema = Tax$inboundSchema;
+  /** @deprecated use `Tax$outboundSchema` instead. */
+  export const outboundSchema = Tax$outboundSchema;
+  /** @deprecated use `Tax$Outbound` instead. */
+  export type Outbound = Tax$Outbound;
+}
+
+export function taxToJSON(tax: Tax): string {
+  return JSON.stringify(Tax$outboundSchema.parse(tax));
+}
+
+export function taxFromJSON(
+  jsonString: string,
+): SafeParseResult<Tax, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Tax$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Tax' from JSON`,
+  );
+}
+
+/** @internal */
+export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
+  z.object({
+    id: z.string(),
+    object: InvoiceObject$inboundSchema,
+    subscriptionId: z.string(),
+    sequenceNumber: z.number().int(),
+    status: InvoiceStatus$inboundSchema,
+    periodStart: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    periodEnd: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    gracePeriodEnd: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    billingAnchor: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    billingCadence: z.string(),
+    autoApprove: z.boolean(),
+    nextActionAt: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    itemCount: z.number().int(),
+    subtotal: z.string(),
+    totalTax: z.string(),
+    grandTotal: z.string(),
+    paidAmount: z.string(),
+    unpaidAmount: z.string(),
+    lineItems: z.nullable(z.lazy(() => LineItems$inboundSchema)).optional(),
+    invoiceNumber: z.nullable(z.string()).optional(),
+    paymentUrl: z.nullable(z.string()).optional(),
+    permalink: z.nullable(z.string()).optional(),
+    pdfUrl: z.nullable(z.string()).optional(),
+    tax: z.nullable(z.lazy(() => Tax$inboundSchema)).optional(),
+    metadata: z.record(z.any()).optional(),
+    paidAt: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    createdAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    updatedAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+  });
+
+/** @internal */
+export type Invoice$Outbound = {
+  id: string;
+  object: string;
+  subscriptionId: string;
+  sequenceNumber: number;
+  status: string;
+  periodStart: string;
+  periodEnd: string;
+  gracePeriodEnd: string;
+  billingAnchor: string;
+  billingCadence: string;
+  autoApprove: boolean;
+  nextActionAt?: string | null | undefined;
+  itemCount: number;
+  subtotal: string;
+  totalTax: string;
+  grandTotal: string;
+  paidAmount: string;
+  unpaidAmount: string;
+  lineItems?: LineItems$Outbound | null | undefined;
+  invoiceNumber?: string | null | undefined;
+  paymentUrl?: string | null | undefined;
+  permalink?: string | null | undefined;
+  pdfUrl?: string | null | undefined;
+  tax?: Tax$Outbound | null | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  paidAt?: string | null | undefined;
+  createdAt: string;
+  updatedAt: string;
+};
+
+/** @internal */
+export const Invoice$outboundSchema: z.ZodType<
+  Invoice$Outbound,
+  z.ZodTypeDef,
+  Invoice
+> = z.object({
+  id: z.string(),
+  object: InvoiceObject$outboundSchema,
+  subscriptionId: z.string(),
+  sequenceNumber: z.number().int(),
+  status: InvoiceStatus$outboundSchema,
+  periodStart: z.date().transform(v => v.toISOString()),
+  periodEnd: z.date().transform(v => v.toISOString()),
+  gracePeriodEnd: z.date().transform(v => v.toISOString()),
+  billingAnchor: z.date().transform(v => v.toISOString()),
+  billingCadence: z.string(),
+  autoApprove: z.boolean(),
+  nextActionAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  itemCount: z.number().int(),
+  subtotal: z.string(),
+  totalTax: z.string(),
+  grandTotal: z.string(),
+  paidAmount: z.string(),
+  unpaidAmount: z.string(),
+  lineItems: z.nullable(z.lazy(() => LineItems$outboundSchema)).optional(),
+  invoiceNumber: z.nullable(z.string()).optional(),
+  paymentUrl: z.nullable(z.string()).optional(),
+  permalink: z.nullable(z.string()).optional(),
+  pdfUrl: z.nullable(z.string()).optional(),
+  tax: z.nullable(z.lazy(() => Tax$outboundSchema)).optional(),
+  metadata: z.record(z.any()).optional(),
+  paidAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  createdAt: z.date().transform(v => v.toISOString()),
+  updatedAt: z.date().transform(v => v.toISOString()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Invoice$ {
+  /** @deprecated use `Invoice$inboundSchema` instead. */
+  export const inboundSchema = Invoice$inboundSchema;
+  /** @deprecated use `Invoice$outboundSchema` instead. */
+  export const outboundSchema = Invoice$outboundSchema;
+  /** @deprecated use `Invoice$Outbound` instead. */
+  export type Outbound = Invoice$Outbound;
+}
+
+export function invoiceToJSON(invoice: Invoice): string {
+  return JSON.stringify(Invoice$outboundSchema.parse(invoice));
+}
+
+export function invoiceFromJSON(
+  jsonString: string,
+): SafeParseResult<Invoice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Invoice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Invoice' from JSON`,
+  );
+}

package/src/models/invoicelineitem.ts

@@ -0,0 +1,151 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type InvoiceLineItem = {
+  /**
+   * The usage event ID
+   */
+  usageEventId: string;
+  /**
+   * The billable metric ID
+   */
+  billableMetricId: string;
+  /**
+   * Quantity of usage
+   */
+  quantity: number;
+  /**
+   * Unit price in decimal dollars
+   */
+  unitPrice: string;
+  /**
+   * Total price (tax-exclusive) in decimal dollars
+   */
+  totalPrice: string;
+  /**
+   * Tax rate as decimal (0.10 = 10%)
+   */
+  taxRate: number;
+  /**
+   * Total tax in decimal dollars
+   */
+  totalTax: string;
+  /**
+   * Total amount (totalPrice + totalTax) in decimal dollars
+   */
+  totalAmount: string;
+  /**
+   * The meter event ID
+   */
+  meterEventId: string;
+  /**
+   * Human-readable name of the billable metric
+   */
+  metricName: string;
+  /**
+   * Description of what this metric measures
+   */
+  metricDescription: string;
+  /**
+   * Unit of measurement (e.g., 'calls', 'GB', 'hours')
+   */
+  metricUnit: string;
+  /**
+   * Display name for this line item on invoices
+   */
+  invoiceDisplayName: string;
+};
+
+/** @internal */
+export const InvoiceLineItem$inboundSchema: z.ZodType<
+  InvoiceLineItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  usageEventId: z.string(),
+  billableMetricId: z.string(),
+  quantity: z.number(),
+  unitPrice: z.string(),
+  totalPrice: z.string(),
+  taxRate: z.number(),
+  totalTax: z.string(),
+  totalAmount: z.string(),
+  meterEventId: z.string(),
+  metricName: z.string(),
+  metricDescription: z.string(),
+  metricUnit: z.string(),
+  invoiceDisplayName: z.string(),
+});
+
+/** @internal */
+export type InvoiceLineItem$Outbound = {
+  usageEventId: string;
+  billableMetricId: string;
+  quantity: number;
+  unitPrice: string;
+  totalPrice: string;
+  taxRate: number;
+  totalTax: string;
+  totalAmount: string;
+  meterEventId: string;
+  metricName: string;
+  metricDescription: string;
+  metricUnit: string;
+  invoiceDisplayName: string;
+};
+
+/** @internal */
+export const InvoiceLineItem$outboundSchema: z.ZodType<
+  InvoiceLineItem$Outbound,
+  z.ZodTypeDef,
+  InvoiceLineItem
+> = z.object({
+  usageEventId: z.string(),
+  billableMetricId: z.string(),
+  quantity: z.number(),
+  unitPrice: z.string(),
+  totalPrice: z.string(),
+  taxRate: z.number(),
+  totalTax: z.string(),
+  totalAmount: z.string(),
+  meterEventId: z.string(),
+  metricName: z.string(),
+  metricDescription: z.string(),
+  metricUnit: z.string(),
+  invoiceDisplayName: 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 InvoiceLineItem$ {
+  /** @deprecated use `InvoiceLineItem$inboundSchema` instead. */
+  export const inboundSchema = InvoiceLineItem$inboundSchema;
+  /** @deprecated use `InvoiceLineItem$outboundSchema` instead. */
+  export const outboundSchema = InvoiceLineItem$outboundSchema;
+  /** @deprecated use `InvoiceLineItem$Outbound` instead. */
+  export type Outbound = InvoiceLineItem$Outbound;
+}
+
+export function invoiceLineItemToJSON(
+  invoiceLineItem: InvoiceLineItem,
+): string {
+  return JSON.stringify(InvoiceLineItem$outboundSchema.parse(invoiceLineItem));
+}
+
+export function invoiceLineItemFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceLineItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceLineItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceLineItem' from JSON`,
+  );
+}