@paygentic/sdk 0.9.17 → 0.9.18

package/src/models/revenueaccounttotal.ts

@@ -0,0 +1,43 @@
+/*
+ * 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";
+import {
+  OutstandingBlock,
+  OutstandingBlock$inboundSchema,
+} from "./outstandingblock.js";
+
+export type RevenueAccountTotal = {
+  /**
+   * ISO 4217 currency code of every amount in this entry
+   */
+  currency: string;
+  /**
+   * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount.
+   */
+  outstanding: OutstandingBlock;
+};
+
+/** @internal */
+export const RevenueAccountTotal$inboundSchema: z.ZodType<
+  RevenueAccountTotal,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  outstanding: OutstandingBlock$inboundSchema,
+});
+
+export function revenueAccountTotalFromJSON(
+  jsonString: string,
+): SafeParseResult<RevenueAccountTotal, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RevenueAccountTotal$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RevenueAccountTotal' from JSON`,
+  );
+}

package/src/models/revenuesummaryresponse.ts

@@ -46,6 +46,10 @@ export type RevenueSummaryResponse = {
    * Object type identifier
    */
   object: "revenue_summary";
+  /**
+   * ISO 4217 currency code every figure in the response is in: the requested currency, or the merchant's primary currency when none was requested. Omitted when groupBy=currency is active.
+   */
+  currency?: string | undefined;
   /**
    * Revenue: what was billed in the period, excluding tax, in units of the currency. On the default issue-date basis it is recognised when each invoice is issued; with periodBasis=billingPeriod, each invoice line counts in the period it bills, and a refund splits across its invoice's lines. An invoice counts whether it was since paid, is still outstanding, failed payment or was written off, less non-voided refunds. It is billings, not cash collected: what customers still owe is invoices.outstanding, including tax, and payment-link collections are under payments. Omitted when groupBy=currency is active.
    */
@@ -114,6 +118,7 @@ export const RevenueSummaryResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   object: z.literal("revenue_summary"),
+  currency: z.string().optional(),
   netRevenue: z.string().optional(),
   totalRefunds: z.string().optional(),
   refundCount: z.number().optional(),

package/src/sdk/revenue.ts

@@ -3,6 +3,7 @@
  */
 
 import { revenueGet } from "../funcs/revenueGet.js";
+import { revenueGetRevenueAccounts } from "../funcs/revenueGetRevenueAccounts.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
@@ -25,4 +26,25 @@ export class Revenue extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List customer accounts
+   *
+   * @remarks
+   * Returns each customer's account as at today, one row per customer and currency, with a total per currency. Every figure covers all dates: there is no date window.
+   *
+   * `outstanding` is what customers owe: every invoice with status `ISSUED` or `PAYMENT_FAILED`, at the amount due printed on the invoice (subtotal and tax, each rounded to the currency's minor unit), so it is gross of tax. Revenue (`GET /v0/revenue`) is net of tax. `outstanding` splits into `awaitingPayment` (status `ISSUED`) and `paymentFailed` (status `PAYMENT_FAILED`, collection has ended); the two always add up to it, in count and amount. A credit invoice (a negative amount due) nets against what is owed and is counted in no `count`; nor is an invoice whose amount due rounds to zero. A customer with nothing counted and nothing owed has no row.
+   *
+   * Amounts are grouped by currency and never combined or converted. `totals` covers every row in the filter, not only the returned page, so the rows on one page add up to `totals` only when the page holds every row. Pages fetched in separate requests are separate reads.
+   */
+  async getRevenueAccounts(
+    request: operations.GetRevenueAccountsRequest,
+    options?: RequestOptions,
+  ): Promise<models.RevenueAccountsResponse> {
+    return unwrapAsync(revenueGetRevenueAccounts(
+      this,
+      request,
+      options,
+    ));
+  }
 }