@flexprice/sdk 2.1.30 → 2.1.34

package/src/sdk/models/feature-usage-summary.ts

@@ -7,6 +7,18 @@ 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 {
+  AggregatedEntitlementBucket,
+  AggregatedEntitlementBucket$inboundSchema,
+} from "./aggregated-entitlement-bucket.js";
+import {
+  EntitlementGrantDurationUnit,
+  EntitlementGrantDurationUnit$inboundSchema,
+} from "./entitlement-grant-duration-unit.js";
+import {
+  EntitlementGrantMeasure,
+  EntitlementGrantMeasure$inboundSchema,
+} from "./entitlement-grant-measure.js";
 import {
   EntitlementSource,
   EntitlementSource$inboundSchema,
@@ -15,11 +27,27 @@ import {
   FeatureResponse,
   FeatureResponse$inboundSchema,
 } from "./feature-response.js";
+import { GrantState, GrantState$inboundSchema } from "./grant-state.js";
 import { SDKValidationError } from "./sdk-validation-error.js";
 
 export type FeatureUsageSummary = {
+  /**
+   * Buckets is one entry per independent budget on a parallel feature. The scalar
+   *
+   * @remarks
+   * figures above cannot describe several budgets at once — a sum is not spendable
+   * from any one of them — so a client showing a parallel feature reads these instead.
+   * Empty for additive features, where the scalars are the whole truth.
+   */
+  buckets?: Array<AggregatedEntitlementBucket> | undefined;
   currentUsage?: string | undefined;
   feature?: FeatureResponse | undefined;
+  grantDurationUnit?: EntitlementGrantDurationUnit | undefined;
+  grantDurationValue?: number | undefined;
+  grantMeasure?: EntitlementGrantMeasure | undefined;
+  grantQuota?: string | undefined;
+  grantState?: GrantState | undefined;
+  grantUnlimited?: boolean | undefined;
   isEnabled?: boolean | undefined;
   isSoftLimit?: boolean | undefined;
   isUnlimited?: boolean | undefined;
@@ -35,8 +63,17 @@ export const FeatureUsageSummary$inboundSchema: z.ZodMiniType<
   unknown
 > = z.pipe(
   z.object({
+    buckets: types.optional(z.array(AggregatedEntitlementBucket$inboundSchema)),
     current_usage: types.optional(types.string()),
     feature: types.optional(FeatureResponse$inboundSchema),
+    grant_duration_unit: types.optional(
+      EntitlementGrantDurationUnit$inboundSchema,
+    ),
+    grant_duration_value: types.optional(types.number()),
+    grant_measure: types.optional(EntitlementGrantMeasure$inboundSchema),
+    grant_quota: types.optional(types.string()),
+    grant_state: types.optional(GrantState$inboundSchema),
+    grant_unlimited: types.optional(types.boolean()),
     is_enabled: types.optional(types.boolean()),
     is_soft_limit: types.optional(types.boolean()),
     is_unlimited: types.optional(types.boolean()),
@@ -48,6 +85,12 @@ export const FeatureUsageSummary$inboundSchema: z.ZodMiniType<
   z.transform((v) => {
     return remap$(v, {
       "current_usage": "currentUsage",
+      "grant_duration_unit": "grantDurationUnit",
+      "grant_duration_value": "grantDurationValue",
+      "grant_measure": "grantMeasure",
+      "grant_quota": "grantQuota",
+      "grant_state": "grantState",
+      "grant_unlimited": "grantUnlimited",
       "is_enabled": "isEnabled",
       "is_soft_limit": "isSoftLimit",
       "is_unlimited": "isUnlimited",

package/src/sdk/models/filter-operator-type.ts

@@ -3,7 +3,8 @@
  */
 
 import * as z from "zod/v4-mini";
-import { ClosedEnum } from "../../types/enums.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 
 export const FilterOperatorType = {
   Eq: "eq",
@@ -17,9 +18,15 @@ export const FilterOperatorType = {
   Before: "before",
   After: "after",
 } as const;
-export type FilterOperatorType = ClosedEnum<typeof FilterOperatorType>;
+export type FilterOperatorType = OpenEnum<typeof FilterOperatorType>;
 
 /** @internal */
-export const FilterOperatorType$outboundSchema: z.ZodMiniEnum<
-  typeof FilterOperatorType
-> = z.enum(FilterOperatorType);
+export const FilterOperatorType$inboundSchema: z.ZodMiniType<
+  FilterOperatorType,
+  unknown
+> = openEnums.inboundSchema(FilterOperatorType);
+/** @internal */
+export const FilterOperatorType$outboundSchema: z.ZodMiniType<
+  string,
+  FilterOperatorType
+> = openEnums.outboundSchema(FilterOperatorType);

package/src/sdk/models/fx-rate-filter.ts

@@ -0,0 +1,102 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import {
+  FilterCondition,
+  FilterCondition$Outbound,
+  FilterCondition$outboundSchema,
+} from "./filter-condition.js";
+import { FXRateScope, FXRateScope$outboundSchema } from "./fx-rate-scope.js";
+import {
+  SortCondition,
+  SortCondition$Outbound,
+  SortCondition$outboundSchema,
+} from "./sort-condition.js";
+import { Status, Status$outboundSchema } from "./status.js";
+
+export const FXRateFilterOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type FXRateFilterOrder = ClosedEnum<typeof FXRateFilterOrder>;
+
+export type FXRateFilter = {
+  endTime?: Date | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition> | undefined;
+  fromCurrency?: string | undefined;
+  fxRateIds?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: FXRateFilterOrder | undefined;
+  scope?: FXRateScope | undefined;
+  scopeId?: string | undefined;
+  sort?: Array<SortCondition> | undefined;
+  startTime?: Date | undefined;
+  status?: Status | undefined;
+  toCurrency?: string | undefined;
+};
+
+/** @internal */
+export const FXRateFilterOrder$outboundSchema: z.ZodMiniEnum<
+  typeof FXRateFilterOrder
+> = z.enum(FXRateFilterOrder);
+
+/** @internal */
+export type FXRateFilter$Outbound = {
+  end_time?: string | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition$Outbound> | undefined;
+  from_currency?: string | undefined;
+  fx_rate_ids?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  scope?: string | undefined;
+  scope_id?: string | undefined;
+  sort?: Array<SortCondition$Outbound> | undefined;
+  start_time?: string | undefined;
+  status?: string | undefined;
+  to_currency?: string | undefined;
+};
+
+/** @internal */
+export const FXRateFilter$outboundSchema: z.ZodMiniType<
+  FXRateFilter$Outbound,
+  FXRateFilter
+> = z.pipe(
+  z.object({
+    endTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    expand: z.optional(z.string()),
+    filters: z.optional(z.array(FilterCondition$outboundSchema)),
+    fromCurrency: z.optional(z.string()),
+    fxRateIds: z.optional(z.array(z.string())),
+    limit: z.optional(z.int()),
+    offset: z.optional(z.int()),
+    order: z.optional(FXRateFilterOrder$outboundSchema),
+    scope: z.optional(FXRateScope$outboundSchema),
+    scopeId: z.optional(z.string()),
+    sort: z.optional(z.array(SortCondition$outboundSchema)),
+    startTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    status: z.optional(Status$outboundSchema),
+    toCurrency: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      endTime: "end_time",
+      fromCurrency: "from_currency",
+      fxRateIds: "fx_rate_ids",
+      scopeId: "scope_id",
+      startTime: "start_time",
+      toCurrency: "to_currency",
+    });
+  }),
+);
+
+export function fxRateFilterToJSON(fxRateFilter: FXRateFilter): string {
+  return JSON.stringify(FXRateFilter$outboundSchema.parse(fxRateFilter));
+}

package/src/sdk/models/fx-rate-response.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 { FXRateScope, FXRateScope$inboundSchema } from "./fx-rate-scope.js";
+import { FXRateSource, FXRateSource$inboundSchema } from "./fx-rate-source.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import { Status, Status$inboundSchema } from "./status.js";
+
+export type FXRateResponse = {
+  createdAt?: Date | undefined;
+  createdBy?: string | undefined;
+  endDate?: Date | undefined;
+  environmentId?: string | undefined;
+  fromCurrency?: string | undefined;
+  id?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  rate?: string | undefined;
+  scope?: FXRateScope | undefined;
+  scopeId?: string | undefined;
+  source?: FXRateSource | undefined;
+  startDate?: Date | undefined;
+  status?: Status | undefined;
+  tenantId?: string | undefined;
+  toCurrency?: string | undefined;
+  updatedAt?: Date | undefined;
+  updatedBy?: string | undefined;
+};
+
+/** @internal */
+export const FXRateResponse$inboundSchema: z.ZodMiniType<
+  FXRateResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    created_at: types.optional(types.date()),
+    created_by: types.optional(types.string()),
+    end_date: types.optional(types.date()),
+    environment_id: types.optional(types.string()),
+    from_currency: types.optional(types.string()),
+    id: types.optional(types.string()),
+    metadata: types.optional(z.record(z.string(), types.string())),
+    rate: types.optional(types.string()),
+    scope: types.optional(FXRateScope$inboundSchema),
+    scope_id: types.optional(types.string()),
+    source: types.optional(FXRateSource$inboundSchema),
+    start_date: types.optional(types.date()),
+    status: types.optional(Status$inboundSchema),
+    tenant_id: types.optional(types.string()),
+    to_currency: types.optional(types.string()),
+    updated_at: types.optional(types.date()),
+    updated_by: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "created_by": "createdBy",
+      "end_date": "endDate",
+      "environment_id": "environmentId",
+      "from_currency": "fromCurrency",
+      "scope_id": "scopeId",
+      "start_date": "startDate",
+      "tenant_id": "tenantId",
+      "to_currency": "toCurrency",
+      "updated_at": "updatedAt",
+      "updated_by": "updatedBy",
+    });
+  }),
+);
+
+export function fxRateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<FXRateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FXRateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FXRateResponse' from JSON`,
+  );
+}

package/src/sdk/models/fx-rate-scope.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 FXRateScope = {
+  Tenant: "tenant",
+  Customer: "customer",
+  Subscription: "subscription",
+} as const;
+export type FXRateScope = OpenEnum<typeof FXRateScope>;
+
+/** @internal */
+export const FXRateScope$inboundSchema: z.ZodMiniType<FXRateScope, unknown> =
+  openEnums.inboundSchema(FXRateScope);
+/** @internal */
+export const FXRateScope$outboundSchema: z.ZodMiniType<string, FXRateScope> =
+  openEnums.outboundSchema(FXRateScope);

package/src/sdk/models/fx-rate-source.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 FXRateSource = {
+  Fixed: "fixed",
+  Market: "market",
+} as const;
+export type FXRateSource = OpenEnum<typeof FXRateSource>;
+
+/** @internal */
+export const FXRateSource$inboundSchema: z.ZodMiniType<FXRateSource, unknown> =
+  openEnums.inboundSchema(FXRateSource);
+/** @internal */
+export const FXRateSource$outboundSchema: z.ZodMiniType<string, FXRateSource> =
+  openEnums.outboundSchema(FXRateSource);

package/src/sdk/models/get-event-by-id-response.ts

@@ -22,6 +22,7 @@ import { SDKValidationError } from "./sdk-validation-error.js";
 export type GetEventByIDResponse = {
   debugTracker?: DebugTracker | undefined;
   event?: Event | undefined;
+  events?: Array<Event> | undefined;
   processedEvents?: Array<FeatureUsageInfo> | undefined;
   status?: EventProcessingStatusType | undefined;
 };
@@ -34,6 +35,7 @@ export const GetEventByIDResponse$inboundSchema: z.ZodMiniType<
   z.object({
     debug_tracker: types.optional(DebugTracker$inboundSchema),
     event: types.optional(Event$inboundSchema),
+    events: types.optional(z.array(Event$inboundSchema)),
     processed_events: types.optional(z.array(FeatureUsageInfo$inboundSchema)),
     status: types.optional(EventProcessingStatusType$inboundSchema),
   }),

package/src/sdk/models/get-event-op.ts

@@ -3,26 +3,54 @@
  */
 
 import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
 
 export type GetEventRequest = {
   /**
    * Event ID
    */
   id: string;
+  /**
+   * External customer ID the event was ingested with
+   */
+  externalCustomerId: string;
+  /**
+   * Start of the event timestamp window (RFC3339); defaults to 14 days before end_time
+   */
+  startTime?: string | undefined;
+  /**
+   * End of the event timestamp window (RFC3339); defaults to now
+   */
+  endTime?: string | undefined;
 };
 
 /** @internal */
 export type GetEventRequest$Outbound = {
   id: string;
+  external_customer_id: string;
+  start_time?: string | undefined;
+  end_time?: string | undefined;
 };
 
 /** @internal */
 export const GetEventRequest$outboundSchema: z.ZodMiniType<
   GetEventRequest$Outbound,
   GetEventRequest
-> = z.object({
-  id: z.string(),
-});
+> = z.pipe(
+  z.object({
+    id: z.string(),
+    externalCustomerId: z.string(),
+    startTime: z.optional(z.string()),
+    endTime: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      externalCustomerId: "external_customer_id",
+      startTime: "start_time",
+      endTime: "end_time",
+    });
+  }),
+);
 
 export function getEventRequestToJSON(
   getEventRequest: GetEventRequest,

package/src/sdk/models/get-fx-rate-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 GetFXRateRequest = {
+  /**
+   * FX rate ID
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetFXRateRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetFXRateRequest$outboundSchema: z.ZodMiniType<
+  GetFXRateRequest$Outbound,
+  GetFXRateRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getFXRateRequestToJSON(
+  getFXRateRequest: GetFXRateRequest,
+): string {
+  return JSON.stringify(
+    GetFXRateRequest$outboundSchema.parse(getFXRateRequest),
+  );
+}

package/src/sdk/models/grain.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 Grain = {
+  Hour: "hour",
+  Day: "day",
+  Week: "week",
+  Month: "month",
+} as const;
+export type Grain = OpenEnum<typeof Grain>;
+
+/** @internal */
+export const Grain$inboundSchema: z.ZodMiniType<Grain, unknown> = openEnums
+  .inboundSchema(Grain);
+/** @internal */
+export const Grain$outboundSchema: z.ZodMiniType<string, Grain> = openEnums
+  .outboundSchema(Grain);

package/src/sdk/models/grant-allowance-state.ts

@@ -0,0 +1,77 @@
+/*
+ * 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 {
+  EntitlementGrantMeasure,
+  EntitlementGrantMeasure$inboundSchema,
+} from "./entitlement-grant-measure.js";
+import {
+  EntitlementGrantStatus,
+  EntitlementGrantStatus$inboundSchema,
+} from "./entitlement-grant-status.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type GrantAllowanceState = {
+  entitlementId?: string | undefined;
+  grantId?: string | undefined;
+  isActive?: boolean | undefined;
+  lastComputedAt?: Date | undefined;
+  measure?: EntitlementGrantMeasure | undefined;
+  quota?: string | undefined;
+  quotaCrossedAt?: Date | undefined;
+  remaining?: string | undefined;
+  status?: EntitlementGrantStatus | undefined;
+  unlimited?: boolean | undefined;
+  usage?: string | undefined;
+  validFrom?: string | undefined;
+  validTo?: string | undefined;
+};
+
+/** @internal */
+export const GrantAllowanceState$inboundSchema: z.ZodMiniType<
+  GrantAllowanceState,
+  unknown
+> = z.pipe(
+  z.object({
+    entitlement_id: types.optional(types.string()),
+    grant_id: types.optional(types.string()),
+    is_active: types.optional(types.boolean()),
+    last_computed_at: types.optional(types.date()),
+    measure: types.optional(EntitlementGrantMeasure$inboundSchema),
+    quota: types.optional(types.string()),
+    quota_crossed_at: types.optional(types.date()),
+    remaining: types.optional(types.string()),
+    status: types.optional(EntitlementGrantStatus$inboundSchema),
+    unlimited: types.optional(types.boolean()),
+    usage: types.optional(types.string()),
+    valid_from: types.optional(types.string()),
+    valid_to: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "entitlement_id": "entitlementId",
+      "grant_id": "grantId",
+      "is_active": "isActive",
+      "last_computed_at": "lastComputedAt",
+      "quota_crossed_at": "quotaCrossedAt",
+      "valid_from": "validFrom",
+      "valid_to": "validTo",
+    });
+  }),
+);
+
+export function grantAllowanceStateFromJSON(
+  jsonString: string,
+): SafeParseResult<GrantAllowanceState, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GrantAllowanceState$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GrantAllowanceState' from JSON`,
+  );
+}

package/src/sdk/models/grant-state.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 {
+  GrantAllowanceState,
+  GrantAllowanceState$inboundSchema,
+} from "./grant-allowance-state.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type GrantState = {
+  allowances?: Array<GrantAllowanceState> | undefined;
+};
+
+/** @internal */
+export const GrantState$inboundSchema: z.ZodMiniType<GrantState, unknown> = z
+  .object({
+    allowances: types.optional(z.array(GrantAllowanceState$inboundSchema)),
+  });
+
+export function grantStateFromJSON(
+  jsonString: string,
+): SafeParseResult<GrantState, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GrantState$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GrantState' from JSON`,
+  );
+}