@paygentic/sdk 0.9.13 → 0.9.14

package/src/models/subscriptionintervaleditop.ts

@@ -0,0 +1,166 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+export type SubscriptionIntervalEditOpQuantityTransition = {
+  effectiveDate: Date;
+  /**
+   * Non-negative decimal string.
+   */
+  quantity: string;
+};
+
+/**
+ * Not editable. Must match the interval's current value if supplied.
+ */
+export const SubscriptionIntervalEditOpBillingMode = {
+  Advance: "advance",
+  Arrears: "arrears",
+} as const;
+/**
+ * Not editable. Must match the interval's current value if supplied.
+ */
+export type SubscriptionIntervalEditOpBillingMode = ClosedEnum<
+  typeof SubscriptionIntervalEditOpBillingMode
+>;
+
+/**
+ * Edits an interval by id. You can change unitPrice, baseQuantity, quantityTransitions, and endDate. Other fields must match the current value if you send them. To bill a different priceId, remove the interval and add a new one.
+ */
+export type SubscriptionIntervalEditOp = {
+  /**
+   * The interval being edited.
+   */
+  id: string;
+  /**
+   * Signed per-period net unit price as a decimal string. Set to null to revert to the catalog price. Omit to leave unchanged.
+   */
+  unitPrice?: string | null | undefined;
+  /**
+   * Quantity at interval start, as a non-negative decimal string. Omit to leave unchanged.
+   */
+  baseQuantity?: string | undefined;
+  /**
+   * Step changes in quantity partway through the interval. Omit to leave unchanged.
+   */
+  quantityTransitions?:
+    | Array<SubscriptionIntervalEditOpQuantityTransition>
+    | undefined;
+  /**
+   * Not editable. Must match the interval's current value if supplied.
+   */
+  priceId?: string | undefined;
+  /**
+   * Not editable. Must match the interval's current value if supplied.
+   */
+  priceKey?: string | undefined;
+  /**
+   * Not editable. Must match the interval's current value if supplied.
+   */
+  planVersionId?: string | undefined;
+  /**
+   * Not editable. Must match the interval's current value if supplied.
+   */
+  billingCadence?: string | undefined;
+  /**
+   * Not editable. Must match the interval's current value if supplied.
+   */
+  billingMode?: SubscriptionIntervalEditOpBillingMode | undefined;
+  /**
+   * Not editable. Must match the interval's current value if supplied.
+   */
+  billDate?: Date | null | undefined;
+  /**
+   * Not editable. Must match the interval's current value if supplied.
+   */
+  startDate?: Date | undefined;
+  /**
+   * When the interval stops billing. Send a date on or inside one of the billing periods to close the price. Send null to re-open it. Omit to keep the current value.
+   */
+  endDate?: Date | null | undefined;
+};
+
+/** @internal */
+export type SubscriptionIntervalEditOpQuantityTransition$Outbound = {
+  effectiveDate: string;
+  quantity: string;
+};
+
+/** @internal */
+export const SubscriptionIntervalEditOpQuantityTransition$outboundSchema:
+  z.ZodType<
+    SubscriptionIntervalEditOpQuantityTransition$Outbound,
+    z.ZodTypeDef,
+    SubscriptionIntervalEditOpQuantityTransition
+  > = z.object({
+    effectiveDate: z.date().transform(v => v.toISOString()),
+    quantity: z.string(),
+  });
+
+export function subscriptionIntervalEditOpQuantityTransitionToJSON(
+  subscriptionIntervalEditOpQuantityTransition:
+    SubscriptionIntervalEditOpQuantityTransition,
+): string {
+  return JSON.stringify(
+    SubscriptionIntervalEditOpQuantityTransition$outboundSchema.parse(
+      subscriptionIntervalEditOpQuantityTransition,
+    ),
+  );
+}
+
+/** @internal */
+export const SubscriptionIntervalEditOpBillingMode$outboundSchema:
+  z.ZodNativeEnum<typeof SubscriptionIntervalEditOpBillingMode> = z.nativeEnum(
+    SubscriptionIntervalEditOpBillingMode,
+  );
+
+/** @internal */
+export type SubscriptionIntervalEditOp$Outbound = {
+  id: string;
+  unitPrice?: string | null | undefined;
+  baseQuantity?: string | undefined;
+  quantityTransitions?:
+    | Array<SubscriptionIntervalEditOpQuantityTransition$Outbound>
+    | undefined;
+  priceId?: string | undefined;
+  priceKey?: string | undefined;
+  planVersionId?: string | undefined;
+  billingCadence?: string | undefined;
+  billingMode?: string | undefined;
+  billDate?: string | null | undefined;
+  startDate?: string | undefined;
+  endDate?: string | null | undefined;
+};
+
+/** @internal */
+export const SubscriptionIntervalEditOp$outboundSchema: z.ZodType<
+  SubscriptionIntervalEditOp$Outbound,
+  z.ZodTypeDef,
+  SubscriptionIntervalEditOp
+> = z.object({
+  id: z.string(),
+  unitPrice: z.nullable(z.string()).optional(),
+  baseQuantity: z.string().optional(),
+  quantityTransitions: z.array(
+    z.lazy(() => SubscriptionIntervalEditOpQuantityTransition$outboundSchema),
+  ).optional(),
+  priceId: z.string().optional(),
+  priceKey: z.string().optional(),
+  planVersionId: z.string().optional(),
+  billingCadence: z.string().optional(),
+  billingMode: SubscriptionIntervalEditOpBillingMode$outboundSchema.optional(),
+  billDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  startDate: z.date().transform(v => v.toISOString()).optional(),
+  endDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+});
+
+export function subscriptionIntervalEditOpToJSON(
+  subscriptionIntervalEditOp: SubscriptionIntervalEditOp,
+): string {
+  return JSON.stringify(
+    SubscriptionIntervalEditOp$outboundSchema.parse(subscriptionIntervalEditOp),
+  );
+}

package/src/models/subscriptionintervalremoveop.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type SubscriptionIntervalRemoveOp = {
+  /**
+   * The interval being removed.
+   */
+  id: string;
+};
+
+/** @internal */
+export type SubscriptionIntervalRemoveOp$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const SubscriptionIntervalRemoveOp$outboundSchema: z.ZodType<
+  SubscriptionIntervalRemoveOp$Outbound,
+  z.ZodTypeDef,
+  SubscriptionIntervalRemoveOp
+> = z.object({
+  id: z.string(),
+});
+
+export function subscriptionIntervalRemoveOpToJSON(
+  subscriptionIntervalRemoveOp: SubscriptionIntervalRemoveOp,
+): string {
+  return JSON.stringify(
+    SubscriptionIntervalRemoveOp$outboundSchema.parse(
+      subscriptionIntervalRemoveOp,
+    ),
+  );
+}

package/src/models/subscriptionintervalsresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * 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 {
+  SubscriptionInterval,
+  SubscriptionInterval$inboundSchema,
+} from "./subscriptioninterval.js";
+
+export type SubscriptionIntervalsResponse = {
+  /**
+   * The subscription's price intervals, ordered by start date. Empty when it has none.
+   */
+  intervals: Array<SubscriptionInterval>;
+};
+
+/** @internal */
+export const SubscriptionIntervalsResponse$inboundSchema: z.ZodType<
+  SubscriptionIntervalsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  intervals: z.array(SubscriptionInterval$inboundSchema),
+});
+
+export function subscriptionIntervalsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionIntervalsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionIntervalsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionIntervalsResponse' from JSON`,
+  );
+}

package/src/models/subscriptionversionpolicy.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * How the subscription follows new versions of its plan. `floating` follows the plan's default version: when the default changes, the subscription bills from the new default from its next billing period. `pinned` keeps the plan version that the subscription holds. A subscription created without a value is `floating`. A change to this value does not change a billing period that has already started.
+ */
+export const SubscriptionVersionPolicy = {
+  Floating: "floating",
+  Pinned: "pinned",
+} as const;
+/**
+ * How the subscription follows new versions of its plan. `floating` follows the plan's default version: when the default changes, the subscription bills from the new default from its next billing period. `pinned` keeps the plan version that the subscription holds. A subscription created without a value is `floating`. A change to this value does not change a billing period that has already started.
+ */
+export type SubscriptionVersionPolicy = ClosedEnum<
+  typeof SubscriptionVersionPolicy
+>;
+
+/** @internal */
+export const SubscriptionVersionPolicy$inboundSchema: z.ZodNativeEnum<
+  typeof SubscriptionVersionPolicy
+> = z.nativeEnum(SubscriptionVersionPolicy);
+/** @internal */
+export const SubscriptionVersionPolicy$outboundSchema: z.ZodNativeEnum<
+  typeof SubscriptionVersionPolicy
+> = SubscriptionVersionPolicy$inboundSchema;

package/src/sdk/subscriptions.ts

@@ -5,8 +5,10 @@
 import { subscriptionsCreate } from "../funcs/subscriptionsCreate.js";
 import { subscriptionsCreateSubscriptionAdjustment } from "../funcs/subscriptionsCreateSubscriptionAdjustment.js";
 import { subscriptionsDeleteSubscriptionAdjustment } from "../funcs/subscriptionsDeleteSubscriptionAdjustment.js";
+import { subscriptionsEditSubscriptionIntervals } from "../funcs/subscriptionsEditSubscriptionIntervals.js";
 import { subscriptionsGeneratePortalLink } from "../funcs/subscriptionsGeneratePortalLink.js";
 import { subscriptionsGet } from "../funcs/subscriptionsGet.js";
+import { subscriptionsGetSubscriptionIntervals } from "../funcs/subscriptionsGetSubscriptionIntervals.js";
 import { subscriptionsList } from "../funcs/subscriptionsList.js";
 import { subscriptionsListSubscriptionAdjustments } from "../funcs/subscriptionsListSubscriptionAdjustments.js";
 import { subscriptionsReconcileSubscriptionFeatures } from "../funcs/subscriptionsReconcileSubscriptionFeatures.js";
@@ -77,6 +79,40 @@ export class Subscriptions extends ClientSDK {
     ));
   }
 
+  /**
+   * Get Price Intervals
+   *
+   * @remarks
+   * Returns all the price intervals of the subscription, ordered by start date. This includes intervals that ended and intervals that start in the future. If there are none, returns an empty array.
+   */
+  async getSubscriptionIntervals(
+    request: operations.GetSubscriptionIntervalsRequest,
+    options?: RequestOptions,
+  ): Promise<models.SubscriptionIntervalsResponse> {
+    return unwrapAsync(subscriptionsGetSubscriptionIntervals(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Edit Price Intervals
+   *
+   * @remarks
+   * Adds, edits, or removes price intervals on the subscription. Use an add to override a plan price for a period. Use an edit to change unitPrice, baseQuantity, quantityTransitions, or endDate. Use a remove to delete an interval. To close a price, set endDate. To re-open it, set endDate to null. To send an interval from a GET response as an edit, remove kind from it. An edit with no changed field changes nothing. If you send an add again after a timeout, it fails with 409 because it overlaps the first add. Use GET to check the result. The request is rejected if it changes a billing period that already exists, leaves a gap or an overlap, or bills a one-off price more than once.
+   */
+  async editSubscriptionIntervals(
+    request: operations.EditSubscriptionIntervalsRequest,
+    options?: RequestOptions,
+  ): Promise<models.EditSubscriptionIntervalsResponse> {
+    return unwrapAsync(subscriptionsEditSubscriptionIntervals(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Generate Portal Link
    *