@flexprice/sdk 2.1.26 → 2.1.33

package/src/sdk/models/process-credit-note-op.ts

@@ -3,17 +3,27 @@
  */
 
 import * as z from "zod/v4-mini";
+import {
+  FinalizeCreditNoteRequest,
+  FinalizeCreditNoteRequest$Outbound,
+  FinalizeCreditNoteRequest$outboundSchema,
+} from "./finalize-credit-note-request.js";
 
 export type ProcessCreditNoteRequest = {
   /**
    * Credit note ID
    */
   id: string;
+  /**
+   * Finalize options
+   */
+  body?: FinalizeCreditNoteRequest | undefined;
 };
 
 /** @internal */
 export type ProcessCreditNoteRequest$Outbound = {
   id: string;
+  body?: FinalizeCreditNoteRequest$Outbound | undefined;
 };
 
 /** @internal */
@@ -22,6 +32,7 @@ export const ProcessCreditNoteRequest$outboundSchema: z.ZodMiniType<
   ProcessCreditNoteRequest
 > = z.object({
   id: z.string(),
+  body: z.optional(FinalizeCreditNoteRequest$outboundSchema),
 });
 
 export function processCreditNoteRequestToJSON(

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/refund-destination.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 RefundDestination = {
+  Gateway: "GATEWAY",
+  Wallet: "WALLET",
+  OutOfBand: "OUT_OF_BAND",
+} as const;
+export type RefundDestination = OpenEnum<typeof RefundDestination>;
+
+/** @internal */
+export const RefundDestination$inboundSchema: z.ZodMiniType<
+  RefundDestination,
+  unknown
+> = openEnums.inboundSchema(RefundDestination);

package/src/sdk/models/refund-reason.ts

@@ -0,0 +1,21 @@
+/*
+ * 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 RefundReason = {
+  Duplicate: "DUPLICATE",
+  Fraudulent: "FRAUDULENT",
+  RequestedByCustomer: "REQUESTED_BY_CUSTOMER",
+  OrderChange: "ORDER_CHANGE",
+  ServiceIssue: "SERVICE_ISSUE",
+  Other: "OTHER",
+} as const;
+export type RefundReason = OpenEnum<typeof RefundReason>;
+
+/** @internal */
+export const RefundReason$inboundSchema: z.ZodMiniType<RefundReason, unknown> =
+  openEnums.inboundSchema(RefundReason);

package/src/sdk/models/refund-response.ts

@@ -0,0 +1,130 @@
+/*
+ * 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 {
+  RefundDestination,
+  RefundDestination$inboundSchema,
+} from "./refund-destination.js";
+import { RefundReason, RefundReason$inboundSchema } from "./refund-reason.js";
+import { RefundStatus, RefundStatus$inboundSchema } from "./refund-status.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import { Status, Status$inboundSchema } from "./status.js";
+
+export type RefundResponse = {
+  amount?: string | undefined;
+  attempt?: number | undefined;
+  cancelledAt?: Date | undefined;
+  createdAt?: Date | undefined;
+  createdBy?: string | undefined;
+  creditNoteId?: string | undefined;
+  currency?: string | undefined;
+  environmentId?: string | undefined;
+  failedAt?: Date | undefined;
+  failureReason?: string | undefined;
+  gatewayIdempotencyToken?: string | undefined;
+  gatewayMetadata?: { [k: string]: any } | undefined;
+  gatewayRefundId?: string | undefined;
+  gatewayTrackingId?: string | undefined;
+  id?: string | undefined;
+  idempotencyKey?: string | undefined;
+  initiatedAt?: Date | undefined;
+  invoiceId?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  paymentGateway?: string | undefined;
+  paymentId?: string | undefined;
+  refundDestination?: RefundDestination | undefined;
+  refundDestinationId?: string | undefined;
+  refundReason?: RefundReason | undefined;
+  refundStatus?: RefundStatus | undefined;
+  settledAmount?: string | undefined;
+  status?: Status | undefined;
+  succeededAt?: Date | undefined;
+  tenantId?: string | undefined;
+  updatedAt?: Date | undefined;
+  updatedBy?: string | undefined;
+};
+
+/** @internal */
+export const RefundResponse$inboundSchema: z.ZodMiniType<
+  RefundResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    amount: types.optional(types.string()),
+    attempt: types.optional(types.number()),
+    cancelled_at: types.optional(types.date()),
+    created_at: types.optional(types.date()),
+    created_by: types.optional(types.string()),
+    credit_note_id: types.optional(types.string()),
+    currency: types.optional(types.string()),
+    environment_id: types.optional(types.string()),
+    failed_at: types.optional(types.date()),
+    failure_reason: types.optional(types.string()),
+    gateway_idempotency_token: types.optional(types.string()),
+    gateway_metadata: types.optional(z.record(z.string(), z.any())),
+    gateway_refund_id: types.optional(types.string()),
+    gateway_tracking_id: types.optional(types.string()),
+    id: types.optional(types.string()),
+    idempotency_key: types.optional(types.string()),
+    initiated_at: types.optional(types.date()),
+    invoice_id: types.optional(types.string()),
+    metadata: types.optional(z.record(z.string(), types.string())),
+    payment_gateway: types.optional(types.string()),
+    payment_id: types.optional(types.string()),
+    refund_destination: types.optional(RefundDestination$inboundSchema),
+    refund_destination_id: types.optional(types.string()),
+    refund_reason: types.optional(RefundReason$inboundSchema),
+    refund_status: types.optional(RefundStatus$inboundSchema),
+    settled_amount: types.optional(types.string()),
+    status: types.optional(Status$inboundSchema),
+    succeeded_at: types.optional(types.date()),
+    tenant_id: types.optional(types.string()),
+    updated_at: types.optional(types.date()),
+    updated_by: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "cancelled_at": "cancelledAt",
+      "created_at": "createdAt",
+      "created_by": "createdBy",
+      "credit_note_id": "creditNoteId",
+      "environment_id": "environmentId",
+      "failed_at": "failedAt",
+      "failure_reason": "failureReason",
+      "gateway_idempotency_token": "gatewayIdempotencyToken",
+      "gateway_metadata": "gatewayMetadata",
+      "gateway_refund_id": "gatewayRefundId",
+      "gateway_tracking_id": "gatewayTrackingId",
+      "idempotency_key": "idempotencyKey",
+      "initiated_at": "initiatedAt",
+      "invoice_id": "invoiceId",
+      "payment_gateway": "paymentGateway",
+      "payment_id": "paymentId",
+      "refund_destination": "refundDestination",
+      "refund_destination_id": "refundDestinationId",
+      "refund_reason": "refundReason",
+      "refund_status": "refundStatus",
+      "settled_amount": "settledAmount",
+      "succeeded_at": "succeededAt",
+      "tenant_id": "tenantId",
+      "updated_at": "updatedAt",
+      "updated_by": "updatedBy",
+    });
+  }),
+);
+
+export function refundResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RefundResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RefundResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RefundResponse' from JSON`,
+  );
+}

package/src/sdk/models/refund-status.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 RefundStatus = {
+  Pending: "PENDING",
+  Processing: "PROCESSING",
+  Succeeded: "SUCCEEDED",
+  Failed: "FAILED",
+  Cancelled: "CANCELLED",
+} as const;
+export type RefundStatus = OpenEnum<typeof RefundStatus>;
+
+/** @internal */
+export const RefundStatus$inboundSchema: z.ZodMiniType<RefundStatus, unknown> =
+  openEnums.inboundSchema(RefundStatus);

package/src/sdk/models/refund-target.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const RefundTarget = {
+  PrepaidWallet: "PREPAID_WALLET",
+  BackToSource: "BACK_TO_SOURCE",
+} as const;
+export type RefundTarget = ClosedEnum<typeof RefundTarget>;
+
+/** @internal */
+export const RefundTarget$outboundSchema: z.ZodMiniEnum<typeof RefundTarget> = z
+  .enum(RefundTarget);

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/remove-user-op.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type RemoveUserRequest = {
+  /**
+   * User ID
+   */
+  id: string;
+};
+
+/** @internal */
+export type RemoveUserRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const RemoveUserRequest$outboundSchema: z.ZodMiniType<
+  RemoveUserRequest$Outbound,
+  RemoveUserRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function removeUserRequestToJSON(
+  removeUserRequest: RemoveUserRequest,
+): string {
+  return JSON.stringify(
+    RemoveUserRequest$outboundSchema.parse(removeUserRequest),
+  );
+}

package/src/sdk/models/retry-refund-op.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type RetryRefundRequest = {
+  /**
+   * Refund ID
+   */
+  id: string;
+};
+
+/** @internal */
+export type RetryRefundRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const RetryRefundRequest$outboundSchema: z.ZodMiniType<
+  RetryRefundRequest$Outbound,
+  RetryRefundRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function retryRefundRequestToJSON(
+  retryRefundRequest: RetryRefundRequest,
+): string {
+  return JSON.stringify(
+    RetryRefundRequest$outboundSchema.parse(retryRefundRequest),
+  );
+}

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`,
+  );
+}