@paygentic/sdk 0.9.16 → 0.9.18

package/src/models/operations/getrevenueaccounts.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetRevenueAccountsRequest = {
+  /**
+   * Merchant whose customer accounts to report
+   */
+  merchantId: string;
+  /**
+   * Limit the rows and the totals to these customers of the merchant. A customer of another merchant, or one that does not exist, returns 404. A customer billed in several currencies has a row for each, so set `limit` to cover them.
+   */
+  customerIds?: Array<string> | undefined;
+  /**
+   * Number of rows to return
+   */
+  limit?: number | undefined;
+  /**
+   * Number of rows to skip
+   */
+  offset?: number | undefined;
+};
+
+/** @internal */
+export type GetRevenueAccountsRequest$Outbound = {
+  merchantId: string;
+  customerIds?: Array<string> | undefined;
+  limit: number;
+  offset: number;
+};
+
+/** @internal */
+export const GetRevenueAccountsRequest$outboundSchema: z.ZodType<
+  GetRevenueAccountsRequest$Outbound,
+  z.ZodTypeDef,
+  GetRevenueAccountsRequest
+> = z.object({
+  merchantId: z.string(),
+  customerIds: z.array(z.string()).optional(),
+  limit: z.number().int().default(50),
+  offset: z.number().int().default(0),
+});
+
+export function getRevenueAccountsRequestToJSON(
+  getRevenueAccountsRequest: GetRevenueAccountsRequest,
+): string {
+  return JSON.stringify(
+    GetRevenueAccountsRequest$outboundSchema.parse(getRevenueAccountsRequest),
+  );
+}

package/src/models/operations/index.ts

@@ -71,6 +71,7 @@ export * from "./getprice.js";
 export * from "./getproduct.js";
 export * from "./getprofitability.js";
 export * from "./getrevenue.js";
+export * from "./getrevenueaccounts.js";
 export * from "./getsource.js";
 export * from "./getsourcerule.js";
 export * from "./getsubscription.js";

package/src/models/outstandingblock.ts

@@ -0,0 +1,53 @@
+/*
+ * 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 { AccountFigure, AccountFigure$inboundSchema } from "./accountfigure.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount.
+ */
+export type OutstandingBlock = {
+  /**
+   * Number of unpaid invoices with an amount due above zero. A credit invoice, or one whose amount due rounds to zero, is not counted.
+   */
+  count: number;
+  /**
+   * Total amount due in major units of the currency, in its decimal places (for example "123.00"). Negative when credits exceed what is owed.
+   */
+  amount: string;
+  /**
+   * The part with status `ISSUED`, including any credit invoice
+   */
+  awaitingPayment: AccountFigure;
+  /**
+   * The part with status `PAYMENT_FAILED`: collection has ended
+   */
+  paymentFailed: AccountFigure;
+};
+
+/** @internal */
+export const OutstandingBlock$inboundSchema: z.ZodType<
+  OutstandingBlock,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  amount: z.string(),
+  awaitingPayment: AccountFigure$inboundSchema,
+  paymentFailed: AccountFigure$inboundSchema,
+});
+
+export function outstandingBlockFromJSON(
+  jsonString: string,
+): SafeParseResult<OutstandingBlock, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OutstandingBlock$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OutstandingBlock' from JSON`,
+  );
+}

package/src/models/revenueaccountrow.ts

@@ -0,0 +1,53 @@
+/*
+ * 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 RevenueAccountRow = {
+  /**
+   * Customer ID
+   */
+  customerId: string;
+  /**
+   * Customer display name, or the customer ID when no name is recorded. A deleted customer who still owes money keeps its row.
+   */
+  customerName: string;
+  /**
+   * ISO 4217 currency code of every amount in this row
+   */
+  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 RevenueAccountRow$inboundSchema: z.ZodType<
+  RevenueAccountRow,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  customerId: z.string(),
+  customerName: z.string(),
+  currency: z.string(),
+  outstanding: OutstandingBlock$inboundSchema,
+});
+
+export function revenueAccountRowFromJSON(
+  jsonString: string,
+): SafeParseResult<RevenueAccountRow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RevenueAccountRow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RevenueAccountRow' from JSON`,
+  );
+}

package/src/models/revenueaccountsresponse.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 {
+  OffsetPagination,
+  OffsetPagination$inboundSchema,
+} from "./offsetpagination.js";
+import {
+  RevenueAccountRow,
+  RevenueAccountRow$inboundSchema,
+} from "./revenueaccountrow.js";
+import {
+  RevenueAccountTotal,
+  RevenueAccountTotal$inboundSchema,
+} from "./revenueaccounttotal.js";
+
+/**
+ * Object type identifier
+ */
+export const RevenueAccountsResponseObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type RevenueAccountsResponseObject = ClosedEnum<
+  typeof RevenueAccountsResponseObject
+>;
+
+export type RevenueAccountsResponse = {
+  /**
+   * Object type identifier
+   */
+  object: RevenueAccountsResponseObject;
+  /**
+   * One entry per currency with at least one row in the filter, over every row and not only this page. The merchant's primary currency comes first, then the rest in alphabetical order. Empty when there are no rows.
+   */
+  totals: Array<RevenueAccountTotal>;
+  /**
+   * One row per customer and currency with at least one unpaid invoice, in the currency order of `totals`, then by `outstanding.amount` descending, then by `customerId`. A customer billed in two currencies has two rows.
+   */
+  data: Array<RevenueAccountRow>;
+  /**
+   * Offset-based pagination response.
+   */
+  pagination: OffsetPagination;
+};
+
+/** @internal */
+export const RevenueAccountsResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof RevenueAccountsResponseObject
+> = z.nativeEnum(RevenueAccountsResponseObject);
+
+/** @internal */
+export const RevenueAccountsResponse$inboundSchema: z.ZodType<
+  RevenueAccountsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: RevenueAccountsResponseObject$inboundSchema,
+  totals: z.array(RevenueAccountTotal$inboundSchema),
+  data: z.array(RevenueAccountRow$inboundSchema),
+  pagination: OffsetPagination$inboundSchema,
+});
+
+export function revenueAccountsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RevenueAccountsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RevenueAccountsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RevenueAccountsResponse' from JSON`,
+  );
+}

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,
+    ));
+  }
 }