@flexprice/mcp-server 2.1.1 → 2.1.3

package/src/mcp-server/tools/subscriptionsPreviewSubscriptionModify.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { subscriptionsPreviewSubscriptionModify } from "../../funcs/subscriptionsPreviewSubscriptionModify.js";
+import { PreviewSubscriptionModifyRequest$zodSchema } from "../../models/previewsubscriptionmodifyop.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: PreviewSubscriptionModifyRequest$zodSchema,
+};
+
+export const tool$subscriptionsPreviewSubscriptionModify: ToolDefinition<
+  typeof args
+> = {
+  name: "preview-subscription-modify",
+  description: `Preview subscription modification
+
+Preview the impact of a mid-cycle subscription modification without committing changes.`,
+  scopes: ["read"],
+  annotations: {
+    "title": "",
+    "destructiveHint": false,
+    "idempotentHint": false,
+    "openWorldHint": false,
+    "readOnlyHint": true,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result] = await subscriptionsPreviewSubscriptionModify(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(result.value);
+  },
+};

package/src/models/address.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type Address = {
+  address_city?: string | undefined;
+  address_country?: string | undefined;
+  address_line1?: string | undefined;
+  address_line2?: string | undefined;
+  address_postal_code?: string | undefined;
+  address_state?: string | undefined;
+};
+
+export const Address$zodSchema: z.ZodType<Address> = z.object({
+  address_city: z.string().optional(),
+  address_country: z.string().optional(),
+  address_line1: z.string().optional(),
+  address_line2: z.string().optional(),
+  address_postal_code: z.string().optional(),
+  address_state: z.string().optional(),
+});

package/src/models/alertstate.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+
+export const AlertState = {
+  Ok: "ok",
+  Info: "info",
+  Warning: "warning",
+  InAlarm: "in_alarm",
+} as const;
+export type AlertState = ClosedEnum<typeof AlertState>;
+
+export const AlertState$zodSchema = z.enum([
+  "ok",
+  "info",
+  "warning",
+  "in_alarm",
+]);

package/src/models/autotopup.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type AutoTopup = {
+  amount?: number | undefined;
+  enabled?: boolean | undefined;
+  invoicing?: boolean | undefined;
+  threshold?: number | undefined;
+};
+
+export const AutoTopup$zodSchema: z.ZodType<AutoTopup> = z.object({
+  amount: z.number().optional(),
+  enabled: z.boolean().optional(),
+  invoicing: z.boolean().optional(),
+  threshold: z.number().optional(),
+});

package/src/models/billingcadence.ts

@@ -7,11 +7,9 @@ import { ClosedEnum } from "../types/enums.js";
 
 export const BillingCadence = {
   Recurring: "RECURRING",
-  Onetime: "ONETIME",
 } as const;
 export type BillingCadence = ClosedEnum<typeof BillingCadence>;
 
 export const BillingCadence$zodSchema = z.enum([
   "RECURRING",
-  "ONETIME",
 ]);

package/src/models/billingperiod.ts

@@ -12,6 +12,7 @@ export const BillingPeriod = {
   Daily: "DAILY",
   Quarterly: "QUARTERLY",
   HalfYearly: "HALF_YEARLY",
+  Onetime: "ONETIME",
 } as const;
 export type BillingPeriod = ClosedEnum<typeof BillingPeriod>;
 
@@ -22,4 +23,5 @@ export const BillingPeriod$zodSchema = z.enum([
   "DAILY",
   "QUARTERLY",
   "HALF_YEARLY",
+  "ONETIME",
 ]);

package/src/models/changedinvoice.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  ChangedInvoiceAction,
+  ChangedInvoiceAction$zodSchema,
+} from "./changedinvoiceaction.js";
+import {
+  ChangedInvoiceStatus,
+  ChangedInvoiceStatus$zodSchema,
+} from "./changedinvoicestatus.js";
+import {
+  InvoiceResponse,
+  InvoiceResponse$zodSchema,
+} from "./invoiceresponse.js";
+import {
+  WalletTransactionResponse,
+  WalletTransactionResponse$zodSchema,
+} from "./wallettransactionresponse.js";
+
+export type ChangedInvoice = {
+  action?: ChangedInvoiceAction | undefined;
+  id?: string | undefined;
+  invoice?: InvoiceResponse | undefined;
+  status?: ChangedInvoiceStatus | undefined;
+  wallet_transaction?: WalletTransactionResponse | undefined;
+};
+
+export const ChangedInvoice$zodSchema: z.ZodType<ChangedInvoice> = z.object({
+  action: ChangedInvoiceAction$zodSchema.optional().describe(
+    "created (proration invoice) | wallet_credit (downgrade credit)",
+  ),
+  id: z.string().optional(),
+  invoice: InvoiceResponse$zodSchema.optional(),
+  status: ChangedInvoiceStatus$zodSchema.optional().describe(
+    "preview | issued | INITIATED | PENDING | PROCESSING | SUCCEEDED | OVERPAID | FAILED | REFUNDED | PARTIALLY_REFUNDED",
+  ),
+  wallet_transaction: WalletTransactionResponse$zodSchema.optional(),
+});

package/src/models/changedinvoiceaction.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * created (proration invoice) | wallet_credit (downgrade credit)
+ */
+export const ChangedInvoiceAction = {
+  Created: "created",
+  WalletCredit: "wallet_credit",
+} as const;
+/**
+ * created (proration invoice) | wallet_credit (downgrade credit)
+ */
+export type ChangedInvoiceAction = ClosedEnum<typeof ChangedInvoiceAction>;
+
+export const ChangedInvoiceAction$zodSchema = z.enum([
+  "created",
+  "wallet_credit",
+]).describe("created (proration invoice) | wallet_credit (downgrade credit)");

package/src/models/changedinvoicestatus.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * preview | issued | INITIATED | PENDING | PROCESSING | SUCCEEDED | OVERPAID | FAILED | REFUNDED | PARTIALLY_REFUNDED
+ */
+export const ChangedInvoiceStatus = {
+  Preview: "preview",
+  Issued: "issued",
+} as const;
+/**
+ * preview | issued | INITIATED | PENDING | PROCESSING | SUCCEEDED | OVERPAID | FAILED | REFUNDED | PARTIALLY_REFUNDED
+ */
+export type ChangedInvoiceStatus = ClosedEnum<typeof ChangedInvoiceStatus>;
+
+export const ChangedInvoiceStatus$zodSchema = z.enum([
+  "preview",
+  "issued",
+]).describe(
+  "preview | issued | INITIATED | PENDING | PROCESSING | SUCCEEDED | OVERPAID | FAILED | REFUNDED | PARTIALLY_REFUNDED",
+);

package/src/models/changedlineitem.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  ChangedLineItemAction,
+  ChangedLineItemAction$zodSchema,
+} from "./changedlineitemaction.js";
+
+export type ChangedLineItem = {
+  change_action?: ChangedLineItemAction | undefined;
+  end_date?: string | undefined;
+  id?: string | undefined;
+  price_id?: string | undefined;
+  quantity?: string | undefined;
+  start_date?: string | undefined;
+};
+
+export const ChangedLineItem$zodSchema: z.ZodType<ChangedLineItem> = z.object({
+  change_action: ChangedLineItemAction$zodSchema.optional().describe(
+    "created | updated | ended",
+  ),
+  end_date: z.iso.datetime({ offset: true }).optional(),
+  id: z.string().optional(),
+  price_id: z.string().optional(),
+  quantity: z.string().optional(),
+  start_date: z.iso.datetime({ offset: true }).optional(),
+});

package/src/models/changedlineitemaction.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * created | updated | ended
+ */
+export const ChangedLineItemAction = {
+  Created: "created",
+  Updated: "updated",
+  Ended: "ended",
+} as const;
+/**
+ * created | updated | ended
+ */
+export type ChangedLineItemAction = ClosedEnum<typeof ChangedLineItemAction>;
+
+export const ChangedLineItemAction$zodSchema = z.enum([
+  "created",
+  "updated",
+  "ended",
+]).describe("created | updated | ended");

package/src/models/changedresources.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ChangedInvoice, ChangedInvoice$zodSchema } from "./changedinvoice.js";
+import {
+  ChangedLineItem,
+  ChangedLineItem$zodSchema,
+} from "./changedlineitem.js";
+import {
+  ChangedSubscription,
+  ChangedSubscription$zodSchema,
+} from "./changedsubscription.js";
+
+export type ChangedResources = {
+  invoices?: Array<ChangedInvoice> | undefined;
+  line_items?: Array<ChangedLineItem> | undefined;
+  subscriptions?: Array<ChangedSubscription> | undefined;
+};
+
+export const ChangedResources$zodSchema: z.ZodType<ChangedResources> = z.object(
+  {
+    invoices: z.array(ChangedInvoice$zodSchema).optional(),
+    line_items: z.array(ChangedLineItem$zodSchema).optional(),
+    subscriptions: z.array(ChangedSubscription$zodSchema).optional(),
+  },
+);

package/src/models/changedsubscription.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  ChangedSubscriptionAction,
+  ChangedSubscriptionAction$zodSchema,
+} from "./changedsubscriptionaction.js";
+import {
+  SubscriptionStatus,
+  SubscriptionStatus$zodSchema,
+} from "./subscriptionstatus.js";
+
+export type ChangedSubscription = {
+  action?: ChangedSubscriptionAction | undefined;
+  id?: string | undefined;
+  status?: SubscriptionStatus | undefined;
+};
+
+export const ChangedSubscription$zodSchema: z.ZodType<ChangedSubscription> = z
+  .object({
+    action: ChangedSubscriptionAction$zodSchema.optional().describe(
+      "created | updated",
+    ),
+    id: z.string().optional(),
+    status: SubscriptionStatus$zodSchema.optional(),
+  });

package/src/models/changedsubscriptionaction.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * created | updated
+ */
+export const ChangedSubscriptionAction = {
+  Created: "created",
+  Updated: "updated",
+} as const;
+/**
+ * created | updated
+ */
+export type ChangedSubscriptionAction = ClosedEnum<
+  typeof ChangedSubscriptionAction
+>;
+
+export const ChangedSubscriptionAction$zodSchema = z.enum([
+  "created",
+  "updated",
+]).describe("created | updated");

package/src/models/{postplansidcloneop.ts → cloneplanop.ts}

@@ -10,20 +10,19 @@ import {
 import { ErrorResponse, ErrorResponse$zodSchema } from "./errorresponse.js";
 import { PlanResponse, PlanResponse$zodSchema } from "./planresponse.js";
 
-export type PostPlansIdCloneRequest = { id: string; body: ClonePlanRequest };
+export type ClonePlanRequestRequest = { id: string; body: ClonePlanRequest };
 
-export const PostPlansIdCloneRequest$zodSchema: z.ZodType<
-  PostPlansIdCloneRequest
+export const ClonePlanRequestRequest$zodSchema: z.ZodType<
+  ClonePlanRequestRequest
 > = z.object({
   body: ClonePlanRequest$zodSchema.describe("Clone configuration"),
   id: z.string().describe("Source Plan ID"),
 });
 
-export type PostPlansIdCloneResponse = PlanResponse | ErrorResponse;
+export type ClonePlanResponse = PlanResponse | ErrorResponse;
 
-export const PostPlansIdCloneResponse$zodSchema: z.ZodType<
-  PostPlansIdCloneResponse
-> = z.union([
-  PlanResponse$zodSchema,
-  ErrorResponse$zodSchema,
-]);
+export const ClonePlanResponse$zodSchema: z.ZodType<ClonePlanResponse> = z
+  .union([
+    PlanResponse$zodSchema,
+    ErrorResponse$zodSchema,
+  ]);

package/src/models/createpricerequest.ts

@@ -3,7 +3,6 @@
  */
 
 import * as z from "zod";
-import { BillingCadence, BillingCadence$zodSchema } from "./billingcadence.js";
 import { BillingModel, BillingModel$zodSchema } from "./billingmodel.js";
 import { BillingPeriod, BillingPeriod$zodSchema } from "./billingperiod.js";
 import { BillingTier, BillingTier$zodSchema } from "./billingtier.js";
@@ -29,7 +28,6 @@ import { PriceUnitType, PriceUnitType$zodSchema } from "./priceunittype.js";
 
 export type CreatePriceRequest = {
   amount?: string | undefined;
-  billing_cadence: BillingCadence;
   billing_model: BillingModel;
   billing_period: BillingPeriod;
   billing_period_count?: number | undefined;
@@ -59,7 +57,6 @@ export type CreatePriceRequest = {
 export const CreatePriceRequest$zodSchema: z.ZodType<CreatePriceRequest> = z
   .object({
     amount: z.string().optional(),
-    billing_cadence: BillingCadence$zodSchema,
     billing_model: BillingModel$zodSchema,
     billing_period: BillingPeriod$zodSchema,
     billing_period_count: z.int().optional(),

package/src/models/createsubscriptionrequest.ts

@@ -7,7 +7,6 @@ import {
   AddAddonToSubscriptionRequest,
   AddAddonToSubscriptionRequest$zodSchema,
 } from "./addaddontosubscriptionrequest.js";
-import { BillingCadence, BillingCadence$zodSchema } from "./billingcadence.js";
 import { BillingCycle, BillingCycle$zodSchema } from "./billingcycle.js";
 import { BillingPeriod, BillingPeriod$zodSchema } from "./billingperiod.js";
 import {
@@ -62,7 +61,7 @@ import {
 
 export type CreateSubscriptionRequest = {
   addons?: Array<AddAddonToSubscriptionRequest> | undefined;
-  billing_cadence: BillingCadence;
+  billing_anchor?: string | undefined;
   billing_cycle?: BillingCycle | undefined;
   billing_period: BillingPeriod;
   billing_period_count?: number | undefined;
@@ -105,7 +104,9 @@ export const CreateSubscriptionRequest$zodSchema: z.ZodType<
   addons: z.array(AddAddonToSubscriptionRequest$zodSchema).optional().describe(
     "Addons represents addons to be added to the subscription during creation",
   ),
-  billing_cadence: BillingCadence$zodSchema,
+  billing_anchor: z.iso.datetime({ offset: true }).optional().describe(
+    "BillingAnchor overrides the derived billing anchor when billing_cycle is anniversary.\nFor monthly billing, the day-of-month (and time-of-day) define cycle boundaries: if start_date\nis before that day in the month, the first billing period ends on the next occurrence of that\nday in the same month (a shorter first period); subsequent periods follow the usual interval.",
+  ),
   billing_cycle: BillingCycle$zodSchema.optional(),
   billing_period: BillingPeriod$zodSchema,
   billing_period_count: z.int().optional(),

package/src/models/creditbreakdown.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CreditBreakdown = {
+  free?: string | undefined;
+  purchased?: string | undefined;
+};
+
+export const CreditBreakdown$zodSchema: z.ZodType<CreditBreakdown> = z.object({
+  free: z.string().optional(),
+  purchased: z.string().optional(),
+});

package/src/models/executesubscriptionmodifyop.ts

@@ -5,35 +5,35 @@
 import * as z from "zod";
 import { ErrorResponse, ErrorResponse$zodSchema } from "./errorresponse.js";
 import {
-  ExecuteSubscriptionInheritanceRequest,
-  ExecuteSubscriptionInheritanceRequest$zodSchema,
-} from "./executesubscriptioninheritancerequest.js";
+  ExecuteSubscriptionModifyRequest,
+  ExecuteSubscriptionModifyRequest$zodSchema,
+} from "./executesubscriptionmodifyrequest.js";
 import {
-  SubscriptionResponse,
-  SubscriptionResponse$zodSchema,
-} from "./subscriptionresponse.js";
+  SubscriptionModifyResponse,
+  SubscriptionModifyResponse$zodSchema,
+} from "./subscriptionmodifyresponse.js";
 
-export type ExecuteSubscriptionModifyRequest = {
+export type ExecuteSubscriptionModifyRequestRequest = {
   id: string;
-  body: ExecuteSubscriptionInheritanceRequest;
+  body: ExecuteSubscriptionModifyRequest;
 };
 
-export const ExecuteSubscriptionModifyRequest$zodSchema: z.ZodType<
-  ExecuteSubscriptionModifyRequest
+export const ExecuteSubscriptionModifyRequestRequest$zodSchema: z.ZodType<
+  ExecuteSubscriptionModifyRequestRequest
 > = z.object({
-  body: ExecuteSubscriptionInheritanceRequest$zodSchema.describe(
-    "External customer IDs to inherit",
+  body: ExecuteSubscriptionModifyRequest$zodSchema.describe(
+    "Modification request",
   ),
   id: z.string().describe("Subscription ID"),
 });
 
 export type ExecuteSubscriptionModifyResponse =
-  | SubscriptionResponse
+  | SubscriptionModifyResponse
   | ErrorResponse;
 
 export const ExecuteSubscriptionModifyResponse$zodSchema: z.ZodType<
   ExecuteSubscriptionModifyResponse
 > = z.union([
-  SubscriptionResponse$zodSchema,
+  SubscriptionModifyResponse$zodSchema,
   ErrorResponse$zodSchema,
 ]);

package/src/models/executesubscriptionmodifyrequest.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  SubModifyInheritanceRequest,
+  SubModifyInheritanceRequest$zodSchema,
+} from "./submodifyinheritancerequest.js";
+import {
+  SubModifyQuantityChangeRequest,
+  SubModifyQuantityChangeRequest$zodSchema,
+} from "./submodifyquantitychangerequest.js";
+import {
+  SubscriptionModifyType,
+  SubscriptionModifyType$zodSchema,
+} from "./subscriptionmodifytype.js";
+
+export type ExecuteSubscriptionModifyRequest = {
+  inheritance_params?: SubModifyInheritanceRequest | undefined;
+  quantity_change_params?: SubModifyQuantityChangeRequest | undefined;
+  type: SubscriptionModifyType;
+};
+
+export const ExecuteSubscriptionModifyRequest$zodSchema: z.ZodType<
+  ExecuteSubscriptionModifyRequest
+> = z.object({
+  inheritance_params: SubModifyInheritanceRequest$zodSchema.optional(),
+  quantity_change_params: SubModifyQuantityChangeRequest$zodSchema.optional(),
+  type: SubscriptionModifyType$zodSchema,
+});

package/src/models/getmeterusagepreviewinvoiceop.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ErrorResponse, ErrorResponse$zodSchema } from "./errorresponse.js";
+import {
+  InvoiceResponse,
+  InvoiceResponse$zodSchema,
+} from "./invoiceresponse.js";
+
+export type GetMeterUsagePreviewInvoiceResponse =
+  | InvoiceResponse
+  | ErrorResponse;
+
+export const GetMeterUsagePreviewInvoiceResponse$zodSchema: z.ZodType<
+  GetMeterUsagePreviewInvoiceResponse
+> = z.union([
+  InvoiceResponse$zodSchema,
+  ErrorResponse$zodSchema,
+]);

package/src/models/invoicefilter.ts

@@ -48,6 +48,7 @@ export type InvoiceFilter = {
   sort?: Array<SortCondition> | undefined;
   start_time?: string | undefined;
   status?: Status | undefined;
+  subscription_customer_id?: Array<string> | undefined;
   subscription_id?: string | undefined;
 };
 
@@ -98,6 +99,9 @@ export const InvoiceFilter$zodSchema: z.ZodType<InvoiceFilter> = z.object({
   sort: z.array(SortCondition$zodSchema).optional(),
   start_time: z.iso.datetime({ offset: true }).optional(),
   status: Status$zodSchema.optional(),
+  subscription_customer_id: z.array(z.string()).optional().describe(
+    "subscription_customer_id filters invoices by the subscription owner's customer ID",
+  ),
   subscription_id: z.string().optional().describe(
     "subscription_id filters invoices generated for a specific subscription\nOnly returns invoices that were created as part of the specified subscription's billing",
   ),

package/src/models/invoiceresponse.ts

@@ -64,6 +64,7 @@ export type InvoiceResponse = {
   refunded_amount?: string | undefined;
   status?: Status | undefined;
   subscription?: SubscriptionResponse | undefined;
+  subscription_customer_id?: string | undefined;
   subscription_id?: string | undefined;
   subtotal?: string | undefined;
   taxes?: Array<TaxAppliedResponse> | undefined;
@@ -169,6 +170,9 @@ export const InvoiceResponse$zodSchema: z.ZodType<InvoiceResponse> = z.object({
   ),
   status: Status$zodSchema.optional(),
   subscription: z.lazy(() => SubscriptionResponse$zodSchema).optional(),
+  subscription_customer_id: z.string().optional().describe(
+    "subscription_customer_id is the subscription owner's customer ID (Subscription.CustomerID).\nIt may differ from customer_id when the subscription uses an invoicing customer. Set internally; nullable in DB.",
+  ),
   subscription_id: z.string().optional().describe(
     "subscription_id is the ID of the subscription this invoice is associated with (only present for subscription-based invoices)",
   ),

package/src/models/lineitemquantitychange.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type LineItemQuantityChange = {
+  effective_date?: string | undefined;
+  id: string;
+  quantity: string;
+};
+
+export const LineItemQuantityChange$zodSchema: z.ZodType<
+  LineItemQuantityChange
+> = z.object({
+  effective_date: z.iso.datetime({ offset: true }).optional().describe(
+    "EffectiveDate is when the quantity change takes effect.\nIf omitted, the change is effective immediately (now).",
+  ),
+  id: z.string(),
+  quantity: z.string(),
+});