@paygentic/sdk 0.10.5 → 0.10.7

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/externalreference.ts

@@ -30,7 +30,7 @@ export type ExternalReference = {
    */
   merchantId: string;
   /**
-   * The type of Paygentic entity this external reference points at
+   * The type of Paygentic entity this external reference points at. `subscriptionProposal` and `subscription` references link a subscription proposal, and the subscription its approval creates, to the CRM record they come from. They are read-only through these endpoints.
    */
   entityType: EntityType;
   entityId: string;

package/src/models/index.ts

@@ -41,6 +41,7 @@ export * from "./entitlementlistitem.js";
 export * from "./entitlementstatus.js";
 export * from "./entitlementtemplate.js";
 export * from "./entitytype.js";
+export * from "./entitytypeinput.js";
 export * from "./eventresponse.js";
 export * from "./externalreference.js";
 export * from "./feature.js";

package/src/models/operations/createexternalreference.ts

@@ -11,9 +11,9 @@ export type CreateExternalReferenceRequest = {
    */
   merchantId: string;
   /**
-   * The type of Paygentic entity this external reference points at
+   * The type of Paygentic entity a new external reference points at
    */
-  entityType: models.EntityType;
+  entityType: models.EntityTypeInput;
   /**
    * Paygentic id of the entity, e.g. `itm_xxx`
    */
@@ -77,7 +77,7 @@ export const CreateExternalReferenceRequest$outboundSchema: z.ZodType<
   CreateExternalReferenceRequest
 > = z.object({
   merchantId: z.string(),
-  entityType: models.EntityType$outboundSchema,
+  entityType: models.EntityTypeInput$outboundSchema,
   entityId: z.string(),
   provider: z.string(),
   externalId: z.string(),

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/updatesubscription.ts

@@ -8,7 +8,6 @@ import { ClosedEnum } from "../../types/enums.js";
 import * as models from "../index.js";
 
 export const UpdateSubscriptionStatus = {
-  Active: "active",
   Terminated: "terminated",
 } as const;
 export type UpdateSubscriptionStatus = ClosedEnum<

package/src/models/permission.ts

@@ -101,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/sdk/billablemetrics.ts

@@ -94,7 +94,7 @@ export class BillableMetrics extends ClientSDK {
    * List Meter Events
    *
    * @remarks
-   * List raw underlying events for a billable metric from the metering service. Returns events ordered by time descending.
+   * List raw underlying events for a billable metric from the metering service. Returns events ordered by time descending. Events before the metric's `eventFrom` are left out, as its usage leaves them out.
    */
   async listEvents(
     request: operations.ListBillableMetricEventsRequest,

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,