@flexprice/sdk 2.1.40 → 2.1.42

package/src/sdk/models/report-catalog-entry.ts

@@ -0,0 +1,128 @@
+/*
+ * 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 * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import {
+  ImprovementDirection,
+  ImprovementDirection$inboundSchema,
+} from "./improvement-direction.js";
+import {
+  ReportCategory,
+  ReportCategory$inboundSchema,
+} from "./report-category.js";
+import {
+  ReportDimension,
+  ReportDimension$inboundSchema,
+} from "./report-dimension.js";
+import { ReportKind, ReportKind$inboundSchema } from "./report-kind.js";
+import {
+  ReportValueType,
+  ReportValueType$inboundSchema,
+} from "./report-value-type.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export const DefaultShape = {
+  Timeseries: "timeseries",
+  Breakdown: "breakdown",
+  Scalar: "scalar",
+} as const;
+export type DefaultShape = OpenEnum<typeof DefaultShape>;
+
+export const ReportCatalogEntryGrain = {
+  Day: "day",
+  Week: "week",
+  Month: "month",
+} as const;
+export type ReportCatalogEntryGrain = OpenEnum<typeof ReportCatalogEntryGrain>;
+
+export const ReportCatalogEntryShape = {
+  Timeseries: "timeseries",
+  Breakdown: "breakdown",
+  Scalar: "scalar",
+} as const;
+export type ReportCatalogEntryShape = OpenEnum<typeof ReportCatalogEntryShape>;
+
+export type ReportCatalogEntry = {
+  category?: ReportCategory | undefined;
+  defaultShape?: DefaultShape | undefined;
+  description?: string | undefined;
+  dimensions?: Array<ReportDimension> | undefined;
+  grains?: Array<ReportCatalogEntryGrain> | undefined;
+  improvement?: ImprovementDirection | undefined;
+  key?: string | undefined;
+  kind?: ReportKind | undefined;
+  maxRangeDays?: number | undefined;
+  name?: string | undefined;
+  shapes?: Array<ReportCatalogEntryShape> | undefined;
+  supportsCompare?: boolean | undefined;
+  valueType?: ReportValueType | undefined;
+  variantLabel?: string | undefined;
+  variantOf?: string | undefined;
+};
+
+/** @internal */
+export const DefaultShape$inboundSchema: z.ZodMiniType<DefaultShape, unknown> =
+  openEnums.inboundSchema(DefaultShape);
+
+/** @internal */
+export const ReportCatalogEntryGrain$inboundSchema: z.ZodMiniType<
+  ReportCatalogEntryGrain,
+  unknown
+> = openEnums.inboundSchema(ReportCatalogEntryGrain);
+
+/** @internal */
+export const ReportCatalogEntryShape$inboundSchema: z.ZodMiniType<
+  ReportCatalogEntryShape,
+  unknown
+> = openEnums.inboundSchema(ReportCatalogEntryShape);
+
+/** @internal */
+export const ReportCatalogEntry$inboundSchema: z.ZodMiniType<
+  ReportCatalogEntry,
+  unknown
+> = z.pipe(
+  z.object({
+    category: types.optional(ReportCategory$inboundSchema),
+    default_shape: types.optional(DefaultShape$inboundSchema),
+    description: types.optional(types.string()),
+    dimensions: types.optional(z.array(ReportDimension$inboundSchema)),
+    grains: types.optional(z.array(ReportCatalogEntryGrain$inboundSchema)),
+    improvement: types.optional(ImprovementDirection$inboundSchema),
+    key: types.optional(types.string()),
+    kind: types.optional(ReportKind$inboundSchema),
+    max_range_days: types.optional(types.number()),
+    name: types.optional(types.string()),
+    shapes: types.optional(z.array(ReportCatalogEntryShape$inboundSchema)),
+    supports_compare: types.optional(types.boolean()),
+    value_type: types.optional(ReportValueType$inboundSchema),
+    variant_label: types.optional(types.string()),
+    variant_of: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "default_shape": "defaultShape",
+      "max_range_days": "maxRangeDays",
+      "supports_compare": "supportsCompare",
+      "value_type": "valueType",
+      "variant_label": "variantLabel",
+      "variant_of": "variantOf",
+    });
+  }),
+);
+
+export function reportCatalogEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<ReportCatalogEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReportCatalogEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReportCatalogEntry' from JSON`,
+  );
+}

package/src/sdk/models/report-catalog-response.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 {
+  ReportCatalogEntry,
+  ReportCatalogEntry$inboundSchema,
+} from "./report-catalog-entry.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type ReportCatalogResponse = {
+  items?: Array<ReportCatalogEntry> | undefined;
+};
+
+/** @internal */
+export const ReportCatalogResponse$inboundSchema: z.ZodMiniType<
+  ReportCatalogResponse,
+  unknown
+> = z.object({
+  items: types.optional(z.array(ReportCatalogEntry$inboundSchema)),
+});
+
+export function reportCatalogResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ReportCatalogResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReportCatalogResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReportCatalogResponse' from JSON`,
+  );
+}

package/src/sdk/models/report-category.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 ReportCategory = {
+  Billing: "billing",
+  Receivables: "receivables",
+  Customers: "customers",
+  Credits: "credits",
+  Usage: "usage",
+} as const;
+export type ReportCategory = OpenEnum<typeof ReportCategory>;
+
+/** @internal */
+export const ReportCategory$inboundSchema: z.ZodMiniType<
+  ReportCategory,
+  unknown
+> = openEnums.inboundSchema(ReportCategory);

package/src/sdk/models/report-dimension.ts

@@ -0,0 +1,33 @@
+/*
+ * 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 { SDKValidationError } from "./sdk-validation-error.js";
+
+export type ReportDimension = {
+  key?: string | undefined;
+  label?: string | undefined;
+};
+
+/** @internal */
+export const ReportDimension$inboundSchema: z.ZodMiniType<
+  ReportDimension,
+  unknown
+> = z.object({
+  key: types.optional(types.string()),
+  label: types.optional(types.string()),
+});
+
+export function reportDimensionFromJSON(
+  jsonString: string,
+): SafeParseResult<ReportDimension, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReportDimension$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReportDimension' from JSON`,
+  );
+}

package/src/sdk/models/report-filter.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 Op = {
+  Eq: "eq",
+  In: "in",
+} as const;
+export type Op = ClosedEnum<typeof Op>;
+
+export type ReportFilter = {
+  field?: string | undefined;
+  op?: Op | undefined;
+  value?: Array<string> | undefined;
+};
+
+/** @internal */
+export const Op$outboundSchema: z.ZodMiniEnum<typeof Op> = z.enum(Op);
+
+/** @internal */
+export type ReportFilter$Outbound = {
+  field?: string | undefined;
+  op?: string | undefined;
+  value?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ReportFilter$outboundSchema: z.ZodMiniType<
+  ReportFilter$Outbound,
+  ReportFilter
+> = z.object({
+  field: z.optional(z.string()),
+  op: z.optional(Op$outboundSchema),
+  value: z.optional(z.array(z.string())),
+});
+
+export function reportFilterToJSON(reportFilter: ReportFilter): string {
+  return JSON.stringify(ReportFilter$outboundSchema.parse(reportFilter));
+}

package/src/sdk/models/report-kind.ts

@@ -0,0 +1,18 @@
+/*
+ * 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 ReportKind = {
+  Flow: "flow",
+  Ratio: "ratio",
+  Snapshot: "snapshot",
+} as const;
+export type ReportKind = OpenEnum<typeof ReportKind>;
+
+/** @internal */
+export const ReportKind$inboundSchema: z.ZodMiniType<ReportKind, unknown> =
+  openEnums.inboundSchema(ReportKind);

package/src/sdk/models/report-query-request.ts

@@ -0,0 +1,106 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  ReportFilter,
+  ReportFilter$Outbound,
+  ReportFilter$outboundSchema,
+} from "./report-filter.js";
+import {
+  ReportSort,
+  ReportSort$Outbound,
+  ReportSort$outboundSchema,
+} from "./report-sort.js";
+
+export const ReportQueryRequestCompare = {
+  PreviousPeriod: "previous_period",
+  PreviousYear: "previous_year",
+} as const;
+export type ReportQueryRequestCompare = ClosedEnum<
+  typeof ReportQueryRequestCompare
+>;
+
+export const ReportQueryRequestGrain = {
+  Day: "day",
+  Week: "week",
+  Month: "month",
+} as const;
+export type ReportQueryRequestGrain = ClosedEnum<
+  typeof ReportQueryRequestGrain
+>;
+
+export const ReportQueryRequestShape = {
+  Timeseries: "timeseries",
+  Breakdown: "breakdown",
+  Scalar: "scalar",
+} as const;
+export type ReportQueryRequestShape = ClosedEnum<
+  typeof ReportQueryRequestShape
+>;
+
+export type ReportQueryRequest = {
+  compare?: ReportQueryRequestCompare | undefined;
+  currency?: string | undefined;
+  dimensions?: Array<string> | undefined;
+  filters?: Array<ReportFilter> | undefined;
+  grain?: ReportQueryRequestGrain | undefined;
+  limit?: number | undefined;
+  range: string;
+  shape: ReportQueryRequestShape;
+  sort?: Array<ReportSort> | undefined;
+};
+
+/** @internal */
+export const ReportQueryRequestCompare$outboundSchema: z.ZodMiniEnum<
+  typeof ReportQueryRequestCompare
+> = z.enum(ReportQueryRequestCompare);
+
+/** @internal */
+export const ReportQueryRequestGrain$outboundSchema: z.ZodMiniEnum<
+  typeof ReportQueryRequestGrain
+> = z.enum(ReportQueryRequestGrain);
+
+/** @internal */
+export const ReportQueryRequestShape$outboundSchema: z.ZodMiniEnum<
+  typeof ReportQueryRequestShape
+> = z.enum(ReportQueryRequestShape);
+
+/** @internal */
+export type ReportQueryRequest$Outbound = {
+  compare?: string | undefined;
+  currency?: string | undefined;
+  dimensions?: Array<string> | undefined;
+  filters?: Array<ReportFilter$Outbound> | undefined;
+  grain?: string | undefined;
+  limit?: number | undefined;
+  range: string;
+  shape: string;
+  sort?: Array<ReportSort$Outbound> | undefined;
+};
+
+/** @internal */
+export const ReportQueryRequest$outboundSchema: z.ZodMiniType<
+  ReportQueryRequest$Outbound,
+  ReportQueryRequest
+> = z.object({
+  compare: z.optional(ReportQueryRequestCompare$outboundSchema),
+  currency: z.optional(z.string()),
+  dimensions: z.optional(z.array(z.string())),
+  filters: z.optional(z.array(ReportFilter$outboundSchema)),
+  grain: z.optional(ReportQueryRequestGrain$outboundSchema),
+  limit: z.optional(z.int()),
+  range: z.string(),
+  shape: ReportQueryRequestShape$outboundSchema,
+  sort: z.optional(z.array(ReportSort$outboundSchema)),
+});
+
+export function reportQueryRequestToJSON(
+  reportQueryRequest: ReportQueryRequest,
+): string {
+  return JSON.stringify(
+    ReportQueryRequest$outboundSchema.parse(reportQueryRequest),
+  );
+}

package/src/sdk/models/report-sort.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 Dir = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type Dir = ClosedEnum<typeof Dir>;
+
+export type ReportSort = {
+  dir?: Dir | undefined;
+  field?: string | undefined;
+};
+
+/** @internal */
+export const Dir$outboundSchema: z.ZodMiniEnum<typeof Dir> = z.enum(Dir);
+
+/** @internal */
+export type ReportSort$Outbound = {
+  dir?: string | undefined;
+  field?: string | undefined;
+};
+
+/** @internal */
+export const ReportSort$outboundSchema: z.ZodMiniType<
+  ReportSort$Outbound,
+  ReportSort
+> = z.object({
+  dir: z.optional(Dir$outboundSchema),
+  field: z.optional(z.string()),
+});
+
+export function reportSortToJSON(reportSort: ReportSort): string {
+  return JSON.stringify(ReportSort$outboundSchema.parse(reportSort));
+}

package/src/sdk/models/report-value-type.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 ReportValueType = {
+  Money: "money",
+  Count: "count",
+  Days: "days",
+} as const;
+export type ReportValueType = OpenEnum<typeof ReportValueType>;
+
+/** @internal */
+export const ReportValueType$inboundSchema: z.ZodMiniType<
+  ReportValueType,
+  unknown
+> = openEnums.inboundSchema(ReportValueType);

package/src/sdk/models/run-analytics-report-op.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  ReportQueryRequest,
+  ReportQueryRequest$Outbound,
+  ReportQueryRequest$outboundSchema,
+} from "./report-query-request.js";
+
+export type RunAnalyticsReportRequest = {
+  /**
+   * Report key
+   */
+  key: string;
+  /**
+   * Report query request
+   */
+  body: ReportQueryRequest;
+};
+
+/** @internal */
+export type RunAnalyticsReportRequest$Outbound = {
+  key: string;
+  body: ReportQueryRequest$Outbound;
+};
+
+/** @internal */
+export const RunAnalyticsReportRequest$outboundSchema: z.ZodMiniType<
+  RunAnalyticsReportRequest$Outbound,
+  RunAnalyticsReportRequest
+> = z.object({
+  key: z.string(),
+  body: ReportQueryRequest$outboundSchema,
+});
+
+export function runAnalyticsReportRequestToJSON(
+  runAnalyticsReportRequest: RunAnalyticsReportRequest,
+): string {
+  return JSON.stringify(
+    RunAnalyticsReportRequest$outboundSchema.parse(runAnalyticsReportRequest),
+  );
+}

package/src/sdk/models/self-billing-checkout-request.ts

@@ -0,0 +1,68 @@
+/*
+ * 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";
+
+export type SelfBillingCheckoutRequest = {
+  addressCity: string;
+  addressCountry: string;
+  addressLine1: string;
+  addressLine2?: string | undefined;
+  addressPostalCode: string;
+  addressState?: string | undefined;
+  email: string;
+  name: string;
+  taxId?: string | undefined;
+};
+
+/** @internal */
+export type SelfBillingCheckoutRequest$Outbound = {
+  address_city: string;
+  address_country: string;
+  address_line1: string;
+  address_line2?: string | undefined;
+  address_postal_code: string;
+  address_state?: string | undefined;
+  email: string;
+  name: string;
+  tax_id?: string | undefined;
+};
+
+/** @internal */
+export const SelfBillingCheckoutRequest$outboundSchema: z.ZodMiniType<
+  SelfBillingCheckoutRequest$Outbound,
+  SelfBillingCheckoutRequest
+> = z.pipe(
+  z.object({
+    addressCity: z.string(),
+    addressCountry: z.string(),
+    addressLine1: z.string(),
+    addressLine2: z.optional(z.string()),
+    addressPostalCode: z.string(),
+    addressState: z.optional(z.string()),
+    email: z.string(),
+    name: z.string(),
+    taxId: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      addressCity: "address_city",
+      addressCountry: "address_country",
+      addressLine1: "address_line1",
+      addressLine2: "address_line2",
+      addressPostalCode: "address_postal_code",
+      addressState: "address_state",
+      taxId: "tax_id",
+    });
+  }),
+);
+
+export function selfBillingCheckoutRequestToJSON(
+  selfBillingCheckoutRequest: SelfBillingCheckoutRequest,
+): string {
+  return JSON.stringify(
+    SelfBillingCheckoutRequest$outboundSchema.parse(selfBillingCheckoutRequest),
+  );
+}

package/src/sdk/models/self-billing-checkout-response.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 {
+  CheckoutStatus,
+  CheckoutStatus$inboundSchema,
+} from "./checkout-status.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  TenantInternalStatus,
+  TenantInternalStatus$inboundSchema,
+} from "./tenant-internal-status.js";
+
+export type SelfBillingCheckoutResponse = {
+  checkoutId?: string | undefined;
+  status?: CheckoutStatus | undefined;
+  tenantStatus?: TenantInternalStatus | undefined;
+  terminal?: boolean | undefined;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const SelfBillingCheckoutResponse$inboundSchema: z.ZodMiniType<
+  SelfBillingCheckoutResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    checkout_id: types.optional(types.string()),
+    status: types.optional(CheckoutStatus$inboundSchema),
+    tenant_status: types.optional(TenantInternalStatus$inboundSchema),
+    terminal: types.optional(types.boolean()),
+    url: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "checkout_id": "checkoutId",
+      "tenant_status": "tenantStatus",
+    });
+  }),
+);
+
+export function selfBillingCheckoutResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SelfBillingCheckoutResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SelfBillingCheckoutResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SelfBillingCheckoutResponse' from JSON`,
+  );
+}

package/src/sdk/models/self-billing-invoice.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 {
+  InvoiceStatus,
+  InvoiceStatus$inboundSchema,
+} from "./invoice-status.js";
+import {
+  PaymentStatus,
+  PaymentStatus$inboundSchema,
+} from "./payment-status.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type SelfBillingInvoice = {
+  currency?: string | undefined;
+  dueDate?: Date | undefined;
+  id?: string | undefined;
+  number?: string | undefined;
+  paymentStatus?: PaymentStatus | undefined;
+  pdfUrl?: string | undefined;
+  status?: InvoiceStatus | undefined;
+  total?: string | undefined;
+};
+
+/** @internal */
+export const SelfBillingInvoice$inboundSchema: z.ZodMiniType<
+  SelfBillingInvoice,
+  unknown
+> = z.pipe(
+  z.object({
+    currency: types.optional(types.string()),
+    due_date: types.optional(types.date()),
+    id: types.optional(types.string()),
+    number: types.optional(types.string()),
+    payment_status: types.optional(PaymentStatus$inboundSchema),
+    pdf_url: types.optional(types.string()),
+    status: types.optional(InvoiceStatus$inboundSchema),
+    total: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "due_date": "dueDate",
+      "payment_status": "paymentStatus",
+      "pdf_url": "pdfUrl",
+    });
+  }),
+);
+
+export function selfBillingInvoiceFromJSON(
+  jsonString: string,
+): SafeParseResult<SelfBillingInvoice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SelfBillingInvoice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SelfBillingInvoice' from JSON`,
+  );
+}