@flexprice/sdk 2.1.30 → 2.1.34

package/src/sdk/models/provider-saved-payment-methods.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import {
+  PaymentGatewayType,
+  PaymentGatewayType$inboundSchema,
+} from "./payment-gateway-type.js";
+import {
+  ProviderError,
+  ProviderError$inboundSchema,
+} from "./provider-error.js";
+import {
+  SavedPaymentMethod,
+  SavedPaymentMethod$inboundSchema,
+} from "./saved-payment-method.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type ProviderSavedPaymentMethods = {
+  error?: ProviderError | undefined;
+  items?: Array<SavedPaymentMethod> | undefined;
+  provider?: PaymentGatewayType | undefined;
+};
+
+/** @internal */
+export const ProviderSavedPaymentMethods$inboundSchema: z.ZodMiniType<
+  ProviderSavedPaymentMethods,
+  unknown
+> = z.object({
+  error: types.optional(ProviderError$inboundSchema),
+  items: types.optional(z.array(SavedPaymentMethod$inboundSchema)),
+  provider: types.optional(PaymentGatewayType$inboundSchema),
+});
+
+export function providerSavedPaymentMethodsFromJSON(
+  jsonString: string,
+): SafeParseResult<ProviderSavedPaymentMethods, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProviderSavedPaymentMethods$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProviderSavedPaymentMethods' from JSON`,
+  );
+}

package/src/sdk/models/query-analytics-view-op.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  ViewQueryRequest,
+  ViewQueryRequest$Outbound,
+  ViewQueryRequest$outboundSchema,
+} from "./view-query-request.js";
+
+export type QueryAnalyticsViewRequest = {
+  /**
+   * View ID
+   */
+  id: string;
+  /**
+   * View query request
+   */
+  body: ViewQueryRequest;
+};
+
+/** @internal */
+export type QueryAnalyticsViewRequest$Outbound = {
+  id: string;
+  body: ViewQueryRequest$Outbound;
+};
+
+/** @internal */
+export const QueryAnalyticsViewRequest$outboundSchema: z.ZodMiniType<
+  QueryAnalyticsViewRequest$Outbound,
+  QueryAnalyticsViewRequest
+> = z.object({
+  id: z.string(),
+  body: ViewQueryRequest$outboundSchema,
+});
+
+export function queryAnalyticsViewRequestToJSON(
+  queryAnalyticsViewRequest: QueryAnalyticsViewRequest,
+): string {
+  return JSON.stringify(
+    QueryAnalyticsViewRequest$outboundSchema.parse(queryAnalyticsViewRequest),
+  );
+}

package/src/sdk/models/recurring-payment-status.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const RecurringPaymentStatus = {
+  Pending: "PENDING",
+  Active: "ACTIVE",
+  Paused: "PAUSED",
+  Rejected: "REJECTED",
+  Cancelled: "CANCELLED",
+  Expired: "EXPIRED",
+  Unknown: "UNKNOWN",
+} as const;
+export type RecurringPaymentStatus = OpenEnum<typeof RecurringPaymentStatus>;
+
+/** @internal */
+export const RecurringPaymentStatus$inboundSchema: z.ZodMiniType<
+  RecurringPaymentStatus,
+  unknown
+> = openEnums.inboundSchema(RecurringPaymentStatus);

package/src/sdk/models/remove-addon-ref.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  ProrationBehavior,
+  ProrationBehavior$outboundSchema,
+} from "./proration-behavior.js";
+
+export type RemoveAddonRef = {
+  associationId?: string | undefined;
+  effectiveDate?: Date | undefined;
+  prorationBehavior?: ProrationBehavior | undefined;
+  reason?: string | undefined;
+};
+
+/** @internal */
+export type RemoveAddonRef$Outbound = {
+  association_id?: string | undefined;
+  effective_date?: string | undefined;
+  proration_behavior?: string | undefined;
+  reason?: string | undefined;
+};
+
+/** @internal */
+export const RemoveAddonRef$outboundSchema: z.ZodMiniType<
+  RemoveAddonRef$Outbound,
+  RemoveAddonRef
+> = z.pipe(
+  z.object({
+    associationId: z.optional(z.string()),
+    effectiveDate: z.optional(
+      z.pipe(z.date(), z.transform(v => v.toISOString())),
+    ),
+    prorationBehavior: z.optional(ProrationBehavior$outboundSchema),
+    reason: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      associationId: "association_id",
+      effectiveDate: "effective_date",
+      prorationBehavior: "proration_behavior",
+    });
+  }),
+);
+
+export function removeAddonRefToJSON(removeAddonRef: RemoveAddonRef): string {
+  return JSON.stringify(RemoveAddonRef$outboundSchema.parse(removeAddonRef));
+}

package/src/sdk/models/remove-addon-request.ts

@@ -8,9 +8,11 @@ import {
   ProrationBehavior,
   ProrationBehavior$outboundSchema,
 } from "./proration-behavior.js";
+import { ScheduleType, ScheduleType$outboundSchema } from "./schedule-type.js";
 
 export type RemoveAddonRequest = {
   addonAssociationId: string;
+  changeAt?: ScheduleType | undefined;
   /**
    * EffectiveDate defaults to period end when nil; mid-period with create_prorations issues a wallet credit.
    */
@@ -22,6 +24,7 @@ export type RemoveAddonRequest = {
 /** @internal */
 export type RemoveAddonRequest$Outbound = {
   addon_association_id: string;
+  change_at?: string | undefined;
   effective_date?: string | undefined;
   proration_behavior?: string | undefined;
   reason?: string | undefined;
@@ -34,6 +37,7 @@ export const RemoveAddonRequest$outboundSchema: z.ZodMiniType<
 > = z.pipe(
   z.object({
     addonAssociationId: z.string(),
+    changeAt: z.optional(ScheduleType$outboundSchema),
     effectiveDate: z.optional(
       z.pipe(z.date(), z.transform(v => v.toISOString())),
     ),
@@ -43,6 +47,7 @@ export const RemoveAddonRequest$outboundSchema: z.ZodMiniType<
   z.transform((v) => {
     return remap$(v, {
       addonAssociationId: "addon_association_id",
+      changeAt: "change_at",
       effectiveDate: "effective_date",
       prorationBehavior: "proration_behavior",
     });

package/src/sdk/models/revenue-allocation-policy.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const RevenueAllocationPolicy = {
+  Billed: "billed",
+  Amortized: "amortized",
+} as const;
+export type RevenueAllocationPolicy = OpenEnum<typeof RevenueAllocationPolicy>;
+
+/** @internal */
+export const RevenueAllocationPolicy$inboundSchema: z.ZodMiniType<
+  RevenueAllocationPolicy,
+  unknown
+> = openEnums.inboundSchema(RevenueAllocationPolicy);
+/** @internal */
+export const RevenueAllocationPolicy$outboundSchema: z.ZodMiniType<
+  string,
+  RevenueAllocationPolicy
+> = openEnums.outboundSchema(RevenueAllocationPolicy);

package/src/sdk/models/revenue-analytics-request.ts

@@ -0,0 +1,168 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import {
+  FactStatus,
+  FactStatus$inboundSchema,
+  FactStatus$outboundSchema,
+} from "./fact-status.js";
+import {
+  RevenueAllocationPolicy,
+  RevenueAllocationPolicy$inboundSchema,
+  RevenueAllocationPolicy$outboundSchema,
+} from "./revenue-allocation-policy.js";
+import {
+  RevenueGranularity,
+  RevenueGranularity$inboundSchema,
+  RevenueGranularity$outboundSchema,
+} from "./revenue-granularity.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type RevenueAnalyticsRequest = {
+  allocationPolicy?: RevenueAllocationPolicy | undefined;
+  currency?: string | undefined;
+  /**
+   * Filters restrict the rows before aggregation.
+   */
+  customerIds?: Array<string> | undefined;
+  endTime?: Date | undefined;
+  granularity?: RevenueGranularity | undefined;
+  /**
+   * GroupBy dimensions: revenue_source, source (the event source recorded in
+   *
+   * @remarks
+   * meter_usage; requires customer_ids or subscription_ids), customer_id,
+   * subscription_id, price_id, meter_id, currency. revenue_source is always
+   * applied — every row says what kind of revenue it is — and requested
+   * dimensions are added on top.
+   */
+  groupBy?: Array<string> | undefined;
+  /**
+   * IncludeAdjustments breaks the non-obvious components — commitment
+   *
+   * @remarks
+   * true-ups, overage and revert (contra) rows — out as their own rows,
+   * each labeled with its kind in adjustment_type. Off, they fold into
+   * their parent buckets (true-up/overage into usage, reverts into their
+   * own source) so visible rows read as plain usage/fixed. Totals are
+   * identical either way.
+   */
+  includeAdjustments?: boolean | undefined;
+  meterIds?: Array<string> | undefined;
+  priceIds?: Array<string> | undefined;
+  /**
+   * StartTime/EndTime bound the day range (inclusive days derived in UTC).
+   *
+   * @remarks
+   * EndTime is optional and defaults to now.
+   */
+  startTime: Date;
+  status?: FactStatus | undefined;
+  subscriptionIds?: Array<string> | undefined;
+};
+
+/** @internal */
+export const RevenueAnalyticsRequest$inboundSchema: z.ZodMiniType<
+  RevenueAnalyticsRequest,
+  unknown
+> = z.pipe(
+  z.object({
+    allocation_policy: types.optional(RevenueAllocationPolicy$inboundSchema),
+    currency: types.optional(types.string()),
+    customer_ids: types.optional(z.array(types.string())),
+    end_time: types.optional(types.date()),
+    granularity: types.optional(RevenueGranularity$inboundSchema),
+    group_by: types.optional(z.array(types.string())),
+    include_adjustments: types.optional(types.boolean()),
+    meter_ids: types.optional(z.array(types.string())),
+    price_ids: types.optional(z.array(types.string())),
+    start_time: types.date(),
+    status: types.optional(FactStatus$inboundSchema),
+    subscription_ids: types.optional(z.array(types.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "allocation_policy": "allocationPolicy",
+      "customer_ids": "customerIds",
+      "end_time": "endTime",
+      "group_by": "groupBy",
+      "include_adjustments": "includeAdjustments",
+      "meter_ids": "meterIds",
+      "price_ids": "priceIds",
+      "start_time": "startTime",
+      "subscription_ids": "subscriptionIds",
+    });
+  }),
+);
+/** @internal */
+export type RevenueAnalyticsRequest$Outbound = {
+  allocation_policy?: string | undefined;
+  currency?: string | undefined;
+  customer_ids?: Array<string> | undefined;
+  end_time?: string | undefined;
+  granularity?: string | undefined;
+  group_by?: Array<string> | undefined;
+  include_adjustments?: boolean | undefined;
+  meter_ids?: Array<string> | undefined;
+  price_ids?: Array<string> | undefined;
+  start_time: string;
+  status?: string | undefined;
+  subscription_ids?: Array<string> | undefined;
+};
+
+/** @internal */
+export const RevenueAnalyticsRequest$outboundSchema: z.ZodMiniType<
+  RevenueAnalyticsRequest$Outbound,
+  RevenueAnalyticsRequest
+> = z.pipe(
+  z.object({
+    allocationPolicy: z.optional(RevenueAllocationPolicy$outboundSchema),
+    currency: z.optional(z.string()),
+    customerIds: z.optional(z.array(z.string())),
+    endTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    granularity: z.optional(RevenueGranularity$outboundSchema),
+    groupBy: z.optional(z.array(z.string())),
+    includeAdjustments: z.optional(z.boolean()),
+    meterIds: z.optional(z.array(z.string())),
+    priceIds: z.optional(z.array(z.string())),
+    startTime: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    status: z.optional(FactStatus$outboundSchema),
+    subscriptionIds: z.optional(z.array(z.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      allocationPolicy: "allocation_policy",
+      customerIds: "customer_ids",
+      endTime: "end_time",
+      groupBy: "group_by",
+      includeAdjustments: "include_adjustments",
+      meterIds: "meter_ids",
+      priceIds: "price_ids",
+      startTime: "start_time",
+      subscriptionIds: "subscription_ids",
+    });
+  }),
+);
+
+export function revenueAnalyticsRequestToJSON(
+  revenueAnalyticsRequest: RevenueAnalyticsRequest,
+): string {
+  return JSON.stringify(
+    RevenueAnalyticsRequest$outboundSchema.parse(revenueAnalyticsRequest),
+  );
+}
+export function revenueAnalyticsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<RevenueAnalyticsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RevenueAnalyticsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RevenueAnalyticsRequest' from JSON`,
+  );
+}

package/src/sdk/models/revenue-analytics-response.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import {
+  RevenueAnalyticsRequest,
+  RevenueAnalyticsRequest$inboundSchema,
+} from "./revenue-analytics-request.js";
+import {
+  RevenueAnalyticsRow,
+  RevenueAnalyticsRow$inboundSchema,
+} from "./revenue-analytics-row.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type RevenueAnalyticsResponse = {
+  /**
+   * ContainsAllocated is true when any bucket includes whole-period amounts
+   *
+   * @remarks
+   * spread across days (amortized) or booked on a single day (billed) —
+   * i.e. the day view carries period-shaped charges, not only true daily
+   * accruals.
+   */
+  containsAllocated?: boolean | undefined;
+  query?: RevenueAnalyticsRequest | undefined;
+  rows?: Array<RevenueAnalyticsRow> | undefined;
+};
+
+/** @internal */
+export const RevenueAnalyticsResponse$inboundSchema: z.ZodMiniType<
+  RevenueAnalyticsResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    contains_allocated: types.optional(types.boolean()),
+    query: types.optional(RevenueAnalyticsRequest$inboundSchema),
+    rows: types.optional(z.array(RevenueAnalyticsRow$inboundSchema)),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "contains_allocated": "containsAllocated",
+    });
+  }),
+);
+
+export function revenueAnalyticsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RevenueAnalyticsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RevenueAnalyticsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RevenueAnalyticsResponse' from JSON`,
+  );
+}

package/src/sdk/models/revenue-analytics-row.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { FactStatus, FactStatus$inboundSchema } from "./fact-status.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type RevenueAnalyticsRow = {
+  /**
+   * AdjustmentType labels rows broken out by include_adjustments:
+   *
+   * @remarks
+   * "commitment_trueup", "overage" or "revert". Empty for plain rows.
+   */
+  adjustmentType?: string | undefined;
+  billableQty?: number | undefined;
+  /**
+   * Day is set for day granularity; PeriodStart/PeriodEnd for period.
+   */
+  day?: string | undefined;
+  entitlementAmount?: number | undefined;
+  entitlementQty?: number | undefined;
+  /**
+   * Group holds the requested dimensions and their values for this bucket.
+   */
+  group?: { [k: string]: string } | undefined;
+  invoiceDiscount?: number | undefined;
+  lineDiscount?: number | undefined;
+  netAmount?: number | undefined;
+  periodEnd?: Date | undefined;
+  periodStart?: Date | undefined;
+  status?: FactStatus | undefined;
+  tierDelta?: number | undefined;
+  usageAtListRate?: number | undefined;
+};
+
+/** @internal */
+export const RevenueAnalyticsRow$inboundSchema: z.ZodMiniType<
+  RevenueAnalyticsRow,
+  unknown
+> = z.pipe(
+  z.object({
+    adjustment_type: types.optional(types.string()),
+    billable_qty: types.optional(types.number()),
+    day: types.optional(types.string()),
+    entitlement_amount: types.optional(types.number()),
+    entitlement_qty: types.optional(types.number()),
+    group: types.optional(z.record(z.string(), types.string())),
+    invoice_discount: types.optional(types.number()),
+    line_discount: types.optional(types.number()),
+    net_amount: types.optional(types.number()),
+    period_end: types.optional(types.date()),
+    period_start: types.optional(types.date()),
+    status: types.optional(FactStatus$inboundSchema),
+    tier_delta: types.optional(types.number()),
+    usage_at_list_rate: types.optional(types.number()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "adjustment_type": "adjustmentType",
+      "billable_qty": "billableQty",
+      "entitlement_amount": "entitlementAmount",
+      "entitlement_qty": "entitlementQty",
+      "invoice_discount": "invoiceDiscount",
+      "line_discount": "lineDiscount",
+      "net_amount": "netAmount",
+      "period_end": "periodEnd",
+      "period_start": "periodStart",
+      "tier_delta": "tierDelta",
+      "usage_at_list_rate": "usageAtListRate",
+    });
+  }),
+);
+
+export function revenueAnalyticsRowFromJSON(
+  jsonString: string,
+): SafeParseResult<RevenueAnalyticsRow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RevenueAnalyticsRow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RevenueAnalyticsRow' from JSON`,
+  );
+}

package/src/sdk/models/revenue-granularity.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const RevenueGranularity = {
+  Day: "day",
+  Period: "period",
+  Total: "total",
+} as const;
+export type RevenueGranularity = OpenEnum<typeof RevenueGranularity>;
+
+/** @internal */
+export const RevenueGranularity$inboundSchema: z.ZodMiniType<
+  RevenueGranularity,
+  unknown
+> = openEnums.inboundSchema(RevenueGranularity);
+/** @internal */
+export const RevenueGranularity$outboundSchema: z.ZodMiniType<
+  string,
+  RevenueGranularity
+> = openEnums.outboundSchema(RevenueGranularity);

package/src/sdk/models/saved-card-details.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type SavedCardDetails = {
+  brand?: string | undefined;
+  expMonth?: number | undefined;
+  expYear?: number | undefined;
+  last4?: string | undefined;
+};
+
+/** @internal */
+export const SavedCardDetails$inboundSchema: z.ZodMiniType<
+  SavedCardDetails,
+  unknown
+> = z.pipe(
+  z.object({
+    brand: types.optional(types.string()),
+    exp_month: types.optional(types.number()),
+    exp_year: types.optional(types.number()),
+    last4: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "exp_month": "expMonth",
+      "exp_year": "expYear",
+    });
+  }),
+);
+
+export function savedCardDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<SavedCardDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SavedCardDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SavedCardDetails' from JSON`,
+  );
+}