@paygentic/sdk 0.10.6 → 0.10.8

package/src/funcs/externalReferencesDeleteExternalReference.ts

@@ -135,7 +135,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["401", "403", "404", "4XX", "500", "5XX"],
+    errorCodes: ["401", "403", "404", "409", "4XX", "500", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -161,7 +161,7 @@ async function $do(
     | SDKValidationError
   >(
     M.nil(204, z.void()),
-    M.jsonErr([401, 403, 404], errors.ErrorT$inboundSchema),
+    M.jsonErr([401, 403, 404, 409], errors.ErrorT$inboundSchema),
     M.jsonErr(500, errors.ErrorT$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

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.10.6",
+  sdkVersion: "0.10.8",
   genVersion: "2.879.13",
-  userAgent: "speakeasy-sdk/typescript 0.10.6 2.879.13 0.1.0 @paygentic/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.10.8 2.879.13 0.1.0 @paygentic/sdk",
 } as const;

package/src/models/entitytype.ts

@@ -3,23 +3,32 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../types/enums.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
 
 /**
- * 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.
  */
 export const EntityType = {
   Item: "item",
   Customer: "customer",
+  SubscriptionProposal: "subscriptionProposal",
+  Subscription: "subscription",
 } as const;
 /**
- * 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.
  */
-export type EntityType = ClosedEnum<typeof EntityType>;
+export type EntityType = OpenEnum<typeof EntityType>;
 
 /** @internal */
-export const EntityType$inboundSchema: z.ZodNativeEnum<typeof EntityType> = z
-  .nativeEnum(EntityType);
+export const EntityType$inboundSchema: z.ZodType<
+  EntityType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(EntityType);
 /** @internal */
-export const EntityType$outboundSchema: z.ZodNativeEnum<typeof EntityType> =
-  EntityType$inboundSchema;
+export const EntityType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  EntityType
+> = openEnums.outboundSchema(EntityType);

package/src/models/entitytypeinput.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";
+
+/**
+ * The type of Paygentic entity a new external reference points at
+ */
+export const EntityTypeInput = {
+  Item: "item",
+  Customer: "customer",
+} as const;
+/**
+ * The type of Paygentic entity a new external reference points at
+ */
+export type EntityTypeInput = ClosedEnum<typeof EntityTypeInput>;
+
+/** @internal */
+export const EntityTypeInput$outboundSchema: z.ZodNativeEnum<
+  typeof EntityTypeInput
+> = z.nativeEnum(EntityTypeInput);

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

@@ -123,7 +123,7 @@ export type CreatePlanRequest = {
    */
   billingVersion?: BillingVersion | undefined;
   /**
-   * ISO 8601 datetime reference point for billing period alignment. Must be in the past or present. When set, subscriptions created under this plan align their first billing period to the next recurrence of this anchor.
+   * ISO 8601 datetime reference point for billing period alignment. Must be in the past or present. When set, subscriptions created under this plan align their first billing period to the next recurrence of this anchor, unless the create names its own `billingAnchor`.
    */
   billingAnchor?: Date | null | undefined;
   /**

package/src/models/operations/createsubscription.ts

@@ -101,6 +101,10 @@ export type CreateSubscriptionRequest = {
    * 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`.
    */
   elapsedPeriodBilling?: models.ElapsedPeriodBilling | undefined;
+  /**
+   * A billing anchor for this subscription, in place of the plan's. Any instant, past or future. The subscription's billing anchor is its first recurrence on or after `startedAt`, stepping back or forward by whole billing cadences. Example: on a monthly plan, an anchor of '2027-01-31T00:00:00Z' with a start of '2026-10-10T00:00:00Z' gives '2026-10-31T00:00:00Z'. A create is refused with 400 when the resolved anchor does not line up with the usage period anchor of a feature that credits unused balance. Omit it to use the plan's billing anchor. A repeated create that names an anchor resolving to a different instant than the existing subscription's gets 409.
+   */
+  billingAnchor?: Date | undefined;
   /**
    * Test clock identifier for simulating time-based billing scenarios. Sample values: 'tc_abc123xyz', 'tc_789def456'. Restricted to non-production environments (local, dev, sandbox). Must belong to the same merchant organization.
    */
@@ -231,6 +235,7 @@ export type CreateSubscriptionRequest$Outbound = {
   redirectUrls?: RedirectUrls$Outbound | undefined;
   startedAt: string;
   elapsedPeriodBilling: string;
+  billingAnchor?: string | undefined;
   testClockId?: string | undefined;
   renewalReminderEnabled?: boolean | null | undefined;
   renewalReminderDays?: number | null | undefined;
@@ -265,6 +270,7 @@ export const CreateSubscriptionRequest$outboundSchema: z.ZodType<
   elapsedPeriodBilling: models.ElapsedPeriodBilling$outboundSchema.default(
     "none",
   ),
+  billingAnchor: z.date().transform(v => v.toISOString()).optional(),
   testClockId: z.string().optional(),
   renewalReminderEnabled: z.nullable(z.boolean()).optional(),
   renewalReminderDays: z.nullable(z.number().int()).optional(),

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

@@ -3,7 +3,8 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../types/enums.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
 
 /**
  * A permission of the catalog: a resource read or write, or a sensitive action.
@@ -26,6 +27,7 @@ export const Permission = {
   PricingUnitsRead: "pricingUnits:read",
   SubscriptionsRead: "subscriptions:read",
   SubscriptionAdjustmentsRead: "subscriptionAdjustments:read",
+  SubscriptionProposalsRead: "subscriptionProposals:read",
   DiscountsRead: "discounts:read",
   GrantsRead: "grants:read",
   EntitlementsRead: "entitlements:read",
@@ -71,6 +73,7 @@ export const Permission = {
   PricingUnitsWrite: "pricingUnits:write",
   SubscriptionsWrite: "subscriptions:write",
   SubscriptionAdjustmentsWrite: "subscriptionAdjustments:write",
+  SubscriptionProposalsWrite: "subscriptionProposals:write",
   DiscountsWrite: "discounts:write",
   GrantsWrite: "grants:write",
   EntitlementsWrite: "entitlements:write",
@@ -113,12 +116,16 @@ export const Permission = {
   SubscriptionsTaxExempt: "subscriptions:taxExempt",
   SubscriptionsAutoApprove: "subscriptions:autoApprove",
   OrganizationResetData: "organization:resetData",
+  SubscriptionProposalsApprove: "subscriptionProposals:approve",
 } as const;
 /**
  * A permission of the catalog: a resource read or write, or a sensitive action.
  */
-export type Permission = ClosedEnum<typeof Permission>;
+export type Permission = OpenEnum<typeof Permission>;
 
 /** @internal */
-export const Permission$inboundSchema: z.ZodNativeEnum<typeof Permission> = z
-  .nativeEnum(Permission);
+export const Permission$inboundSchema: z.ZodType<
+  Permission,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Permission);

package/src/models/plan.ts

@@ -115,7 +115,7 @@ export type Plan = {
    */
   billingVersion?: number | undefined;
   /**
-   * ISO 8601 datetime reference point for billing period alignment. Must be in the past or present at the time of creation or update. When set, all subscriptions created under this plan align their first billing period to the next recurrence of this anchor. Null means each subscription uses its own start time (hour-rounded) as the anchor.
+   * ISO 8601 datetime reference point for billing period alignment. Must be in the past or present at the time of creation or update. When set, subscriptions created under this plan align their first billing period to the next recurrence of this anchor, unless the create names its own `billingAnchor`. Null means each subscription uses its own start time (hour-rounded) as the anchor, unless the create names one.
    */
   billingAnchor?: Date | null | undefined;
   /**

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,