@paygentic/sdk 0.6.38 → 0.7.1

package/src/funcs/{usageEventsList.ts → costsGetCostReport.ts}

@@ -21,20 +21,24 @@ import * as errors from "../models/errors/index.js";
 import { PaygenticError } from "../models/errors/paygenticerror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List
+ * Report
+ *
+ * @remarks
+ * Aggregate cost data across costs and customers with grouping, filtering, and time-series breakdown.
  */
-export function usageEventsList(
+export function costsGetCostReport(
   client: PaygenticCore,
-  request: operations.ListUsageEventsRequest,
+  request: operations.GetCostReportRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.ListUsageEventsResponse,
+    models.CostReportResponse,
     | errors.BadRequest
     | errors.ErrorT
     | PaygenticError
@@ -56,12 +60,12 @@ export function usageEventsList(
 
 async function $do(
   client: PaygenticCore,
-  request: operations.ListUsageEventsRequest,
+  request: operations.GetCostReportRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.ListUsageEventsResponse,
+      models.CostReportResponse,
       | errors.BadRequest
       | errors.ErrorT
       | PaygenticError
@@ -78,7 +82,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.ListUsageEventsRequest$outboundSchema.parse(value),
+    (value) => operations.GetCostReportRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -87,17 +91,24 @@ async function $do(
   const payload = parsed.value;
   const body = null;
 
-  const path = pathToFunc("/v0/usage")();
+  const path = pathToFunc("/v0/costs/report")();
 
   const query = encodeFormQuery({
-    "consumerId": payload.consumerId,
-    "customerId": payload.customerId,
-    "endTime": payload.endTime,
+    "comparePriorPeriod": payload.comparePriorPeriod,
+    "costId": payload.costId,
+    "currency": payload.currency,
+    "filterGroupBy": payload.filterGroupBy,
+    "from": payload.from,
+    "groupBy": payload.groupBy,
     "limit": payload.limit,
     "merchantId": payload.merchantId,
     "offset": payload.offset,
-    "startTime": payload.startTime,
-    "subscriptionId": payload.subscriptionId,
+    "sort": payload.sort,
+    "sortDir": payload.sortDir,
+    "subject": payload.subject,
+    "to": payload.to,
+    "topN": payload.topN,
+    "windowSize": payload.windowSize,
   });
 
   const headers = new Headers(compactMap({
@@ -111,7 +122,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "listUsageEvents",
+    operationID: "getCostReport",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -141,7 +152,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["400", "403", "4XX", "500", "5XX"],
+    errorCodes: ["400", "401", "403", "4XX", "500", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -155,7 +166,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.ListUsageEventsResponse,
+    models.CostReportResponse,
     | errors.BadRequest
     | errors.ErrorT
     | PaygenticError
@@ -167,9 +178,9 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.ListUsageEventsResponse$inboundSchema),
+    M.json(200, models.CostReportResponse$inboundSchema),
     M.jsonErr(400, errors.BadRequest$inboundSchema),
-    M.jsonErr(403, errors.ErrorT$inboundSchema),
+    M.jsonErr([401, 403], errors.ErrorT$inboundSchema),
     M.jsonErr(500, errors.ErrorT$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/entitlementsIssue.ts

@@ -37,7 +37,7 @@ export function entitlementsIssue(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.SchemasEntitlement,
+    models.Entitlement,
     | errors.BadRequest
     | errors.ErrorT
     | PaygenticError
@@ -64,7 +64,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      models.SchemasEntitlement,
+      models.Entitlement,
       | errors.BadRequest
       | errors.ErrorT
       | PaygenticError
@@ -147,7 +147,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    models.SchemasEntitlement,
+    models.Entitlement,
     | errors.BadRequest
     | errors.ErrorT
     | PaygenticError
@@ -159,7 +159,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(201, models.SchemasEntitlement$inboundSchema),
+    M.json(201, models.Entitlement$inboundSchema),
     M.jsonErr(400, errors.BadRequest$inboundSchema),
     M.jsonErr([403, 404, 409], errors.ErrorT$inboundSchema),
     M.jsonErr(500, errors.ErrorT$inboundSchema),

package/src/funcs/revenueGet.ts

@@ -95,6 +95,7 @@ async function $do(
 
   const query = encodeFormQuery({
     "bucketWidth": payload.bucketWidth,
+    "currency": payload.currency,
     "customerId": payload.customerId,
     "endTime": payload.endTime,
     "groupBy": payload.groupBy,

package/src/lib/config.ts

@@ -15,6 +15,10 @@ export const ServerList = [
    * Production API
    */
   "https://api.paygentic.io",
+  /**
+   * Sandbox API
+   */
+  "https://api.sandbox.paygentic.io",
 ] as const;
 
 export type SDKOptions = {
@@ -61,7 +65,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.6.38",
+  sdkVersion: "0.7.1",
   genVersion: "2.879.13",
-  userAgent: "speakeasy-sdk/typescript 0.6.38 2.879.13 0.1.0 @paygentic/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.7.1 2.879.13 0.1.0 @paygentic/sdk",
 } as const;

package/src/models/costreportgroup.ts

@@ -0,0 +1,94 @@
+/*
+ * 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";
+
+/**
+ * Prior-period comparison data. Present only when comparePriorPeriod=true.
+ */
+export type PriorPeriod = {
+  cost: number;
+  /**
+   * Percentage change vs prior period. Null when prior period cost is 0.
+   */
+  changePercent: number | null;
+};
+
+export type CostReportGroup = {
+  /**
+   * Group identifier (cost ID, customer ID, or dimension value). '__other__' for the aggregated remainder bucket.
+   */
+  key: string;
+  /**
+   * Human-readable display name for the group.
+   */
+  label: string;
+  totalCost: number;
+  totalQuantity: number;
+  /**
+   * Unit label for the quantity (e.g. 'token', 'request').
+   */
+  unit?: string | null | undefined;
+  /**
+   * This group's share of total cost, 0–100.
+   */
+  percentOfTotal: number;
+  /**
+   * Prior-period comparison data. Present only when comparePriorPeriod=true.
+   */
+  priorPeriod?: PriorPeriod | null | undefined;
+  /**
+   * True for the aggregated 'Other' bucket.
+   */
+  isOther: boolean;
+};
+
+/** @internal */
+export const PriorPeriod$inboundSchema: z.ZodType<
+  PriorPeriod,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cost: z.number(),
+  changePercent: z.nullable(z.number()),
+});
+
+export function priorPeriodFromJSON(
+  jsonString: string,
+): SafeParseResult<PriorPeriod, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PriorPeriod$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PriorPeriod' from JSON`,
+  );
+}
+
+/** @internal */
+export const CostReportGroup$inboundSchema: z.ZodType<
+  CostReportGroup,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  label: z.string(),
+  totalCost: z.number(),
+  totalQuantity: z.number(),
+  unit: z.nullable(z.string()).optional(),
+  percentOfTotal: z.number(),
+  priorPeriod: z.nullable(z.lazy(() => PriorPeriod$inboundSchema)).optional(),
+  isOther: z.boolean(),
+});
+
+export function costReportGroupFromJSON(
+  jsonString: string,
+): SafeParseResult<CostReportGroup, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CostReportGroup$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CostReportGroup' from JSON`,
+  );
+}

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(