@paygentic/sdk 0.9.3 → 0.9.5

package/src/models/errors/updateprice.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as operations from "../operations/index.js";
+import { PaygenticError } from "./paygenticerror.js";
+
+/**
+ * Price cannot be restructured because a subscription still bills it directly
+ */
+export type UpdatePriceConflictErrorData = {
+  error?: string | undefined;
+  message: string;
+  /**
+   * Machine-readable conflict code. Open set: a new code may appear, so branch on the ones you handle and treat anything else as an unhandled conflict.
+   */
+  code: string;
+  details?: operations.UpdatePriceDetails | undefined;
+};
+
+/**
+ * Price cannot be restructured because a subscription still bills it directly
+ */
+export class UpdatePriceConflictError extends PaygenticError {
+  error?: string | undefined;
+  /**
+   * Machine-readable conflict code. Open set: a new code may appear, so branch on the ones you handle and treat anything else as an unhandled conflict.
+   */
+  code: string;
+  details?: operations.UpdatePriceDetails | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: UpdatePriceConflictErrorData;
+
+  constructor(
+    err: UpdatePriceConflictErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    if (err.error != null) this.error = err.error;
+    this.code = err.code;
+    if (err.details != null) this.details = err.details;
+
+    this.name = "UpdatePriceConflictError";
+  }
+}
+
+/** @internal */
+export const UpdatePriceConflictError$inboundSchema: z.ZodType<
+  UpdatePriceConflictError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.string().optional(),
+  message: z.string(),
+  code: z.string(),
+  details: z.lazy(() => operations.UpdatePriceDetails$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new UpdatePriceConflictError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/index.ts

@@ -22,6 +22,7 @@ export * from "./createorderapprovalrequest.js";
 export * from "./createorderlineitemrequest.js";
 export * from "./createorderrequest.js";
 export * from "./createrulerequest.js";
+export * from "./createsubscriptionadjustmentrequest.js";
 export * from "./currencybreakdownentry.js";
 export * from "./customer.js";
 export * from "./entitlementdetail.js";
@@ -75,7 +76,7 @@ export * from "./pricefeature.js";
 export * from "./pricefeatureinput.js";
 export * from "./pricemodel.js";
 export * from "./pricemodelinput.js";
-export * from "./pricepropertiesunion.js";
+export * from "./priceproperties.js";
 export * from "./product.js";
 export * from "./profitabilityrow.js";
 export * from "./profitabilitysummaryresponse.js";
@@ -104,6 +105,8 @@ export * from "./sourcerule.js";
 export * from "./staticentitlementdetail.js";
 export * from "./staticentitlementlistitem.js";
 export * from "./subscription.js";
+export * from "./subscriptionadjustment.js";
+export * from "./subscriptionadjustmentsresponse.js";
 export * from "./subscriptionmetadata.js";
 export * from "./subscriptionportal.js";
 export * from "./subscriptionreconciliation.js";

package/src/models/invoice.ts

@@ -4,7 +4,8 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
-import { ClosedEnum } from "../types/enums.js";
+import * as openEnums from "../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import {
@@ -62,6 +63,21 @@ 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 `tax_provider` or null, and never `paygentic`. Use it to tell a withheld document apart from an invoice the tax provider serves by design — both report pdfSource `tax_provider`, but only 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",
+  IssuerIdentityIncomplete: "issuer_identity_incomplete",
+  TaxComponentUnpriceable: "tax_component_unpriceable",
+  LedgerMismatch: "ledger_mismatch",
+  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 `tax_provider` or null, and never `paygentic`. Use it to tell a withheld document apart from an invoice the tax provider serves by design — both report pdfSource `tax_provider`, but only 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
  */
@@ -210,6 +226,10 @@ export type Invoice = {
    * Who produced the document at pdfUrl, or null when there is none. `paygentic` means pdfUrl is this API's download endpoint and the request must carry your API key; `tax_provider` means it is the provider's own link, which opens directly in a browser.
    */
   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 `tax_provider` or null, and never `paygentic`. Use it to tell a withheld document apart from an invoice the tax provider serves by design — both report pdfSource `tax_provider`, but only 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;
   /**
    * The end of the billing period
    */
@@ -292,6 +312,13 @@ export function invoiceLineItemsFromJSON(
 export const PdfSource$inboundSchema: z.ZodNativeEnum<typeof PdfSource> = z
   .nativeEnum(PdfSource);
 
+/** @internal */
+export const DocumentWithheldReason$inboundSchema: z.ZodType<
+  DocumentWithheldReason,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(DocumentWithheldReason);
+
 /** @internal */
 export const InvoiceStatus$inboundSchema: z.ZodNativeEnum<
   typeof InvoiceStatus
@@ -360,6 +387,8 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
     paymentUrl: z.nullable(z.string()).optional(),
     pdfUrl: z.nullable(z.string()).optional(),
     pdfSource: z.nullable(PdfSource$inboundSchema).optional(),
+    documentWithheldReason: z.nullable(DocumentWithheldReason$inboundSchema)
+      .optional(),
     periodEnd: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ),

package/src/models/operations/createprice.ts

@@ -47,7 +47,7 @@ export type CreatePriceRequest = {
    * ISO 8601 duration for recurring charges (e.g., 'P1M' for monthly, 'P1Y' for yearly) or 'P0D' for one-time charges. Required for fees, optional for billable metrics. Sample values: 'P0D' for one-time, 'P1M' for monthly recurring, 'P1Y' for yearly recurring
    */
   billingCadence?: string | null | undefined;
-  properties: models.PricePropertiesUnion;
+  properties: models.PriceProperties;
   feature?: models.PriceFeatureInput | undefined;
   /**
    * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
@@ -73,7 +73,7 @@ export type CreatePriceRequest$Outbound = {
   invoiceDisplayName: string;
   paymentTerm: string;
   billingCadence?: string | null | undefined;
-  properties: models.PricePropertiesUnion$Outbound;
+  properties: models.PriceProperties$Outbound;
   feature?: models.PriceFeatureInput$Outbound | undefined;
   grantDiscountEnabled: boolean;
   quantity?: number | undefined;
@@ -92,7 +92,7 @@ export const CreatePriceRequest$outboundSchema: z.ZodType<
   invoiceDisplayName: z.string(),
   paymentTerm: CreatePricePaymentTerm$outboundSchema,
   billingCadence: z.nullable(z.string()).optional(),
-  properties: models.PricePropertiesUnion$outboundSchema,
+  properties: models.PriceProperties$outboundSchema,
   feature: models.PriceFeatureInput$outboundSchema.optional(),
   grantDiscountEnabled: z.boolean().default(false),
   quantity: z.number().int().optional(),

package/src/models/operations/createsubscriptionadjustment.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as models from "../index.js";
+
+export type CreateSubscriptionAdjustmentRequest = {
+  /**
+   * The subscription ID
+   */
+  id: string;
+  createSubscriptionAdjustmentRequest:
+    models.CreateSubscriptionAdjustmentRequest;
+};
+
+/** @internal */
+export type CreateSubscriptionAdjustmentRequest$Outbound = {
+  id: string;
+  CreateSubscriptionAdjustmentRequest:
+    models.CreateSubscriptionAdjustmentRequest$Outbound;
+};
+
+/** @internal */
+export const CreateSubscriptionAdjustmentRequest$outboundSchema: z.ZodType<
+  CreateSubscriptionAdjustmentRequest$Outbound,
+  z.ZodTypeDef,
+  CreateSubscriptionAdjustmentRequest
+> = z.object({
+  id: z.string(),
+  createSubscriptionAdjustmentRequest:
+    models.CreateSubscriptionAdjustmentRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    createSubscriptionAdjustmentRequest: "CreateSubscriptionAdjustmentRequest",
+  });
+});
+
+export function createSubscriptionAdjustmentRequestToJSON(
+  createSubscriptionAdjustmentRequest: CreateSubscriptionAdjustmentRequest,
+): string {
+  return JSON.stringify(
+    CreateSubscriptionAdjustmentRequest$outboundSchema.parse(
+      createSubscriptionAdjustmentRequest,
+    ),
+  );
+}

package/src/models/operations/deletesubscriptionadjustment.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeleteSubscriptionAdjustmentRequest = {
+  /**
+   * The subscription ID
+   */
+  id: string;
+  /**
+   * The adjustment ID
+   */
+  adjustmentId: string;
+};
+
+/** @internal */
+export type DeleteSubscriptionAdjustmentRequest$Outbound = {
+  id: string;
+  adjustmentId: string;
+};
+
+/** @internal */
+export const DeleteSubscriptionAdjustmentRequest$outboundSchema: z.ZodType<
+  DeleteSubscriptionAdjustmentRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteSubscriptionAdjustmentRequest
+> = z.object({
+  id: z.string(),
+  adjustmentId: z.string(),
+});
+
+export function deleteSubscriptionAdjustmentRequestToJSON(
+  deleteSubscriptionAdjustmentRequest: DeleteSubscriptionAdjustmentRequest,
+): string {
+  return JSON.stringify(
+    DeleteSubscriptionAdjustmentRequest$outboundSchema.parse(
+      deleteSubscriptionAdjustmentRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -25,6 +25,7 @@ export * from "./createprice.js";
 export * from "./createproduct.js";
 export * from "./createsource.js";
 export * from "./createsubscription.js";
+export * from "./createsubscriptionadjustment.js";
 export * from "./createtestclock.js";
 export * from "./deletebillingschedule.js";
 export * from "./deletecost.js";
@@ -36,6 +37,7 @@ export * from "./deleteorder.js";
 export * from "./deleteorderlineitem.js";
 export * from "./deleteprice.js";
 export * from "./deletesourcerule.js";
+export * from "./deletesubscriptionadjustment.js";
 export * from "./deletetestclock.js";
 export * from "./disconnectmerchantintegration.js";
 export * from "./downloadinvoicepdf.js";
@@ -103,6 +105,7 @@ export * from "./listscheduleinvoices.js";
 export * from "./listsourceevents.js";
 export * from "./listsourcerules.js";
 export * from "./listsources.js";
+export * from "./listsubscriptionadjustments.js";
 export * from "./listsubscriptions.js";
 export * from "./listtestclocks.js";
 export * from "./mintplanversion.js";

package/src/models/operations/listsubscriptionadjustments.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListSubscriptionAdjustmentsRequest = {
+  /**
+   * The subscription ID
+   */
+  id: string;
+  /**
+   * Number of adjustments to return
+   */
+  limit?: string | undefined;
+  /**
+   * Number of adjustments to skip
+   */
+  offset?: string | undefined;
+};
+
+/** @internal */
+export type ListSubscriptionAdjustmentsRequest$Outbound = {
+  id: string;
+  limit: string;
+  offset: string;
+};
+
+/** @internal */
+export const ListSubscriptionAdjustmentsRequest$outboundSchema: z.ZodType<
+  ListSubscriptionAdjustmentsRequest$Outbound,
+  z.ZodTypeDef,
+  ListSubscriptionAdjustmentsRequest
+> = z.object({
+  id: z.string(),
+  limit: z.string().default("10"),
+  offset: z.string().default("0"),
+});
+
+export function listSubscriptionAdjustmentsRequestToJSON(
+  listSubscriptionAdjustmentsRequest: ListSubscriptionAdjustmentsRequest,
+): string {
+  return JSON.stringify(
+    ListSubscriptionAdjustmentsRequest$outboundSchema.parse(
+      listSubscriptionAdjustmentsRequest,
+    ),
+  );
+}

package/src/models/operations/updateprice.ts

@@ -4,7 +4,10 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
+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 * as models from "../index.js";
 
 /**
@@ -36,7 +39,7 @@ export type UpdatePriceRequestBody = {
    * The pricing model to set. Only 'standard' is accepted. Legacy 'dynamic'/'volume'/'percentage' prices can still be edited (other fields) but cannot be switched to those models. Percentage/revenue-share is expressed via 'standard' with a unit-price multiplier.
    */
   model?: models.PriceModelInput | undefined;
-  properties?: models.PricePropertiesUnion | undefined;
+  properties?: models.PriceProperties | undefined;
   /**
    * Billing timing preference: 'in_advance' (prepaid — charged upfront or drawn from a prepaid commitment) or 'in_arrears' (charged at period end).
    */
@@ -67,6 +70,12 @@ export type UpdatePriceRequest = {
   requestBody: UpdatePriceRequestBody;
 };
 
+export type UpdatePriceDetails = {
+  priceId?: string | undefined;
+  fields?: Array<string> | undefined;
+  subscriptionCount?: number | undefined;
+};
+
 /** @internal */
 export const UpdatePricePaymentTerm$outboundSchema: z.ZodNativeEnum<
   typeof UpdatePricePaymentTerm
@@ -78,7 +87,7 @@ export type UpdatePriceRequestBody$Outbound = {
   pricingUnitId?: string | null | undefined;
   invoiceDisplayName?: string | undefined;
   model?: string | undefined;
-  properties?: models.PricePropertiesUnion$Outbound | undefined;
+  properties?: models.PriceProperties$Outbound | undefined;
   paymentTerm?: string | undefined;
   billingCadence?: string | null | undefined;
   feature?: models.PriceFeatureInput$Outbound | null | undefined;
@@ -96,7 +105,7 @@ export const UpdatePriceRequestBody$outboundSchema: z.ZodType<
   pricingUnitId: z.nullable(z.string()).optional(),
   invoiceDisplayName: z.string().optional(),
   model: models.PriceModelInput$outboundSchema.optional(),
-  properties: models.PricePropertiesUnion$outboundSchema.optional(),
+  properties: models.PriceProperties$outboundSchema.optional(),
   paymentTerm: UpdatePricePaymentTerm$outboundSchema.optional(),
   billingCadence: z.nullable(z.string()).optional(),
   feature: z.nullable(models.PriceFeatureInput$outboundSchema).optional(),
@@ -139,3 +148,24 @@ export function updatePriceRequestToJSON(
     UpdatePriceRequest$outboundSchema.parse(updatePriceRequest),
   );
 }
+
+/** @internal */
+export const UpdatePriceDetails$inboundSchema: z.ZodType<
+  UpdatePriceDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  priceId: z.string().optional(),
+  fields: z.array(z.string()).optional(),
+  subscriptionCount: z.number().int().optional(),
+});
+
+export function updatePriceDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdatePriceDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdatePriceDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdatePriceDetails' from JSON`,
+  );
+}