@paygentic/sdk 0.9.15 → 0.9.17

package/src/funcs/webhooksUpdate.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PaygenticCore } from "../core.js";
+import { encodeFormQuery, encodeJSON } 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";
+
+/**
+ * Update
+ *
+ * @remarks
+ * Turns webhook delivery on or off. Set `enabled` to `false` to pause delivery and to `true` to resume it. Endpoints and their event subscriptions are kept. Returns 404 if webhooks have never been enabled.
+ */
+export function webhooksUpdate(
+  client: PaygenticCore,
+  request: operations.UpdateWebhooksRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.Webhooks,
+    | 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.UpdateWebhooksRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.Webhooks,
+      | errors.BadRequest
+      | errors.ErrorT
+      | PaygenticError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.UpdateWebhooksRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+
+  const path = pathToFunc("/v0/webhooks")();
+
+  const query = encodeFormQuery({
+    "merchantId": payload.merchantId,
+  });
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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: "updateWebhooks",
+    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: "PATCH",
+    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", "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.Webhooks,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.Webhooks$inboundSchema),
+    M.jsonErr(400, errors.BadRequest$inboundSchema),
+    M.jsonErr([401, 403, 404], 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.15",
+  sdkVersion: "0.9.17",
   genVersion: "2.879.13",
-  userAgent: "speakeasy-sdk/typescript 0.9.15 2.879.13 0.1.0 @paygentic/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.9.17 2.879.13 0.1.0 @paygentic/sdk",
 } as const;

package/src/models/currencybreakdownentry.ts

@@ -25,7 +25,7 @@ export type CurrencyBreakdownEntry = {
    */
   currency: string;
   /**
-   * Revenue in dollars for this currency, excluding tax: invoices issued in the period plus completed payments
+   * Revenue for this currency: what was billed in the period, excluding tax, in units of this 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, the same way as the ungrouped netRevenue. It is billings, not cash collected: what customers still owe is invoices.outstanding, including tax, and payment-link collections are under payments.
    */
   netRevenue: string;
   invoices: InvoiceSummary;

package/src/models/elapsedperiodbilling.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Whether a backdated start bills its elapsed periods. A start is backdated when `startedAt` is more than 24 hours before the subscription is created. `none` bills only charges that fall due from the moment of creation, for a customer whose earlier periods another system already billed. `per_period` bills every charge that fell due from `startedAt`, on one first invoice; it refuses a `startedAt` more than 12 months back. Has no effect on a start that is not backdated. Defaults to `none`.
+ */
+export const ElapsedPeriodBilling = {
+  None: "none",
+  PerPeriod: "per_period",
+} as const;
+/**
+ * Whether a backdated start bills its elapsed periods. A start is backdated when `startedAt` is more than 24 hours before the subscription is created. `none` bills only charges that fall due from the moment of creation, for a customer whose earlier periods another system already billed. `per_period` bills every charge that fell due from `startedAt`, on one first invoice; it refuses a `startedAt` more than 12 months back. Has no effect on a start that is not backdated. Defaults to `none`.
+ */
+export type ElapsedPeriodBilling = ClosedEnum<typeof ElapsedPeriodBilling>;
+
+/** @internal */
+export const ElapsedPeriodBilling$outboundSchema: z.ZodNativeEnum<
+  typeof ElapsedPeriodBilling
+> = z.nativeEnum(ElapsedPeriodBilling);

package/src/models/errors/index.ts

@@ -10,7 +10,9 @@ export * from "./error.js";
 export * from "./httpclienterrors.js";
 export * from "./paygenticdefaulterror.js";
 export * from "./paygenticerror.js";
+export * from "./recordinvoicepayment.js";
 export * from "./responsevalidationerror.js";
+export * from "./retrypaymentresponseerror.js";
 export * from "./sdkvalidationerror.js";
 export * from "./updateprice.js";
 export * from "./validationerror.js";

package/src/models/errors/recordinvoicepayment.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { PaygenticError } from "./paygenticerror.js";
+
+/**
+ * `hosted_link` only: Paygentic cannot create a payment link. The `code` field gives the cause: `INVOICE_NOT_LINKABLE_STATUS` (the invoice is not `ISSUED` or `PAYMENT_FAILED`; do not retry), `INVOICE_NO_BALANCE` (no amount is unpaid; treat the invoice as paid), or `MERCHANT_NO_PAYMENT_ACCOUNT` (the merchant has no connected payment account; retry after onboarding is complete).
+ */
+export type UnprocessableEntityErrorData = {
+  /**
+   * Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.
+   */
+  error: string;
+  /**
+   * Human-readable error message. Clients must not parse this field programmatically.
+   */
+  message: string;
+  /**
+   * Why Paygentic cannot create a payment link for the invoice.
+   */
+  code: models.InvoicePaymentLinkErrorCode;
+  /**
+   * Additional error details
+   */
+  details?: { [k: string]: any } | undefined;
+};
+
+/**
+ * `hosted_link` only: Paygentic cannot create a payment link. The `code` field gives the cause: `INVOICE_NOT_LINKABLE_STATUS` (the invoice is not `ISSUED` or `PAYMENT_FAILED`; do not retry), `INVOICE_NO_BALANCE` (no amount is unpaid; treat the invoice as paid), or `MERCHANT_NO_PAYMENT_ACCOUNT` (the merchant has no connected payment account; retry after onboarding is complete).
+ */
+export class UnprocessableEntityError extends PaygenticError {
+  /**
+   * Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.
+   */
+  error: string;
+  /**
+   * Why Paygentic cannot create a payment link for the invoice.
+   */
+  code: models.InvoicePaymentLinkErrorCode;
+  /**
+   * Additional error details
+   */
+  details?: { [k: string]: any } | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: UnprocessableEntityErrorData;
+
+  constructor(
+    err: UnprocessableEntityErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+    this.code = err.code;
+    if (err.details != null) this.details = err.details;
+
+    this.name = "UnprocessableEntityError";
+  }
+}
+
+/** @internal */
+export const UnprocessableEntityError$inboundSchema: z.ZodType<
+  UnprocessableEntityError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.string(),
+  message: z.string(),
+  code: models.InvoicePaymentLinkErrorCode$inboundSchema,
+  details: z.record(z.any()).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new UnprocessableEntityError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/errors/retrypaymentresponseerror.ts

@@ -0,0 +1,102 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { PaygenticError } from "./paygenticerror.js";
+
+/**
+ * The result of a payment retry. Every response status of the retry operation that is not an error envelope uses this shape.
+ */
+export type RetryPaymentResponseErrorData = {
+  /**
+   * The object type
+   */
+  object: models.RetryPaymentResponseObject;
+  /**
+   * True only when the charge succeeded or no amount is unpaid. The response status is 200 only when this is true.
+   */
+  success: boolean;
+  /**
+   * The invoice ID
+   */
+  invoiceId: string;
+  /**
+   * The provider's payment reference for the charge, when the provider has one.
+   */
+  paymentIntentId?: string | undefined;
+  /**
+   * Why a payment retry did not collect the money.
+   */
+  error?: models.RetryPaymentError | undefined;
+};
+
+/**
+ * The result of a payment retry. Every response status of the retry operation that is not an error envelope uses this shape.
+ */
+export class RetryPaymentResponseError extends PaygenticError {
+  /**
+   * The object type
+   */
+  object: models.RetryPaymentResponseObject;
+  /**
+   * True only when the charge succeeded or no amount is unpaid. The response status is 200 only when this is true.
+   */
+  success: boolean;
+  /**
+   * The invoice ID
+   */
+  invoiceId: string;
+  /**
+   * The provider's payment reference for the charge, when the provider has one.
+   */
+  paymentIntentId?: string | undefined;
+  /**
+   * Why a payment retry did not collect the money.
+   */
+  error?: models.RetryPaymentError | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: RetryPaymentResponseErrorData;
+
+  constructor(
+    err: RetryPaymentResponseErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.object = err.object;
+    this.success = err.success;
+    this.invoiceId = err.invoiceId;
+    if (err.paymentIntentId != null) this.paymentIntentId = err.paymentIntentId;
+    if (err.error != null) this.error = err.error;
+
+    this.name = "RetryPaymentResponseError";
+  }
+}
+
+/** @internal */
+export const RetryPaymentResponseError$inboundSchema: z.ZodType<
+  RetryPaymentResponseError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: models.RetryPaymentResponseObject$inboundSchema,
+  success: z.boolean(),
+  invoiceId: z.string(),
+  paymentIntentId: z.string().optional(),
+  error: models.RetryPaymentError$inboundSchema.optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new RetryPaymentResponseError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/grouptrendentry.ts

@@ -17,7 +17,11 @@ export type GroupTrendEntry = {
    */
   groupLabel: string;
   /**
-   * Total issued invoice amount in dollars for this group in this bucket, excluding tax
+   * Revenue for this group in this bucket, computed exactly as netRevenue. A group outside the top N, or with only a refund in the window, counts under 'other'.
+   */
+  revenue: string;
+  /**
+   * Total issued invoice amount in dollars for this group in this bucket, excluding tax, before refunds
    */
   issuedInvoices: string;
 };
@@ -30,6 +34,7 @@ export const GroupTrendEntry$inboundSchema: z.ZodType<
 > = z.object({
   groupKey: z.string(),
   groupLabel: z.string(),
+  revenue: z.string(),
   issuedInvoices: z.string(),
 });
 

package/src/models/hostedlinkpaymentresult.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 { Invoice, Invoice$inboundSchema } from "./invoice.js";
+import {
+  InvoicePaymentProvider,
+  InvoicePaymentProvider$inboundSchema,
+} from "./invoicepaymentprovider.js";
+
+export type HostedLinkPaymentResult = {
+  /**
+   * Discriminator: a hosted payment link was minted/regenerated.
+   */
+  method: "hosted_link";
+  /**
+   * The payment provider that a hosted payment link routes to.
+   */
+  provider: InvoicePaymentProvider;
+  /**
+   * The newly created payment session ID.
+   */
+  paymentSessionId: string;
+  /**
+   * The customer-facing payment link for the new session.
+   */
+  paymentUrl: string;
+  invoice: Invoice;
+};
+
+/** @internal */
+export const HostedLinkPaymentResult$inboundSchema: z.ZodType<
+  HostedLinkPaymentResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  method: z.literal("hosted_link"),
+  provider: InvoicePaymentProvider$inboundSchema,
+  paymentSessionId: z.string(),
+  paymentUrl: z.string(),
+  invoice: Invoice$inboundSchema,
+});
+
+export function hostedLinkPaymentResultFromJSON(
+  jsonString: string,
+): SafeParseResult<HostedLinkPaymentResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HostedLinkPaymentResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HostedLinkPaymentResult' from JSON`,
+  );
+}

package/src/models/index.ts

@@ -33,6 +33,7 @@ export * from "./customer.js";
 export * from "./customerpaymentsession.js";
 export * from "./editsubscriptionintervalsrequestunion.js";
 export * from "./editsubscriptionintervalsresponse.js";
+export * from "./elapsedperiodbilling.js";
 export * from "./entitlementdetail.js";
 export * from "./entitlementlistitem.js";
 export * from "./entitlementstatus.js";
@@ -45,11 +46,15 @@ export * from "./fee.js";
 export * from "./grant.js";
 export * from "./groupinvoicesummary.js";
 export * from "./grouptrendentry.js";
+export * from "./hostedlinkpaymentresult.js";
 export * from "./intervalchangemetadata.js";
 export * from "./invoice.js";
 export * from "./invoicecategorysummary.js";
 export * from "./invoicelineitem.js";
 export * from "./invoicelineitemsresponse.js";
+export * from "./invoicepaymentlinkerrorcode.js";
+export * from "./invoicepaymentmethod.js";
+export * from "./invoicepaymentprovider.js";
 export * from "./invoicerefund.js";
 export * from "./invoicerefundlist.js";
 export * from "./invoicesummary.js";
@@ -62,10 +67,13 @@ export * from "./mappingcapabilities.js";
 export * from "./merchantintegration.js";
 export * from "./merchantintegrationprovider.js";
 export * from "./merchantintegrationstatus.js";
+export * from "./merchantreset.js";
 export * from "./meteredentitlementdetail.js";
 export * from "./meteredentitlementlistitem.js";
 export * from "./meterevent.js";
 export * from "./metereventlist.js";
+export * from "./migratesubscriptionversionrequest.js";
+export * from "./migratesubscriptionversionresponse.js";
 export * from "./mintplanlineinput.js";
 export * from "./mintplanlineref.js";
 export * from "./mintplanversionrequest.js";
@@ -75,6 +83,7 @@ export * from "./orderapproval.js";
 export * from "./orderbillingschedule.js";
 export * from "./orderlineitem.js";
 export * from "./orderlist.js";
+export * from "./outofbandpaymentresult.js";
 export * from "./payment.js";
 export * from "./paymentmethod.js";
 export * from "./paymentsession.js";
@@ -106,6 +115,8 @@ export * from "./reconciledfeatureremoved.js";
 export * from "./reconciledfeatureskipped.js";
 export * from "./replacescheduleintervalsrequest.js";
 export * from "./resolveditem.js";
+export * from "./retrypaymenterror.js";
+export * from "./retrypaymentresponse.js";
 export * from "./revenuesummaryresponse.js";
 export * from "./revenuetrendbucket.js";
 export * from "./rulecondition.js";
@@ -144,3 +155,6 @@ export * from "./usageresponse.js";
 export * from "./user.js";
 export * from "./validationerror.js";
 export * from "./validtaxaddress.js";
+export * from "./versiontransition.js";
+export * from "./webhookportal.js";
+export * from "./webhooks.js";

package/src/models/invoice.ts

@@ -64,7 +64,7 @@ export const PdfSource = {
 export type PdfSource = ClosedEnum<typeof PdfSource>;
 
 /**
- * Why no Paygentic-rendered document exists for this invoice, or null when none was withheld. A tax-registered merchant's document is a compliance artefact, so it is withheld unless the recorded tax reconciles with the provider exactly and the registered issuer identity is complete. Non-null therefore always accompanies pdfSource `null`, and never `paygentic`: an invoice whose document is withheld is not served the provider's in its place, because recording that link would mark the invoice as already served and stop a later repair rendering ours. Use it to tell a withheld invoice apart from one that simply has no document yet — both report pdfSource `null`, and only a withheld one names why. An invoice the tax provider serves by design reports pdfSource `tax_provider` with no reason, and needs no repair. Both an invoice with no document and a withheld one can be repaired by POST /v2/invoices/{id}/generate-pdf. `tax_unreconciled`: the provider's tax figure was never recorded against this invoice. `issuer_identity_incomplete`: the registered legal name, tax ID or address could not be read. `tax_component_unpriceable`: a recorded tax component carried no presentable amount. `ledger_mismatch`: the recorded tax figures and the invoice's own totals disagree. `tax_provider_disagrees`: the provider re-read its filing and reported a different tax to the one this invoice was charged — terminal, because correcting an issued invoice is a credit note's job, so retrying the repair cannot clear it. New values may be added, so treat an unrecognised one as withheld rather than failing.
+ * Why no Paygentic-rendered document exists for this invoice, or null when none was withheld. A tax-registered merchant's document is a compliance artefact, so it is withheld unless the recorded tax reconciles with the provider exactly and the registered issuer identity is complete. Non-null therefore always accompanies pdfSource `null`, and never `paygentic`: an invoice whose document is withheld is not served the provider's in its place, because recording that link would mark the invoice as already served and stop a later repair rendering ours. Use it to tell a withheld invoice apart from one that simply has no document yet — both report pdfSource `null`, and only a withheld one names why. An invoice issued before Paygentic rendered every document can report pdfSource `tax_provider` with no reason, and needs no repair. Both an invoice with no document and a withheld one can be repaired by POST /v2/invoices/{id}/generate-pdf. `tax_unreconciled`: the provider's tax figure was never recorded against this invoice. `issuer_identity_incomplete`: the registered legal name, tax ID or address could not be read. `tax_component_unpriceable`: a recorded tax component carried no presentable amount. `ledger_mismatch`: the recorded tax figures and the invoice's own totals disagree. `tax_provider_disagrees`: the provider re-read its filing and reported a different tax to the one this invoice was charged — terminal, because correcting an issued invoice is a credit note's job, so retrying the repair cannot clear it. New values may be added, so treat an unrecognised one as withheld rather than failing.
  */
 export const DocumentWithheldReason = {
   TaxUnreconciled: "tax_unreconciled",
@@ -74,12 +74,12 @@ export const DocumentWithheldReason = {
   TaxProviderDisagrees: "tax_provider_disagrees",
 } as const;
 /**
- * Why no Paygentic-rendered document exists for this invoice, or null when none was withheld. A tax-registered merchant's document is a compliance artefact, so it is withheld unless the recorded tax reconciles with the provider exactly and the registered issuer identity is complete. Non-null therefore always accompanies pdfSource `null`, and never `paygentic`: an invoice whose document is withheld is not served the provider's in its place, because recording that link would mark the invoice as already served and stop a later repair rendering ours. Use it to tell a withheld invoice apart from one that simply has no document yet — both report pdfSource `null`, and only a withheld one names why. An invoice the tax provider serves by design reports pdfSource `tax_provider` with no reason, and needs no repair. Both an invoice with no document and a withheld one can be repaired by POST /v2/invoices/{id}/generate-pdf. `tax_unreconciled`: the provider's tax figure was never recorded against this invoice. `issuer_identity_incomplete`: the registered legal name, tax ID or address could not be read. `tax_component_unpriceable`: a recorded tax component carried no presentable amount. `ledger_mismatch`: the recorded tax figures and the invoice's own totals disagree. `tax_provider_disagrees`: the provider re-read its filing and reported a different tax to the one this invoice was charged — terminal, because correcting an issued invoice is a credit note's job, so retrying the repair cannot clear it. New values may be added, so treat an unrecognised one as withheld rather than failing.
+ * Why no Paygentic-rendered document exists for this invoice, or null when none was withheld. A tax-registered merchant's document is a compliance artefact, so it is withheld unless the recorded tax reconciles with the provider exactly and the registered issuer identity is complete. Non-null therefore always accompanies pdfSource `null`, and never `paygentic`: an invoice whose document is withheld is not served the provider's in its place, because recording that link would mark the invoice as already served and stop a later repair rendering ours. Use it to tell a withheld invoice apart from one that simply has no document yet — both report pdfSource `null`, and only a withheld one names why. An invoice issued before Paygentic rendered every document can report pdfSource `tax_provider` with no reason, and needs no repair. Both an invoice with no document and a withheld one can be repaired by POST /v2/invoices/{id}/generate-pdf. `tax_unreconciled`: the provider's tax figure was never recorded against this invoice. `issuer_identity_incomplete`: the registered legal name, tax ID or address could not be read. `tax_component_unpriceable`: a recorded tax component carried no presentable amount. `ledger_mismatch`: the recorded tax figures and the invoice's own totals disagree. `tax_provider_disagrees`: the provider re-read its filing and reported a different tax to the one this invoice was charged — terminal, because correcting an issued invoice is a credit note's job, so retrying the repair cannot clear it. New values may be added, so treat an unrecognised one as withheld rather than failing.
  */
 export type DocumentWithheldReason = OpenEnum<typeof DocumentWithheldReason>;
 
 /**
- * The current status of the invoice
+ * The current status of the invoice. PROJECTED is returned only by GET /v2/invoices/projected and is never the status of a stored invoice.
  */
 export const InvoiceStatus = {
   Active: "ACTIVE",
@@ -93,9 +93,10 @@ export const InvoiceStatus = {
   Cancelled: "CANCELLED",
   WrittenOff: "WRITTEN_OFF",
   Failed: "FAILED",
+  Projected: "PROJECTED",
 } as const;
 /**
- * The current status of the invoice
+ * The current status of the invoice. PROJECTED is returned only by GET /v2/invoices/projected and is never the status of a stored invoice.
  */
 export type InvoiceStatus = ClosedEnum<typeof InvoiceStatus>;
 
@@ -231,7 +232,7 @@ export type Invoice = {
    */
   pdfSource?: PdfSource | null | undefined;
   /**
-   * Why no Paygentic-rendered document exists for this invoice, or null when none was withheld. A tax-registered merchant's document is a compliance artefact, so it is withheld unless the recorded tax reconciles with the provider exactly and the registered issuer identity is complete. Non-null therefore always accompanies pdfSource `null`, and never `paygentic`: an invoice whose document is withheld is not served the provider's in its place, because recording that link would mark the invoice as already served and stop a later repair rendering ours. Use it to tell a withheld invoice apart from one that simply has no document yet — both report pdfSource `null`, and only a withheld one names why. An invoice the tax provider serves by design reports pdfSource `tax_provider` with no reason, and needs no repair. Both an invoice with no document and a withheld one can be repaired by POST /v2/invoices/{id}/generate-pdf. `tax_unreconciled`: the provider's tax figure was never recorded against this invoice. `issuer_identity_incomplete`: the registered legal name, tax ID or address could not be read. `tax_component_unpriceable`: a recorded tax component carried no presentable amount. `ledger_mismatch`: the recorded tax figures and the invoice's own totals disagree. `tax_provider_disagrees`: the provider re-read its filing and reported a different tax to the one this invoice was charged — terminal, because correcting an issued invoice is a credit note's job, so retrying the repair cannot clear it. New values may be added, so treat an unrecognised one as withheld rather than failing.
+   * Why no Paygentic-rendered document exists for this invoice, or null when none was withheld. A tax-registered merchant's document is a compliance artefact, so it is withheld unless the recorded tax reconciles with the provider exactly and the registered issuer identity is complete. Non-null therefore always accompanies pdfSource `null`, and never `paygentic`: an invoice whose document is withheld is not served the provider's in its place, because recording that link would mark the invoice as already served and stop a later repair rendering ours. Use it to tell a withheld invoice apart from one that simply has no document yet — both report pdfSource `null`, and only a withheld one names why. An invoice issued before Paygentic rendered every document can report pdfSource `tax_provider` with no reason, and needs no repair. Both an invoice with no document and a withheld one can be repaired by POST /v2/invoices/{id}/generate-pdf. `tax_unreconciled`: the provider's tax figure was never recorded against this invoice. `issuer_identity_incomplete`: the registered legal name, tax ID or address could not be read. `tax_component_unpriceable`: a recorded tax component carried no presentable amount. `ledger_mismatch`: the recorded tax figures and the invoice's own totals disagree. `tax_provider_disagrees`: the provider re-read its filing and reported a different tax to the one this invoice was charged — terminal, because correcting an issued invoice is a credit note's job, so retrying the repair cannot clear it. New values may be added, so treat an unrecognised one as withheld rather than failing.
    */
   documentWithheldReason?: DocumentWithheldReason | null | undefined;
   /**
@@ -251,7 +252,7 @@ export type Invoice = {
    */
   sequenceNumber: number;
   /**
-   * The current status of the invoice
+   * The current status of the invoice. PROJECTED is returned only by GET /v2/invoices/projected and is never the status of a stored invoice.
    */
   status: InvoiceStatus;
   /**

package/src/models/invoicepaymentlinkerrorcode.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";
+
+/**
+ * Why Paygentic cannot create a payment link for the invoice.
+ */
+export const InvoicePaymentLinkErrorCode = {
+  InvoiceNotLinkableStatus: "INVOICE_NOT_LINKABLE_STATUS",
+  InvoiceNoBalance: "INVOICE_NO_BALANCE",
+  MerchantNoPaymentAccount: "MERCHANT_NO_PAYMENT_ACCOUNT",
+} as const;
+/**
+ * Why Paygentic cannot create a payment link for the invoice.
+ */
+export type InvoicePaymentLinkErrorCode = ClosedEnum<
+  typeof InvoicePaymentLinkErrorCode
+>;
+
+/** @internal */
+export const InvoicePaymentLinkErrorCode$inboundSchema: z.ZodNativeEnum<
+  typeof InvoicePaymentLinkErrorCode
+> = z.nativeEnum(InvoicePaymentLinkErrorCode);