@paygentic/sdk 0.9.17 → 0.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paygentic/sdk",
-  "version": "0.9.17",
+  "version": "0.10.0",
   "author": "Speakeasy",
   "license": "MIT",
   "repository": {

package/src/funcs/revenueGetRevenueAccounts.ts

@@ -0,0 +1,186 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PaygenticCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { PaygenticError } from "../models/errors/paygenticerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function revenueGetRevenueAccounts(
+  client: PaygenticCore,
+  request: operations.GetRevenueAccountsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.RevenueAccountsResponse,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PaygenticCore,
+  request: operations.GetRevenueAccountsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.RevenueAccountsResponse,
+      | errors.BadRequest
+      | errors.ErrorT
+      | PaygenticError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetRevenueAccountsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v0/revenue/accounts")();
+
+  const query = encodeFormQuery({
+    "customerIds": payload.customerIds,
+    "limit": payload.limit,
+    "merchantId": payload.merchantId,
+    "offset": payload.offset,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getRevenueAccounts",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.RevenueAccountsResponse,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.RevenueAccountsResponse$inboundSchema),
+    M.jsonErr(400, errors.BadRequest$inboundSchema),
+    M.jsonErr([401, 403, 404], errors.ErrorT$inboundSchema),
+    M.jsonErr(500, errors.ErrorT$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -65,7 +65,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.9.17",
+  sdkVersion: "0.10.0",
   genVersion: "2.879.13",
-  userAgent: "speakeasy-sdk/typescript 0.9.17 2.879.13 0.1.0 @paygentic/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.10.0 2.879.13 0.1.0 @paygentic/sdk",
 } as const;

package/src/models/accountfigure.ts

@@ -0,0 +1,42 @@
+/*
+ * 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";
+
+/**
+ * A number of invoices and their total amount due, gross of tax.
+ */
+export type AccountFigure = {
+  /**
+   * Number of 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
+   */
+  amount: string;
+};
+
+/** @internal */
+export const AccountFigure$inboundSchema: z.ZodType<
+  AccountFigure,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  amount: z.string(),
+});
+
+export function accountFigureFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountFigure, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountFigure$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountFigure' from JSON`,
+  );
+}

package/src/models/authorizationdenialreason.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.
+ */
+export const AuthorizationDenialReason = {
+  NoPermission: "no_permission",
+  InsufficientScope: "insufficient_scope",
+  NotMember: "not_member",
+} as const;
+/**
+ * Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.
+ */
+export type AuthorizationDenialReason = ClosedEnum<
+  typeof AuthorizationDenialReason
+>;
+
+/** @internal */
+export const AuthorizationDenialReason$inboundSchema: z.ZodNativeEnum<
+  typeof AuthorizationDenialReason
+> = z.nativeEnum(AuthorizationDenialReason);

package/src/models/errors/error.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod/v3";
+import * as models from "../index.js";
 import { PaygenticError } from "./paygenticerror.js";
 
 export type ErrorTData = {
@@ -22,6 +23,14 @@ export type ErrorTData = {
    * Additional error details
    */
   details?: { [k: string]: any } | undefined;
+  /**
+   * Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.
+   */
+  reason?: models.AuthorizationDenialReason | undefined;
+  /**
+   * Present on a 403 from the authorization check. The permissions the caller needs for this request.
+   */
+  requiredPermissions?: Array<string> | undefined;
 };
 
 export class ErrorT extends PaygenticError {
@@ -37,6 +46,14 @@ export class ErrorT extends PaygenticError {
    * Additional error details
    */
   details?: { [k: string]: any } | undefined;
+  /**
+   * Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.
+   */
+  reason?: models.AuthorizationDenialReason | undefined;
+  /**
+   * Present on a 403 from the authorization check. The permissions the caller needs for this request.
+   */
+  requiredPermissions?: Array<string> | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: ErrorTData;
@@ -51,6 +68,10 @@ export class ErrorT extends PaygenticError {
     if (err.error != null) this.error = err.error;
     if (err.code != null) this.code = err.code;
     if (err.details != null) this.details = err.details;
+    if (err.reason != null) this.reason = err.reason;
+    if (err.requiredPermissions != null) {
+      this.requiredPermissions = err.requiredPermissions;
+    }
 
     this.name = "ErrorT";
   }
@@ -63,6 +84,8 @@ export const ErrorT$inboundSchema: z.ZodType<ErrorT, z.ZodTypeDef, unknown> = z
     message: z.string(),
     code: z.string().optional(),
     details: z.record(z.any()).optional(),
+    reason: models.AuthorizationDenialReason$inboundSchema.optional(),
+    requiredPermissions: z.array(z.string()).optional(),
     request$: z.instanceof(Request),
     response$: z.instanceof(Response),
     body$: z.string(),

package/src/models/errors/recordinvoicepayment.ts

@@ -26,6 +26,14 @@ export type UnprocessableEntityErrorData = {
    * Additional error details
    */
   details?: { [k: string]: any } | undefined;
+  /**
+   * Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.
+   */
+  reason?: models.AuthorizationDenialReason | undefined;
+  /**
+   * Present on a 403 from the authorization check. The permissions the caller needs for this request.
+   */
+  requiredPermissions?: Array<string> | undefined;
 };
 
 /**
@@ -44,6 +52,14 @@ export class UnprocessableEntityError extends PaygenticError {
    * Additional error details
    */
   details?: { [k: string]: any } | undefined;
+  /**
+   * Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.
+   */
+  reason?: models.AuthorizationDenialReason | undefined;
+  /**
+   * Present on a 403 from the authorization check. The permissions the caller needs for this request.
+   */
+  requiredPermissions?: Array<string> | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: UnprocessableEntityErrorData;
@@ -58,6 +74,10 @@ export class UnprocessableEntityError extends PaygenticError {
     this.error = err.error;
     this.code = err.code;
     if (err.details != null) this.details = err.details;
+    if (err.reason != null) this.reason = err.reason;
+    if (err.requiredPermissions != null) {
+      this.requiredPermissions = err.requiredPermissions;
+    }
 
     this.name = "UnprocessableEntityError";
   }
@@ -73,6 +93,8 @@ export const UnprocessableEntityError$inboundSchema: z.ZodType<
   message: z.string(),
   code: models.InvoicePaymentLinkErrorCode$inboundSchema,
   details: z.record(z.any()).optional(),
+  reason: models.AuthorizationDenialReason$inboundSchema.optional(),
+  requiredPermissions: z.array(z.string()).optional(),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),

package/src/models/index.ts

@@ -2,9 +2,11 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./accountfigure.js";
 export * from "./address.js";
 export * from "./approval.js";
 export * from "./approvallist.js";
+export * from "./authorizationdenialreason.js";
 export * from "./billablemetric.js";
 export * from "./billingschedule.js";
 export * from "./booleanentitlementdetail.js";
@@ -60,9 +62,23 @@ export * from "./invoicerefundlist.js";
 export * from "./invoicesummary.js";
 export * from "./issueentitlementrequest.js";
 export * from "./item.js";
+export * from "./linecalculationcontribution.js";
+export * from "./linecalculationgiven.js";
+export * from "./linecalculationinputprice.js";
+export * from "./linecalculationinputs.js";
+export * from "./linecalculationnotapplied.js";
+export * from "./linecalculationperiod.js";
+export * from "./linecalculationprecision.js";
+export * from "./linecalculationpriceband.js";
+export * from "./linecalculationpricefn.js";
+export * from "./linecalculationresult.js";
+export * from "./linecalculationsource.js";
+export * from "./linecalculationstep.js";
+export * from "./linecalculationvalue.js";
 export * from "./lineitem.js";
 export * from "./lineitemsresponse.js";
 export * from "./lineitemssummary.js";
+export * from "./lineprovenance.js";
 export * from "./mappingcapabilities.js";
 export * from "./merchantintegration.js";
 export * from "./merchantintegrationprovider.js";
@@ -84,6 +100,7 @@ export * from "./orderbillingschedule.js";
 export * from "./orderlineitem.js";
 export * from "./orderlist.js";
 export * from "./outofbandpaymentresult.js";
+export * from "./outstandingblock.js";
 export * from "./payment.js";
 export * from "./paymentmethod.js";
 export * from "./paymentsession.js";
@@ -117,6 +134,9 @@ export * from "./replacescheduleintervalsrequest.js";
 export * from "./resolveditem.js";
 export * from "./retrypaymenterror.js";
 export * from "./retrypaymentresponse.js";
+export * from "./revenueaccountrow.js";
+export * from "./revenueaccountsresponse.js";
+export * from "./revenueaccounttotal.js";
 export * from "./revenuesummaryresponse.js";
 export * from "./revenuetrendbucket.js";
 export * from "./rulecondition.js";

package/src/models/invoicelineitem.ts

@@ -7,6 +7,10 @@ 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 {
+  LineProvenance,
+  LineProvenance$inboundSchema,
+} from "./lineprovenance.js";
 
 /**
  * Type of event: 'usage' for billable metric events, 'fee' for fee events, 'discount' for grant discount line items (subtotal/total are negative, representing a credit)
@@ -134,6 +138,10 @@ export type InvoiceLineItem = {
    * Unit price in decimal dollars
    */
   unitPrice: string;
+  /**
+   * How the line's amount before tax was calculated: a trace of one evaluation, saved when the invoice was calculated and fixed once it is issued. Returned only with `expand=lineProvenance`. Every field but `status` is present when `status` is `recorded`. Every number is a plain decimal string.
+   */
+  provenance?: LineProvenance | undefined;
 };
 
 /** @internal */
@@ -179,6 +187,7 @@ export const InvoiceLineItem$inboundSchema: z.ZodType<
   totalPrice: z.string(),
   totalTax: z.string(),
   unitPrice: z.string(),
+  provenance: LineProvenance$inboundSchema.optional(),
 });
 
 export function invoiceLineItemFromJSON(

package/src/models/linecalculationcontribution.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 LineCalculationContribution = {
+  lineItemId: string;
+  value: string;
+  share: string | null;
+};
+
+/** @internal */
+export const LineCalculationContribution$inboundSchema: z.ZodType<
+  LineCalculationContribution,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lineItemId: z.string(),
+  value: z.string(),
+  share: z.nullable(z.string()),
+});
+
+export function lineCalculationContributionFromJSON(
+  jsonString: string,
+): SafeParseResult<LineCalculationContribution, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LineCalculationContribution$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LineCalculationContribution' from JSON`,
+  );
+}

package/src/models/linecalculationgiven.ts

@@ -0,0 +1,42 @@
+/*
+ * 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";
+
+/**
+ * A value the evaluation started from, and its source.
+ */
+export type LineCalculationGiven = {
+  /**
+   * The value.
+   */
+  value: string;
+  /**
+   * The key of the source in `sources` that stated it.
+   */
+  source: string;
+};
+
+/** @internal */
+export const LineCalculationGiven$inboundSchema: z.ZodType<
+  LineCalculationGiven,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  value: z.string(),
+  source: z.string(),
+});
+
+export function lineCalculationGivenFromJSON(
+  jsonString: string,
+): SafeParseResult<LineCalculationGiven, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LineCalculationGiven$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LineCalculationGiven' from JSON`,
+  );
+}

package/src/models/linecalculationinputprice.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 {
+  LineCalculationPriceFn,
+  LineCalculationPriceFn$inboundSchema,
+} from "./linecalculationpricefn.js";
+
+/**
+ * `priced` only: the price as a function, and its source.
+ */
+export type LineCalculationInputPrice = {
+  /**
+   * A price as a function from quantity to money. A new model may carry fields not listed here.
+   */
+  fn: LineCalculationPriceFn;
+  /**
+   * The key of the source in `sources` that stated the price.
+   */
+  source: string;
+};
+
+/** @internal */
+export const LineCalculationInputPrice$inboundSchema: z.ZodType<
+  LineCalculationInputPrice,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fn: LineCalculationPriceFn$inboundSchema,
+  source: z.string(),
+});
+
+export function lineCalculationInputPriceFromJSON(
+  jsonString: string,
+): SafeParseResult<LineCalculationInputPrice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LineCalculationInputPrice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LineCalculationInputPrice' from JSON`,
+  );
+}

package/src/models/linecalculationinputs.ts

@@ -0,0 +1,65 @@
+/*
+ * 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 {
+  LineCalculationGiven,
+  LineCalculationGiven$inboundSchema,
+} from "./linecalculationgiven.js";
+import {
+  LineCalculationInputPrice,
+  LineCalculationInputPrice$inboundSchema,
+} from "./linecalculationinputprice.js";
+
+/**
+ * The values the evaluation started from.
+ */
+export type LineCalculationInputs = {
+  /**
+   * `priced`: a charge from a price, with `quantity`, `selector` and `price`. `fromLine`: a line whose base is another line's amount, with `amount`. `given`: an amount nobody priced on this run, with `amount`. An open set, so it is a string rather than an enum: known values are `priced`, `fromLine`, `given`, and new values may be added.
+   */
+  kind: string;
+  /**
+   * A value the evaluation started from, and its source.
+   */
+  quantity?: LineCalculationGiven | undefined;
+  /**
+   * A value the evaluation started from, and its source.
+   */
+  selector?: LineCalculationGiven | undefined;
+  /**
+   * `priced` only: the price as a function, and its source.
+   */
+  price?: LineCalculationInputPrice | undefined;
+  /**
+   * A value the evaluation started from, and its source.
+   */
+  amount?: LineCalculationGiven | undefined;
+};
+
+/** @internal */
+export const LineCalculationInputs$inboundSchema: z.ZodType<
+  LineCalculationInputs,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  kind: z.string(),
+  quantity: LineCalculationGiven$inboundSchema.optional(),
+  selector: LineCalculationGiven$inboundSchema.optional(),
+  price: LineCalculationInputPrice$inboundSchema.optional(),
+  amount: LineCalculationGiven$inboundSchema.optional(),
+});
+
+export function lineCalculationInputsFromJSON(
+  jsonString: string,
+): SafeParseResult<LineCalculationInputs, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LineCalculationInputs$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LineCalculationInputs' from JSON`,
+  );
+}