@paygentic/sdk 0.6.15 → 0.6.17

package/src/models/lineitem.ts

@@ -0,0 +1,205 @@
+/*
+ * 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";
+
+/**
+ * The type of line item
+ */
+export const LineItemType = {
+  Fee: "fee",
+  Metered: "metered",
+  Manual: "manual",
+} as const;
+/**
+ * The type of line item
+ */
+export type LineItemType = ClosedEnum<typeof LineItemType>;
+
+/**
+ * Whether this item is pending or already on an invoice
+ */
+export const LineItemStatus = {
+  Pending: "pending",
+  Invoiced: "invoiced",
+} as const;
+/**
+ * Whether this item is pending or already on an invoice
+ */
+export type LineItemStatus = ClosedEnum<typeof LineItemStatus>;
+
+/**
+ * Payment term for fee items. Null for metered/manual lines
+ */
+export const LineItemPaymentTerm = {
+  InAdvance: "in_advance",
+  InArrears: "in_arrears",
+} as const;
+/**
+ * Payment term for fee items. Null for metered/manual lines
+ */
+export type LineItemPaymentTerm = ClosedEnum<typeof LineItemPaymentTerm>;
+
+export type LineItem = {
+  /**
+   * The line item ID
+   */
+  id: string;
+  /**
+   * The subscription this line item belongs to
+   */
+  subscriptionId: string;
+  /**
+   * The price ID associated with this line item
+   */
+  priceId?: string | null | undefined;
+  /**
+   * The invoice ID if this item has been invoiced
+   */
+  invoiceId?: string | null | undefined;
+  /**
+   * The type of line item
+   */
+  type: LineItemType;
+  /**
+   * Whether this item is pending or already on an invoice
+   */
+  status: LineItemStatus;
+  /**
+   * Human-readable label shown on the invoice
+   */
+  displayName: string;
+  /**
+   * Optional longer description
+   */
+  description?: string | null | undefined;
+  /**
+   * ISO 4217 currency code (e.g., USD)
+   */
+  currency: string;
+  /**
+   * Start of the billing period (inclusive)
+   */
+  periodStart: Date;
+  /**
+   * End of the billing period (exclusive)
+   */
+  periodEnd: Date;
+  /**
+   * When this line item should be collected into an invoice
+   */
+  invoiceAt: Date;
+  /**
+   * When metered quantity was last computed
+   */
+  calculatedAt?: Date | null | undefined;
+  /**
+   * Units sold. Null for metered lines until invoice close
+   */
+  quantity?: string | null | undefined;
+  /**
+   * Price per unit in invoice currency
+   */
+  unitPrice: string;
+  /**
+   * Raw metered usage. Null for fee/manual lines
+   */
+  meteredQuantity?: string | null | undefined;
+  /**
+   * Payment term for fee items. Null for metered/manual lines
+   */
+  paymentTerm?: LineItemPaymentTerm | null | undefined;
+  /**
+   * quantity x unitPrice, before discounts and taxes. Defaults to '0.00' when not yet calculated
+   */
+  subtotal?: string | undefined;
+  /**
+   * Total tax amount for this line item in decimal format. Null until invoice calculation is complete
+   */
+  taxesTotal?: string | null | undefined;
+  /**
+   * Final total after discounts and taxes. Defaults to '0.00' when not yet calculated
+   */
+  total?: string | undefined;
+  /**
+   * When the line item was created
+   */
+  createdAt: Date;
+  /**
+   * When the line item was last updated
+   */
+  updatedAt: Date;
+  /**
+   * Real-time estimated metered usage quantity. Only present for type=metered items during an active billing period. Null for fee/manual items or when estimation is unavailable.
+   */
+  estimatedMeteredQuantity?: string | null | undefined;
+  /**
+   * Real-time estimated subtotal based on current metered usage. Only present for type=metered items during an active billing period. Null for fee/manual items or when estimation is unavailable.
+   */
+  estimatedSubtotal?: string | null | undefined;
+};
+
+/** @internal */
+export const LineItemType$inboundSchema: z.ZodNativeEnum<typeof LineItemType> =
+  z.nativeEnum(LineItemType);
+
+/** @internal */
+export const LineItemStatus$inboundSchema: z.ZodNativeEnum<
+  typeof LineItemStatus
+> = z.nativeEnum(LineItemStatus);
+
+/** @internal */
+export const LineItemPaymentTerm$inboundSchema: z.ZodNativeEnum<
+  typeof LineItemPaymentTerm
+> = z.nativeEnum(LineItemPaymentTerm);
+
+/** @internal */
+export const LineItem$inboundSchema: z.ZodType<
+  LineItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  subscriptionId: z.string(),
+  priceId: z.nullable(z.string()).optional(),
+  invoiceId: z.nullable(z.string()).optional(),
+  type: LineItemType$inboundSchema,
+  status: LineItemStatus$inboundSchema,
+  displayName: z.string(),
+  description: z.nullable(z.string()).optional(),
+  currency: z.string(),
+  periodStart: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  periodEnd: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  invoiceAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  calculatedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  quantity: z.nullable(z.string()).optional(),
+  unitPrice: z.string(),
+  meteredQuantity: z.nullable(z.string()).optional(),
+  paymentTerm: z.nullable(LineItemPaymentTerm$inboundSchema).optional(),
+  subtotal: z.string().optional(),
+  taxesTotal: z.nullable(z.string()).optional(),
+  total: z.string().optional(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  estimatedMeteredQuantity: z.nullable(z.string()).optional(),
+  estimatedSubtotal: z.nullable(z.string()).optional(),
+});
+
+export function lineItemFromJSON(
+  jsonString: string,
+): SafeParseResult<LineItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LineItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LineItem' from JSON`,
+  );
+}

package/src/models/lineitemsresponse.ts

@@ -0,0 +1,70 @@
+/*
+ * 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 { LineItem, LineItem$inboundSchema } from "./lineitem.js";
+import {
+  LineItemsSummary,
+  LineItemsSummary$inboundSchema,
+} from "./lineitemssummary.js";
+
+/**
+ * The object type
+ */
+export const LineItemsResponseObject = {
+  List: "list",
+} as const;
+/**
+ * The object type
+ */
+export type LineItemsResponseObject = ClosedEnum<
+  typeof LineItemsResponseObject
+>;
+
+export type LineItemsResponse = {
+  /**
+   * The object type
+   */
+  object: LineItemsResponseObject;
+  /**
+   * Array of line items
+   */
+  data: Array<LineItem>;
+  /**
+   * Total number of matching line items
+   */
+  totalCount: number;
+  summary: LineItemsSummary;
+};
+
+/** @internal */
+export const LineItemsResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof LineItemsResponseObject
+> = z.nativeEnum(LineItemsResponseObject);
+
+/** @internal */
+export const LineItemsResponse$inboundSchema: z.ZodType<
+  LineItemsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: LineItemsResponseObject$inboundSchema,
+  data: z.array(LineItem$inboundSchema),
+  totalCount: z.number().int(),
+  summary: LineItemsSummary$inboundSchema,
+});
+
+export function lineItemsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<LineItemsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LineItemsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LineItemsResponse' from JSON`,
+  );
+}

package/src/models/lineitemssummary.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 LineItemsSummary = {
+  /**
+   * Sum of fee items with known subtotals in decimal format
+   */
+  feeSubtotal: string;
+  /**
+   * Sum of estimated metered amounts in decimal format
+   */
+  meteredEstimatedSubtotal: string;
+  /**
+   * ISO 4217 currency code
+   */
+  currency: string;
+};
+
+/** @internal */
+export const LineItemsSummary$inboundSchema: z.ZodType<
+  LineItemsSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  feeSubtotal: z.string(),
+  meteredEstimatedSubtotal: z.string(),
+  currency: z.string(),
+});
+
+export function lineItemsSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<LineItemsSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LineItemsSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LineItemsSummary' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -55,6 +55,7 @@ export * from "./listentitlements.js";
 export * from "./listfeatures.js";
 export * from "./listfees.js";
 export * from "./listinvoices.js";
+export * from "./listlineitems.js";
 export * from "./listpayments.js";
 export * from "./listplans.js";
 export * from "./listprices.js";

package/src/models/operations/listlineitems.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Filter by line item status. 'pending' returns items not yet on an invoice, 'invoiced' returns items already assigned to an invoice. Omit to return both. Cannot be combined with invoiceId — when filtering by invoice ID all statuses are returned.
+ */
+export const ListLineItemsStatus = {
+  Pending: "pending",
+  Invoiced: "invoiced",
+} as const;
+/**
+ * Filter by line item status. 'pending' returns items not yet on an invoice, 'invoiced' returns items already assigned to an invoice. Omit to return both. Cannot be combined with invoiceId — when filtering by invoice ID all statuses are returned.
+ */
+export type ListLineItemsStatus = ClosedEnum<typeof ListLineItemsStatus>;
+
+export type ListLineItemsRequest = {
+  /**
+   * Filter by subscription ID. At least one of subscriptionId or invoiceId must be provided.
+   */
+  subscriptionId?: string | undefined;
+  /**
+   * Filter by line item status. 'pending' returns items not yet on an invoice, 'invoiced' returns items already assigned to an invoice. Omit to return both. Cannot be combined with invoiceId — when filtering by invoice ID all statuses are returned.
+   */
+  status?: ListLineItemsStatus | undefined;
+  /**
+   * Filter by invoice ID. When provided without subscriptionId, returns all line items for that invoice. At least one of subscriptionId or invoiceId must be provided.
+   */
+  invoiceId?: string | undefined;
+  /**
+   * Maximum number of line items to return
+   */
+  limit?: number | undefined;
+  /**
+   * Number of line items to skip for pagination
+   */
+  offset?: number | undefined;
+};
+
+/** @internal */
+export const ListLineItemsStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ListLineItemsStatus
+> = z.nativeEnum(ListLineItemsStatus);
+
+/** @internal */
+export type ListLineItemsRequest$Outbound = {
+  subscriptionId?: string | undefined;
+  status?: string | undefined;
+  invoiceId?: string | undefined;
+  limit: number;
+  offset: number;
+};
+
+/** @internal */
+export const ListLineItemsRequest$outboundSchema: z.ZodType<
+  ListLineItemsRequest$Outbound,
+  z.ZodTypeDef,
+  ListLineItemsRequest
+> = z.object({
+  subscriptionId: z.string().optional(),
+  status: ListLineItemsStatus$outboundSchema.optional(),
+  invoiceId: z.string().optional(),
+  limit: z.number().int().default(100),
+  offset: z.number().int().default(0),
+});
+
+export function listLineItemsRequestToJSON(
+  listLineItemsRequest: ListLineItemsRequest,
+): string {
+  return JSON.stringify(
+    ListLineItemsRequest$outboundSchema.parse(listLineItemsRequest),
+  );
+}

package/src/models/payment.ts

@@ -13,7 +13,7 @@ export const PaymentObject = {
 } as const;
 export type PaymentObject = ClosedEnum<typeof PaymentObject>;
 
-export type LineItem = {
+export type PaymentLineItem = {
   description?: string | undefined;
   amount?: string | undefined;
   quantity?: number | undefined;
@@ -71,7 +71,7 @@ export type Payment = {
   /**
    * Breakdown of what the customer is being charged for.
    */
-  lineItems?: Array<LineItem> | undefined;
+  lineItems?: Array<PaymentLineItem> | undefined;
   /**
    * Current status of the payment.
    */
@@ -92,8 +92,8 @@ export const PaymentObject$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(PaymentObject);
 
 /** @internal */
-export const LineItem$inboundSchema: z.ZodType<
-  LineItem,
+export const PaymentLineItem$inboundSchema: z.ZodType<
+  PaymentLineItem,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -102,13 +102,13 @@ export const LineItem$inboundSchema: z.ZodType<
   quantity: z.number().int().optional(),
 });
 
-export function lineItemFromJSON(
+export function paymentLineItemFromJSON(
   jsonString: string,
-): SafeParseResult<LineItem, SDKValidationError> {
+): SafeParseResult<PaymentLineItem, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => LineItem$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'LineItem' from JSON`,
+    (x) => PaymentLineItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentLineItem' from JSON`,
   );
 }
 
@@ -129,7 +129,7 @@ export const Payment$inboundSchema: z.ZodType<Payment, z.ZodTypeDef, unknown> =
     idempotencyKey: z.string().optional(),
     reference: z.string().optional(),
     metadata: z.record(z.string()).optional(),
-    lineItems: z.array(z.lazy(() => LineItem$inboundSchema)).optional(),
+    lineItems: z.array(z.lazy(() => PaymentLineItem$inboundSchema)).optional(),
     status: PaymentStatus$inboundSchema,
     expiresAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
       .optional(),

package/src/sdk/invoicesv2.ts

@@ -2,9 +2,11 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { invoicesV2CreateLineItem } from "../funcs/invoicesV2CreateLineItem.js";
 import { invoicesV2Get } from "../funcs/invoicesV2Get.js";
 import { invoicesV2GetLineItems } from "../funcs/invoicesV2GetLineItems.js";
 import { invoicesV2List } from "../funcs/invoicesV2List.js";
+import { invoicesV2ListLineItems } from "../funcs/invoicesV2ListLineItems.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
@@ -28,6 +30,40 @@ export class InvoicesV2 extends ClientSDK {
     ));
   }
 
+  /**
+   * List Line Items
+   *
+   * @remarks
+   * List pending and invoiced line items for a subscription from the billing database. Returns exact fee amounts and estimated metered charges.
+   */
+  async listLineItems(
+    request?: operations.ListLineItemsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.LineItemsResponse> {
+    return unwrapAsync(invoicesV2ListLineItems(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create Manual Line Item
+   *
+   * @remarks
+   * Create a manual line item for a billing v1 subscription. Manual line items are ad-hoc charges or credits that flow through the same collection pipeline as auto-generated items. Exactly one of subscriptionId or invoiceId must be provided.
+   */
+  async createLineItem(
+    request: models.CreateManualLineItemRequest,
+    options?: RequestOptions,
+  ): Promise<models.LineItem> {
+    return unwrapAsync(invoicesV2CreateLineItem(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get
    *