@paygentic/sdk 0.6.37 → 0.7.0

package/src/models/costreportresponse.ts

@@ -0,0 +1,145 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  CostReportGroup,
+  CostReportGroup$inboundSchema,
+} from "./costreportgroup.js";
+import {
+  CostReportTimeSeries,
+  CostReportTimeSeries$inboundSchema,
+} from "./costreporttimeseries.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export const CostReportResponseObject = {
+  CostReport: "cost_report",
+} as const;
+export type CostReportResponseObject = ClosedEnum<
+  typeof CostReportResponseObject
+>;
+
+export type Period = {
+  from: Date;
+  to: Date;
+};
+
+export type Pagination = {
+  total: number;
+  limit: number;
+  offset: number;
+};
+
+export type CostReportResponse = {
+  object: CostReportResponseObject;
+  /**
+   * ISO 4217 currency code for all monetary values in this response.
+   */
+  currency: string;
+  period: Period;
+  /**
+   * The active grouping dimension (e.g. 'cost', 'customer', or a dynamic dimension key).
+   */
+  groupBy: string;
+  /**
+   * Sum of cost across all groups (not just top N).
+   */
+  totalCost: number;
+  /**
+   * Sum of quantity across all groups.
+   */
+  totalQuantity: number;
+  /**
+   * Top N groups plus an 'Other' bucket aggregating the remainder.
+   */
+  groups: Array<CostReportGroup>;
+  /**
+   * Time-bucketed breakdown per group. Keys in each window's 'groups' object correspond to CostReportGroup.key. The 'Other' bucket key is '__other__'.
+   */
+  timeSeries: Array<CostReportTimeSeries>;
+  /**
+   * Dimension keys available for further drill-down (populated when a single cost is filtered).
+   */
+  availableDimensions: Array<string>;
+  /**
+   * Non-fatal warnings, e.g. costs that could not be queried.
+   */
+  warnings?: Array<string> | undefined;
+  pagination: Pagination;
+};
+
+/** @internal */
+export const CostReportResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof CostReportResponseObject
+> = z.nativeEnum(CostReportResponseObject);
+
+/** @internal */
+export const Period$inboundSchema: z.ZodType<Period, z.ZodTypeDef, unknown> = z
+  .object({
+    from: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    to: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  });
+
+export function periodFromJSON(
+  jsonString: string,
+): SafeParseResult<Period, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Period$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Period' from JSON`,
+  );
+}
+
+/** @internal */
+export const Pagination$inboundSchema: z.ZodType<
+  Pagination,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total: z.number().int(),
+  limit: z.number().int(),
+  offset: z.number().int(),
+});
+
+export function paginationFromJSON(
+  jsonString: string,
+): SafeParseResult<Pagination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Pagination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Pagination' from JSON`,
+  );
+}
+
+/** @internal */
+export const CostReportResponse$inboundSchema: z.ZodType<
+  CostReportResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: CostReportResponseObject$inboundSchema.default("cost_report"),
+  currency: z.string(),
+  period: z.lazy(() => Period$inboundSchema),
+  groupBy: z.string(),
+  totalCost: z.number(),
+  totalQuantity: z.number(),
+  groups: z.array(CostReportGroup$inboundSchema),
+  timeSeries: z.array(CostReportTimeSeries$inboundSchema),
+  availableDimensions: z.array(z.string()),
+  warnings: z.array(z.string()).optional(),
+  pagination: z.lazy(() => Pagination$inboundSchema),
+});
+
+export function costReportResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CostReportResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CostReportResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CostReportResponse' from JSON`,
+  );
+}

package/src/models/costreporttimeseries.ts

@@ -0,0 +1,40 @@
+/*
+ * 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";
+
+export type CostReportTimeSeries = {
+  windowStart: Date;
+  windowEnd: Date;
+  /**
+   * Map of group key → cost value for this time window. Keys match CostReportGroup.key.
+   */
+  groups: { [k: string]: number };
+};
+
+/** @internal */
+export const CostReportTimeSeries$inboundSchema: z.ZodType<
+  CostReportTimeSeries,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  windowStart: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  windowEnd: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  groups: z.record(z.number()),
+});
+
+export function costReportTimeSeriesFromJSON(
+  jsonString: string,
+): SafeParseResult<CostReportTimeSeries, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CostReportTimeSeries$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CostReportTimeSeries' from JSON`,
+  );
+}

package/src/models/currencybreakdownentry.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 {
+  InvoiceSummary,
+  InvoiceSummary$inboundSchema,
+} from "./invoicesummary.js";
+import {
+  PaymentSummary,
+  PaymentSummary$inboundSchema,
+} from "./paymentsummary.js";
+import {
+  RevenueTrendBucket,
+  RevenueTrendBucket$inboundSchema,
+} from "./revenuetrendbucket.js";
+
+export type CurrencyBreakdownEntry = {
+  /**
+   * ISO 4217 currency code (uppercase, e.g. USD, EUR, GBP)
+   */
+  currency: string;
+  /**
+   * Net collected revenue in dollars for this currency (issued invoices + completed payments)
+   */
+  netRevenue: string;
+  invoices: InvoiceSummary;
+  payments: PaymentSummary;
+  /**
+   * Time-bucketed revenue trend data for this currency
+   */
+  trend: Array<RevenueTrendBucket>;
+};
+
+/** @internal */
+export const CurrencyBreakdownEntry$inboundSchema: z.ZodType<
+  CurrencyBreakdownEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  netRevenue: z.string(),
+  invoices: InvoiceSummary$inboundSchema,
+  payments: PaymentSummary$inboundSchema,
+  trend: z.array(RevenueTrendBucket$inboundSchema),
+});
+
+export function currencyBreakdownEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<CurrencyBreakdownEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CurrencyBreakdownEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CurrencyBreakdownEntry' from JSON`,
+  );
+}

package/src/models/entitlement.ts

@@ -13,63 +13,57 @@ export const EntitlementObject = {
 } as const;
 export type EntitlementObject = ClosedEnum<typeof EntitlementObject>;
 
-export type EntitlementBillableMetric = {
-  /**
-   * Unique identifier for a billable metric
-   */
-  billableMetricId?: string | undefined;
-  /**
-   * Custom price override in decimal dollars. Sample values: '0.000012' sets $0.000012 per unit, '0.50' sets $0.50 per unit, '1.25' sets $1.25 per unit
-   */
-  price?: string | undefined;
-  /**
-   * Pre-authorized metric quantity amount. Sample values: 10000 tokens, 500 GB storage, 1000 API calls, 24 compute hours
-   */
-  quantity?: number | undefined;
-};
+/**
+ * Current status of the entitlement.
+ */
+export const EntitlementStatus = {
+  Active: "active",
+  Canceled: "canceled",
+  Expired: "expired",
+} as const;
+/**
+ * Current status of the entitlement.
+ */
+export type EntitlementStatus = ClosedEnum<typeof EntitlementStatus>;
 
 export type Entitlement = {
-  /**
-   * Unique identifier for an entitlement
-   */
-  id?: string | undefined;
   object: EntitlementObject;
   /**
-   * Billable metrics and quantities reserved stored as JSON.
+   * Unique identifier for the entitlement.
    */
-  billableMetrics?: Array<EntitlementBillableMetric> | undefined;
+  id: string;
   /**
-   * Entitlement creation timestamp in ISO 8601 format. Sample values: '2024-01-15T10:30:00Z', '2024-02-01T14:45:30Z'
+   * Unique identifier for a customer
    */
-  createdAt?: Date | undefined;
+  customerId: string;
   /**
-   * Unique identifier for a customer
+   * The feature this entitlement grants access to.
    */
-  customerId?: string | undefined;
+  featureId: string;
   /**
-   * Entitlement expiration timestamp in ISO 8601 format. Sample values: '2024-12-31T23:59:59Z', '2025-01-15T10:30:00Z'
+   * The subscription this entitlement is associated with, if any.
    */
-  expiresAt?: Date | undefined;
+  subscriptionId?: string | null | undefined;
   /**
-   * Maximum consumption events allowed before entitlement expires. Sample values: 1 allows single use, 10 allows ten uses, 100 allows one hundred uses
+   * Current status of the entitlement.
    */
-  maxUses?: number | undefined;
+  status: EntitlementStatus;
   /**
-   * Unique identifier for a merchant/organization
+   * When the entitlement becomes active.
    */
-  merchantId?: string | undefined;
+  activeFrom: Date;
   /**
-   * Geographic restriction zone limiting where this entitlement applies. Sample values: 'us-west-2' confines usage to AWS US West 2 region, 'eu-central-1' confines usage to EU Central 1 region, 'global' permits usage from all regions
+   * When the entitlement expires. Null means no expiration.
    */
-  region?: string | undefined;
+  activeTo?: Date | null | undefined;
   /**
-   * Unused entitlement balance in atomic units (string representation of BigInt). Sample values: '100000000000' equals $100.00 remaining, '50000000000' equals $50.00 remaining, '0' equals fully consumed
+   * Configuration values for static features.
    */
-  remainingBalance?: string | undefined;
+  config: { [k: string]: any } | null;
   /**
-   * Count of consumption events processed using this entitlement. Sample values: 0 indicates unused, 5 indicates five events processed, 10 indicates ten events processed
+   * Additional metadata for the entitlement.
    */
-  usedCount?: number | undefined;
+  metadata?: { [k: string]: string } | undefined;
 };
 
 /** @internal */
@@ -78,25 +72,9 @@ export const EntitlementObject$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(EntitlementObject);
 
 /** @internal */
-export const EntitlementBillableMetric$inboundSchema: z.ZodType<
-  EntitlementBillableMetric,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  billableMetricId: z.string().optional(),
-  price: z.string().optional(),
-  quantity: z.number().optional(),
-});
-
-export function entitlementBillableMetricFromJSON(
-  jsonString: string,
-): SafeParseResult<EntitlementBillableMetric, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => EntitlementBillableMetric$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'EntitlementBillableMetric' from JSON`,
-  );
-}
+export const EntitlementStatus$inboundSchema: z.ZodNativeEnum<
+  typeof EntitlementStatus
+> = z.nativeEnum(EntitlementStatus);
 
 /** @internal */
 export const Entitlement$inboundSchema: z.ZodType<
@@ -104,21 +82,18 @@ export const Entitlement$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string().optional(),
   object: EntitlementObject$inboundSchema.default("entitlement"),
-  billableMetrics: z.array(
-    z.lazy(() => EntitlementBillableMetric$inboundSchema),
+  id: z.string(),
+  customerId: z.string(),
+  featureId: z.string(),
+  subscriptionId: z.nullable(z.string()).optional(),
+  status: EntitlementStatus$inboundSchema,
+  activeFrom: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  activeTo: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
-  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
-  customerId: z.string().optional(),
-  expiresAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
-  maxUses: z.number().int().optional(),
-  merchantId: z.string().optional(),
-  region: z.string().optional(),
-  remainingBalance: z.string().optional(),
-  usedCount: z.number().int().optional(),
+  config: z.nullable(z.record(z.any())),
+  metadata: z.record(z.string()).optional(),
 });
 
 export function entitlementFromJSON(

package/src/models/errors/error.ts

@@ -7,13 +7,17 @@ import { PaygenticError } from "./paygenticerror.js";
 
 export type ErrorTData = {
   /**
-   * Error type or code
+   * Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.
    */
   error?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable error message. Clients must not parse this field programmatically.
    */
   message: string;
+  /**
+   * Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.
+   */
+  code?: string | undefined;
   /**
    * Additional error details
    */
@@ -22,9 +26,13 @@ export type ErrorTData = {
 
 export class ErrorT extends PaygenticError {
   /**
-   * Error type or code
+   * Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.
    */
   error?: string | undefined;
+  /**
+   * Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.
+   */
+  code?: string | undefined;
   /**
    * Additional error details
    */
@@ -41,6 +49,7 @@ export class ErrorT extends PaygenticError {
     super(message, httpMeta);
     this.data$ = err;
     if (err.error != null) this.error = err.error;
+    if (err.code != null) this.code = err.code;
     if (err.details != null) this.details = err.details;
 
     this.name = "ErrorT";
@@ -52,6 +61,7 @@ export const ErrorT$inboundSchema: z.ZodType<ErrorT, z.ZodTypeDef, unknown> = z
   .object({
     error: z.string().optional(),
     message: z.string(),
+    code: z.string().optional(),
     details: z.record(z.any()).optional(),
     request$: z.instanceof(Request),
     response$: z.instanceof(Response),

package/src/models/index.ts

@@ -2,22 +2,19 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export * from "./activeentitlement.js";
 export * from "./address.js";
-export * from "./batchusageeventresponse.js";
 export * from "./billablemetric.js";
 export * from "./booleanentitlementdetail.js";
 export * from "./cost.js";
+export * from "./costreportgroup.js";
+export * from "./costreportresponse.js";
+export * from "./costreporttimeseries.js";
 export * from "./costusageresponse.js";
-export * from "./createdisputerequest.js";
-export * from "./createentitlementrequest.js";
 export * from "./creategrantrequest.js";
 export * from "./createmanuallineitemrequest.js";
 export * from "./createrulerequest.js";
-export * from "./createusageeventrequest.js";
+export * from "./currencybreakdownentry.js";
 export * from "./customer.js";
-export * from "./dispute.js";
-export * from "./disputewithcustomer.js";
 export * from "./entitlement.js";
 export * from "./entitlementaccessresult.js";
 export * from "./entitlementdetail.js";
@@ -55,7 +52,6 @@ export * from "./purchasegrantresponse.js";
 export * from "./revenuesummaryresponse.js";
 export * from "./revenuetrendbucket.js";
 export * from "./rulecondition.js";
-export * from "./schemasentitlement.js";
 export * from "./schemasprice.js";
 export * from "./security.js";
 export * from "./source.js";
@@ -66,7 +62,6 @@ export * from "./subscription.js";
 export * from "./subscriptionportal.js";
 export * from "./testclock.js";
 export * from "./updaterulerequest.js";
-export * from "./usageevent.js";
 export * from "./usageresponse.js";
 export * from "./user.js";
 export * from "./validationerror.js";

package/src/models/operations/getbillablemetricmeter.ts

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 /**
  * Time bucket granularity
  */
-export const WindowSize = {
+export const GetBillableMetricMeterWindowSize = {
   Minute: "MINUTE",
   Hour: "HOUR",
   Day: "DAY",
@@ -17,7 +17,9 @@ export const WindowSize = {
 /**
  * Time bucket granularity
  */
-export type WindowSize = ClosedEnum<typeof WindowSize>;
+export type GetBillableMetricMeterWindowSize = ClosedEnum<
+  typeof GetBillableMetricMeterWindowSize
+>;
 
 export type GetBillableMetricMeterRequest = {
   id: string;
@@ -36,7 +38,7 @@ export type GetBillableMetricMeterRequest = {
   /**
    * Time bucket granularity
    */
-  windowSize?: WindowSize | undefined;
+  windowSize?: GetBillableMetricMeterWindowSize | undefined;
   /**
    * JSON-encoded dimension filter (e.g. {"key":"value"})
    */
@@ -48,8 +50,9 @@ export type GetBillableMetricMeterRequest = {
 };
 
 /** @internal */
-export const WindowSize$outboundSchema: z.ZodNativeEnum<typeof WindowSize> = z
-  .nativeEnum(WindowSize);
+export const GetBillableMetricMeterWindowSize$outboundSchema: z.ZodNativeEnum<
+  typeof GetBillableMetricMeterWindowSize
+> = z.nativeEnum(GetBillableMetricMeterWindowSize);
 
 /** @internal */
 export type GetBillableMetricMeterRequest$Outbound = {
@@ -72,7 +75,7 @@ export const GetBillableMetricMeterRequest$outboundSchema: z.ZodType<
   from: z.date().transform(v => v.toISOString()),
   to: z.date().transform(v => v.toISOString()),
   subject: z.string().optional(),
-  windowSize: WindowSize$outboundSchema.optional(),
+  windowSize: GetBillableMetricMeterWindowSize$outboundSchema.optional(),
   filterGroupBy: z.string().optional(),
   groupBy: z.string().optional(),
 });