@paygentic/sdk 0.10.4 → 0.10.6

package/src/models/errors/error.ts

@@ -34,6 +34,10 @@ export type ErrorTData = {
    * Present on a 403 from the authorization check. The permissions the caller needs for this request.
    */
   requiredPermissions?: Array<string> | undefined;
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
 };
 
 /**
@@ -60,6 +64,10 @@ export class ErrorT extends PaygenticError {
    * Present on a 403 from the authorization check. The permissions the caller needs for this request.
    */
   requiredPermissions?: Array<string> | undefined;
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: ErrorTData;
@@ -78,6 +86,7 @@ export class ErrorT extends PaygenticError {
     if (err.requiredPermissions != null) {
       this.requiredPermissions = err.requiredPermissions;
     }
+    if (err.requestId != null) this.requestId = err.requestId;
 
     this.name = "ErrorT";
   }
@@ -92,6 +101,7 @@ export const ErrorT$inboundSchema: z.ZodType<ErrorT, z.ZodTypeDef, unknown> = z
     details: z.record(z.any()).optional(),
     reason: models.AuthorizationDenialReason$inboundSchema.optional(),
     requiredPermissions: z.array(z.string()).optional(),
+    requestId: z.string().optional(),
     request$: z.instanceof(Request),
     response$: z.instanceof(Response),
     body$: z.string(),

package/src/models/errors/recordinvoicepayment.ts

@@ -34,6 +34,10 @@ export type UnprocessableEntityErrorData = {
    * Present on a 403 from the authorization check. The permissions the caller needs for this request.
    */
   requiredPermissions?: Array<string> | undefined;
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
 };
 
 /**
@@ -60,6 +64,10 @@ export class UnprocessableEntityError extends PaygenticError {
    * Present on a 403 from the authorization check. The permissions the caller needs for this request.
    */
   requiredPermissions?: Array<string> | undefined;
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: UnprocessableEntityErrorData;
@@ -78,6 +86,7 @@ export class UnprocessableEntityError extends PaygenticError {
     if (err.requiredPermissions != null) {
       this.requiredPermissions = err.requiredPermissions;
     }
+    if (err.requestId != null) this.requestId = err.requestId;
 
     this.name = "UnprocessableEntityError";
   }
@@ -95,6 +104,7 @@ export const UnprocessableEntityError$inboundSchema: z.ZodType<
   details: z.record(z.any()).optional(),
   reason: models.AuthorizationDenialReason$inboundSchema.optional(),
   requiredPermissions: z.array(z.string()).optional(),
+  requestId: z.string().optional(),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),

package/src/models/errors/retrypaymentresponseerror.ts

@@ -30,6 +30,10 @@ export type RetryPaymentResponseErrorData = {
    * Why a payment retry did not collect the money.
    */
   error?: models.RetryPaymentError | undefined;
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
 };
 
 /**
@@ -56,6 +60,10 @@ export class RetryPaymentResponseError extends PaygenticError {
    * Why a payment retry did not collect the money.
    */
   error?: models.RetryPaymentError | undefined;
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: RetryPaymentResponseErrorData;
@@ -73,6 +81,7 @@ export class RetryPaymentResponseError extends PaygenticError {
     this.invoiceId = err.invoiceId;
     if (err.paymentIntentId != null) this.paymentIntentId = err.paymentIntentId;
     if (err.error != null) this.error = err.error;
+    if (err.requestId != null) this.requestId = err.requestId;
 
     this.name = "RetryPaymentResponseError";
   }
@@ -89,6 +98,7 @@ export const RetryPaymentResponseError$inboundSchema: z.ZodType<
   invoiceId: z.string(),
   paymentIntentId: z.string().optional(),
   error: models.RetryPaymentError$inboundSchema.optional(),
+  requestId: z.string().optional(),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),

package/src/models/errors/updateprice.ts

@@ -10,6 +10,10 @@ import { PaygenticError } from "./paygenticerror.js";
  * Price cannot be restructured because a subscription still bills it directly
  */
 export type UpdatePriceConflictErrorData = {
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
   error?: string | undefined;
   message: string;
   /**
@@ -23,6 +27,10 @@ export type UpdatePriceConflictErrorData = {
  * Price cannot be restructured because a subscription still bills it directly
  */
 export class UpdatePriceConflictError extends PaygenticError {
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
   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.
@@ -40,6 +48,7 @@ export class UpdatePriceConflictError extends PaygenticError {
     const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
     super(message, httpMeta);
     this.data$ = err;
+    if (err.requestId != null) this.requestId = err.requestId;
     if (err.error != null) this.error = err.error;
     this.code = err.code;
     if (err.details != null) this.details = err.details;
@@ -54,6 +63,7 @@ export const UpdatePriceConflictError$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  requestId: z.string().optional(),
   error: z.string().optional(),
   message: z.string(),
   code: z.string(),

package/src/models/errors/validationerror.ts

@@ -19,6 +19,10 @@ export type ValidationErrorData = {
    * Array of field-specific validation errors
    */
   errors: Array<models.ErrorT>;
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
 };
 
 export class ValidationError extends PaygenticError {
@@ -30,6 +34,10 @@ export class ValidationError extends PaygenticError {
    * Array of field-specific validation errors
    */
   errors: Array<models.ErrorT>;
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: ValidationErrorData;
@@ -43,6 +51,7 @@ export class ValidationError extends PaygenticError {
     this.data$ = err;
     if (err.error != null) this.error = err.error;
     this.errors = err.errors;
+    if (err.requestId != null) this.requestId = err.requestId;
 
     this.name = "ValidationError";
   }
@@ -57,6 +66,7 @@ export const ValidationError$inboundSchema: z.ZodType<
   error: models.ErrorEnum$inboundSchema.default("validation_error"),
   message: z.string(),
   errors: z.array(z.lazy(() => models.ErrorT$inboundSchema)),
+  requestId: z.string().optional(),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),

package/src/models/operations/createsubscription.ts

@@ -130,7 +130,7 @@ export type CreateSubscriptionRequest = {
    */
   metadata?: { [k: string]: models.SubscriptionMetadata } | undefined;
   /**
-   * Why a change was made. `correction` fixes data to match what was agreed; `migration` moves a contract from another system; `commercial` is a real change to the deal. Defaults to `unspecified`.
+   * Why a change was made. `correction` repairs data that was entered wrong; `migration` moves a contract from another system; `commercial` is a real change to the deal; `contractual` applies a step the original contract scheduled, such as an annual uplift. Defaults to `unspecified`.
    */
   changeReason?: models.ChangeReason | undefined;
   /**

package/src/models/operations/getbillablemetricmeter.ts

@@ -28,7 +28,7 @@ export type GetBillableMetricMeterRequest = {
    */
   from: Date;
   /**
-   * End of query window (ISO 8601)
+   * End of query window (ISO 8601). At most 403 days after `from`.
    */
   to: Date;
   /**

package/src/models/operations/getcostsummary.ts

@@ -32,7 +32,7 @@ export type GetCostSummaryRequest = {
    */
   from: Date;
   /**
-   * End of the query window, excluded: the read counts from <= t < to (ISO 8601). Required together with 'from'.
+   * End of the query window, excluded: the read counts from <= t < to (ISO 8601). Required together with 'from'. At most 403 days after `from`.
    */
   to: Date;
   /**

package/src/models/operations/listbillablemetricevents.ts

@@ -11,7 +11,7 @@ export type ListBillableMetricEventsRequest = {
    */
   from: Date;
   /**
-   * End of query window (ISO 8601)
+   * End of query window (ISO 8601). At most 403 days after `from`.
    */
   to: Date;
   /**

package/src/models/operations/terminatesubscription.ts

@@ -12,7 +12,7 @@ export type TerminateSubscriptionRequestBody = {
    */
   reason: string;
   /**
-   * Why a change was made. `correction` fixes data to match what was agreed; `migration` moves a contract from another system; `commercial` is a real change to the deal. Defaults to `unspecified`.
+   * Why a change was made. `correction` repairs data that was entered wrong; `migration` moves a contract from another system; `commercial` is a real change to the deal; `contractual` applies a step the original contract scheduled, such as an annual uplift. Defaults to `unspecified`.
    */
   changeReason?: models.ChangeReason | undefined;
 };

package/src/models/operations/updateprice.ts

@@ -5,23 +5,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";
 
-/**
- * Billing timing preference: 'in_advance' (prepaid — charged upfront or drawn from a prepaid commitment) or 'in_arrears' (charged at period end).
- */
-export const UpdatePricePaymentTerm = {
-  InArrears: "in_arrears",
-  InAdvance: "in_advance",
-} as const;
-/**
- * Billing timing preference: 'in_advance' (prepaid — charged upfront or drawn from a prepaid commitment) or 'in_arrears' (charged at period end).
- */
-export type UpdatePricePaymentTerm = ClosedEnum<typeof UpdatePricePaymentTerm>;
-
 export type UpdatePriceRequestBody = {
   /**
    * Unique identifier for a billable metric
@@ -44,14 +31,6 @@ export type UpdatePriceRequestBody = {
    */
   model?: models.PriceModelInput | 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).
-   */
-  paymentTerm?: UpdatePricePaymentTerm | undefined;
-  /**
-   * ISO 8601 duration for recurring fees (e.g., 'P1M' for monthly, 'P1Y' for yearly, or 'P0D' for one-time)
-   */
-  billingCadence?: string | null | undefined;
   /**
    * Feature to associate. Set to null to remove existing feature. Omit to leave unchanged.
    */
@@ -92,11 +71,6 @@ export type UpdatePriceDetails = {
   subscriptionCount?: number | undefined;
 };
 
-/** @internal */
-export const UpdatePricePaymentTerm$outboundSchema: z.ZodNativeEnum<
-  typeof UpdatePricePaymentTerm
-> = z.nativeEnum(UpdatePricePaymentTerm);
-
 /** @internal */
 export type UpdatePriceRequestBody$Outbound = {
   billableMetricId?: string | undefined;
@@ -105,8 +79,6 @@ export type UpdatePriceRequestBody$Outbound = {
   invoiceDisplayGroup?: string | null | undefined;
   model?: string | undefined;
   properties?: models.PriceProperties$Outbound | undefined;
-  paymentTerm?: string | undefined;
-  billingCadence?: string | null | undefined;
   feature?: models.PriceFeatureInput$Outbound | null | undefined;
   grantDiscountEnabled?: boolean | undefined;
   isObligation?: boolean | undefined;
@@ -127,8 +99,6 @@ export const UpdatePriceRequestBody$outboundSchema: z.ZodType<
   invoiceDisplayGroup: z.nullable(z.string()).optional(),
   model: models.PriceModelInput$outboundSchema.optional(),
   properties: models.PriceProperties$outboundSchema.optional(),
-  paymentTerm: UpdatePricePaymentTerm$outboundSchema.optional(),
-  billingCadence: z.nullable(z.string()).optional(),
   feature: z.nullable(models.PriceFeatureInput$outboundSchema).optional(),
   grantDiscountEnabled: z.boolean().optional(),
   isObligation: z.boolean().optional(),

package/src/models/permission.ts

@@ -38,6 +38,8 @@ export const Permission = {
   PortalSessionsRead: "portalSessions:read",
   PlatformUsersRead: "platformUsers:read",
   PlatformAdminRead: "platformAdmin:read",
+  LoginLockoutRead: "loginLockout:read",
+  PlatformSystemRead: "platformSystem:read",
   OrganizationCreationRead: "organizationCreation:read",
   ComplianceRead: "compliance:read",
   TaxSettingsRead: "taxSettings:read",
@@ -81,6 +83,8 @@ export const Permission = {
   PortalSessionsWrite: "portalSessions:write",
   PlatformUsersWrite: "platformUsers:write",
   PlatformAdminWrite: "platformAdmin:write",
+  LoginLockoutWrite: "loginLockout:write",
+  PlatformSystemWrite: "platformSystem:write",
   OrganizationCreationWrite: "organizationCreation:write",
   ComplianceWrite: "compliance:write",
   TaxSettingsWrite: "taxSettings:write",
@@ -97,6 +101,7 @@ export const Permission = {
   EventsWrite: "events:write",
   InvoicesIssue: "invoices:issue",
   InvoicesVoid: "invoices:void",
+  InvoicesTransition: "invoices:transition",
   PaymentsRefund: "payments:refund",
   OrganizationDelete: "organization:delete",
   OwnershipTransfer: "ownership:transfer",

package/src/models/retrypaymentresponse.ts

@@ -49,6 +49,10 @@ export type RetryPaymentResponse = {
    * Why a payment retry did not collect the money.
    */
   error?: RetryPaymentError | undefined;
+  /**
+   * Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.
+   */
+  requestId?: string | undefined;
 };
 
 /** @internal */
@@ -67,6 +71,7 @@ export const RetryPaymentResponse$inboundSchema: z.ZodType<
   invoiceId: z.string(),
   paymentIntentId: z.string().optional(),
   error: RetryPaymentError$inboundSchema.optional(),
+  requestId: z.string().optional(),
 });
 
 export function retryPaymentResponseFromJSON(

package/src/models/subscription.ts

@@ -136,6 +136,7 @@ export const TerminationChangeReason = {
   Correction: "correction",
   Migration: "migration",
   Unspecified: "unspecified",
+  Contractual: "contractual",
 } as const;
 /**
  * Why the subscription was terminated. Null while it is not terminated.

package/src/models/subscriptionintervalchange.ts

@@ -24,7 +24,7 @@ export type SubscriptionIntervalChange = {
   merchantId: string;
   subscriptionId: string;
   /**
-   * Why a change was made. `correction` fixes data to match what was agreed; `migration` moves a contract from another system; `commercial` is a real change to the deal. Defaults to `unspecified`.
+   * Why a change was made. `correction` repairs data that was entered wrong; `migration` moves a contract from another system; `commercial` is a real change to the deal; `contractual` applies a step the original contract scheduled, such as an annual uplift. Defaults to `unspecified`.
    */
   changeReason: ChangeReason;
   description: string | null;

package/src/sdk/prices.ts

@@ -57,6 +57,9 @@ export class Prices extends ClientSDK {
 
   /**
    * Update
+   *
+   * @remarks
+   * Updates a price. `paymentTerm` and `billingCadence` are fixed when the price is created: a request that sends either one is refused with a 400. To change them, create a new price.
    */
   async update(
     request: operations.UpdatePriceRequest,

package/src/sdk/testclocks.ts

@@ -68,7 +68,7 @@ export class TestClocks extends ClientSDK {
    * Advance
    *
    * @remarks
-   * Advances the test clock's current time. You can either specify a new absolute time or advance by a duration.
+   * Advances the test clock's current time. You can either specify a new absolute time or advance by a duration. A clock moves forward only, and at most 1 year per call: a time earlier than the clock's current time, or more than 1 year after it, returns 400. To move further, advance more than once.
    */
   async advance(
     request: operations.AdvanceTestClockRequest,