@flexprice/sdk 2.1.42 → 2.1.44-dev.1

package/src/funcs/webhook-events-post-webhook-events-commitment-updated.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { FlexpriceCore } from "../core.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { FlexPriceError } from "../sdk/models/flex-price-error.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/http-client-errors.js";
+import * as models from "../sdk/models/index.js";
+import { ResponseValidationError } from "../sdk/models/response-validation-error.js";
+import { SDKValidationError } from "../sdk/models/sdk-validation-error.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * commitment.updated
+ *
+ * @remarks
+ * Fired when a commitment's descriptive fields are updated. Doc-only for parsing.
+ */
+export function webhookEventsPostWebhookEventsCommitmentUpdated(
+  client: FlexpriceCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.WebhookDtoCommitmentWebhookPayload,
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: FlexpriceCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.WebhookDtoCommitmentWebhookPayload,
+      | FlexPriceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/webhook-events/commitment.updated")();
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "post_/webhook-events/commitment.updated",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    models.WebhookDtoCommitmentWebhookPayload,
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.WebhookDtoCommitmentWebhookPayload$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -69,7 +69,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.1.42",
-  genVersion: "2.948.4",
-  userAgent: "speakeasy-sdk/typescript 2.1.42 2.948.4 1.0 @flexprice/sdk",
+  sdkVersion: "2.1.44-dev.1",
+  genVersion: "2.952.5",
+  userAgent: "speakeasy-sdk/typescript 2.1.44-dev.1 2.952.5 1.0 @flexprice/sdk",
 } as const;

package/src/sdk/commitments.ts

@@ -0,0 +1,121 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { commitmentsCreateCommitment } from "../funcs/commitments-create-commitment.js";
+import { commitmentsGetCommitment } from "../funcs/commitments-get-commitment.js";
+import { commitmentsPreviewCommitment } from "../funcs/commitments-preview-commitment.js";
+import { commitmentsQueryCommitment } from "../funcs/commitments-query-commitment.js";
+import { commitmentsTerminateCommitment } from "../funcs/commitments-terminate-commitment.js";
+import { commitmentsUpdateCommitment } from "../funcs/commitments-update-commitment.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import * as models from "./models/index.js";
+
+export class Commitments extends ClientSDK {
+  /**
+   * Create commitment
+   *
+   * @remarks
+   * Creates a commitment on a subscription: a minimum spend or quantity over a term, with optional committed and overage rates.
+   */
+  async createCommitment(
+    request: models.CreateCommitmentRequest,
+    options?: RequestOptions,
+  ): Promise<models.CommitmentResponse> {
+    return unwrapAsync(commitmentsCreateCommitment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Preview commitment
+   *
+   * @remarks
+   * Validates a commitment and returns its computed value without creating it.
+   */
+  async previewCommitment(
+    request: models.CreateCommitmentRequest,
+    options?: RequestOptions,
+  ): Promise<models.CommitmentResponse> {
+    return unwrapAsync(commitmentsPreviewCommitment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query commitments
+   *
+   * @remarks
+   * Lists commitments with filtering and sorting. Returns a paginated list.
+   */
+  async queryCommitment(
+    request: models.CommitmentFilter,
+    options?: RequestOptions,
+  ): Promise<models.ListCommitmentsResponse> {
+    return unwrapAsync(commitmentsQueryCommitment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get commitment
+   *
+   * @remarks
+   * Loads a single commitment by ID.
+   */
+  async getCommitment(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<models.CommitmentResponse> {
+    return unwrapAsync(commitmentsGetCommitment(
+      this,
+      id,
+      options,
+    ));
+  }
+
+  /**
+   * Update commitment
+   *
+   * @remarks
+   * Updates the descriptive fields of a commitment. Economic terms are immutable.
+   */
+  async updateCommitment(
+    id: string,
+    body: models.UpdateCommitmentRequest,
+    options?: RequestOptions,
+  ): Promise<models.CommitmentResponse> {
+    return unwrapAsync(commitmentsUpdateCommitment(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+
+  /**
+   * Terminate commitment
+   *
+   * @remarks
+   * Ends a commitment early, effective at the given time or now.
+   */
+  async terminateCommitment(
+    id: string,
+    body?: models.TerminateCommitmentRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.CommitmentResponse> {
+    return unwrapAsync(commitmentsTerminateCommitment(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+}

package/src/sdk/events.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { eventsDeleteEvents } from "../funcs/events-delete-events.js";
 import { eventsGetEvent } from "../funcs/events-get-event.js";
 import { eventsGetUsageAnalytics } from "../funcs/events-get-usage-analytics.js";
 import { eventsGetUsageByMeter } from "../funcs/events-get-usage-by-meter.js";
@@ -65,6 +66,23 @@ export class Events extends ClientSDK {
     ));
   }
 
+  /**
+   * Delete events
+   *
+   * @remarks
+   * Hard-deletes ingested events and the meter usage they produced for the named customers and period, optionally narrowed by feature or by exact event id. Refused when anything in scope has already been invoiced. Irreversible.
+   */
+  async deleteEvents(
+    request: models.DeleteEventsRequest,
+    options?: RequestOptions,
+  ): Promise<models.DeleteEventsResponseResponse> {
+    return unwrapAsync(eventsDeleteEvents(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get event
    *

package/src/sdk/models/active-window.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 {
+  Bucket,
+  Bucket$inboundSchema,
+  Bucket$Outbound,
+  Bucket$outboundSchema,
+} from "./bucket.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type ActiveWindow = {
+  end?: Bucket | undefined;
+  start?: Bucket | undefined;
+};
+
+/** @internal */
+export const ActiveWindow$inboundSchema: z.ZodMiniType<ActiveWindow, unknown> =
+  z.object({
+    end: types.optional(Bucket$inboundSchema),
+    start: types.optional(Bucket$inboundSchema),
+  });
+/** @internal */
+export type ActiveWindow$Outbound = {
+  end?: Bucket$Outbound | undefined;
+  start?: Bucket$Outbound | undefined;
+};
+
+/** @internal */
+export const ActiveWindow$outboundSchema: z.ZodMiniType<
+  ActiveWindow$Outbound,
+  ActiveWindow
+> = z.object({
+  end: z.optional(Bucket$outboundSchema),
+  start: z.optional(Bucket$outboundSchema),
+});
+
+export function activeWindowToJSON(activeWindow: ActiveWindow): string {
+  return JSON.stringify(ActiveWindow$outboundSchema.parse(activeWindow));
+}
+export function activeWindowFromJSON(
+  jsonString: string,
+): SafeParseResult<ActiveWindow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ActiveWindow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ActiveWindow' from JSON`,
+  );
+}

package/src/sdk/models/add-addon-ref.ts

@@ -5,6 +5,11 @@
 import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { AddonCadence, AddonCadence$outboundSchema } from "./addon-cadence.js";
+import {
+  AddonPriceOverrideRef,
+  AddonPriceOverrideRef$Outbound,
+  AddonPriceOverrideRef$outboundSchema,
+} from "./addon-price-override-ref.js";
 import {
   CouponRef,
   CouponRef$Outbound,
@@ -20,6 +25,10 @@ export type AddAddonRef = {
   associationId?: string | undefined;
   cadence?: AddonCadence | undefined;
   coupons?: Array<CouponRef> | undefined;
+  /**
+   * Price overrides minted at execute time; completion repoints the line items instead of minting again.
+   */
+  priceOverrides?: Array<AddonPriceOverrideRef> | undefined;
   prorationBehavior?: ProrationBehavior | undefined;
   startDate?: Date | undefined;
 };
@@ -30,6 +39,7 @@ export type AddAddonRef$Outbound = {
   association_id?: string | undefined;
   cadence?: string | undefined;
   coupons?: Array<CouponRef$Outbound> | undefined;
+  price_overrides?: Array<AddonPriceOverrideRef$Outbound> | undefined;
   proration_behavior?: string | undefined;
   start_date?: string | undefined;
 };
@@ -44,6 +54,7 @@ export const AddAddonRef$outboundSchema: z.ZodMiniType<
     associationId: z.optional(z.string()),
     cadence: z.optional(AddonCadence$outboundSchema),
     coupons: z.optional(z.array(CouponRef$outboundSchema)),
+    priceOverrides: z.optional(z.array(AddonPriceOverrideRef$outboundSchema)),
     prorationBehavior: z.optional(ProrationBehavior$outboundSchema),
     startDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
   }),
@@ -51,6 +62,7 @@ export const AddAddonRef$outboundSchema: z.ZodMiniType<
     return remap$(v, {
       addonId: "addon_id",
       associationId: "association_id",
+      priceOverrides: "price_overrides",
       prorationBehavior: "proration_behavior",
       startDate: "start_date",
     });

package/src/sdk/models/addon-price-override-ref.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 AddonPriceOverrideRef = {
+  overridePriceId?: string | undefined;
+  priceId?: string | undefined;
+  quantity?: string | undefined;
+};
+
+/** @internal */
+export type AddonPriceOverrideRef$Outbound = {
+  override_price_id?: string | undefined;
+  price_id?: string | undefined;
+  quantity?: string | undefined;
+};
+
+/** @internal */
+export const AddonPriceOverrideRef$outboundSchema: z.ZodMiniType<
+  AddonPriceOverrideRef$Outbound,
+  AddonPriceOverrideRef
+> = z.pipe(
+  z.object({
+    overridePriceId: z.optional(z.string()),
+    priceId: z.optional(z.string()),
+    quantity: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      overridePriceId: "override_price_id",
+      priceId: "price_id",
+    });
+  }),
+);
+
+export function addonPriceOverrideRefToJSON(
+  addonPriceOverrideRef: AddonPriceOverrideRef,
+): string {
+  return JSON.stringify(
+    AddonPriceOverrideRef$outboundSchema.parse(addonPriceOverrideRef),
+  );
+}

package/src/sdk/models/commitment-collection-method.ts

@@ -0,0 +1,26 @@
+/*
+ * 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 CommitmentCollectionMethod = {
+  PerPeriod: "per_period",
+  BillingTerms: "billing_terms",
+} as const;
+export type CommitmentCollectionMethod = OpenEnum<
+  typeof CommitmentCollectionMethod
+>;
+
+/** @internal */
+export const CommitmentCollectionMethod$inboundSchema: z.ZodMiniType<
+  CommitmentCollectionMethod,
+  unknown
+> = openEnums.inboundSchema(CommitmentCollectionMethod);
+/** @internal */
+export const CommitmentCollectionMethod$outboundSchema: z.ZodMiniType<
+  string,
+  CommitmentCollectionMethod
+> = openEnums.outboundSchema(CommitmentCollectionMethod);

package/src/sdk/models/commitment-early-termination.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 CommitmentEarlyTermination = {
+  Forfeit: "forfeit",
+  CreditNote: "credit_note",
+  BillRemaining: "bill_remaining",
+} as const;
+export type CommitmentEarlyTermination = OpenEnum<
+  typeof CommitmentEarlyTermination
+>;
+
+/** @internal */
+export const CommitmentEarlyTermination$inboundSchema: z.ZodMiniType<
+  CommitmentEarlyTermination,
+  unknown
+> = openEnums.inboundSchema(CommitmentEarlyTermination);

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

@@ -0,0 +1,127 @@
+/*
+ * 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 {
+  CommitmentScopeType,
+  CommitmentScopeType$outboundSchema,
+} from "./commitment-scope-type.js";
+import {
+  CommitmentStatus,
+  CommitmentStatus$outboundSchema,
+} from "./commitment-status.js";
+import {
+  FilterCondition,
+  FilterCondition$Outbound,
+  FilterCondition$outboundSchema,
+} from "./filter-condition.js";
+import {
+  SortCondition,
+  SortCondition$Outbound,
+  SortCondition$outboundSchema,
+} from "./sort-condition.js";
+import { Status, Status$outboundSchema } from "./status.js";
+
+export const CommitmentFilterOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type CommitmentFilterOrder = ClosedEnum<typeof CommitmentFilterOrder>;
+
+export type CommitmentFilter = {
+  /**
+   * ActiveFrom/ActiveTo select commitments whose term overlaps [ActiveFrom, ActiveTo).
+   */
+  activeFrom?: string | undefined;
+  activeTo?: string | undefined;
+  customerIds?: Array<string> | undefined;
+  endTime?: Date | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition> | undefined;
+  ids?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: CommitmentFilterOrder | undefined;
+  scopeEntityIds?: Array<string> | undefined;
+  scopeEntityType?: CommitmentScopeType | undefined;
+  sort?: Array<SortCondition> | undefined;
+  startTime?: Date | undefined;
+  status?: Status | undefined;
+  statuses?: Array<CommitmentStatus> | undefined;
+  subscriptionIds?: Array<string> | undefined;
+};
+
+/** @internal */
+export const CommitmentFilterOrder$outboundSchema: z.ZodMiniEnum<
+  typeof CommitmentFilterOrder
+> = z.enum(CommitmentFilterOrder);
+
+/** @internal */
+export type CommitmentFilter$Outbound = {
+  active_from?: string | undefined;
+  active_to?: string | undefined;
+  customer_ids?: Array<string> | undefined;
+  end_time?: string | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition$Outbound> | undefined;
+  ids?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  scope_entity_ids?: Array<string> | undefined;
+  scope_entity_type?: string | undefined;
+  sort?: Array<SortCondition$Outbound> | undefined;
+  start_time?: string | undefined;
+  status?: string | undefined;
+  statuses?: Array<string> | undefined;
+  subscription_ids?: Array<string> | undefined;
+};
+
+/** @internal */
+export const CommitmentFilter$outboundSchema: z.ZodMiniType<
+  CommitmentFilter$Outbound,
+  CommitmentFilter
+> = z.pipe(
+  z.object({
+    activeFrom: z.optional(z.string()),
+    activeTo: z.optional(z.string()),
+    customerIds: z.optional(z.array(z.string())),
+    endTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    expand: z.optional(z.string()),
+    filters: z.optional(z.array(FilterCondition$outboundSchema)),
+    ids: z.optional(z.array(z.string())),
+    limit: z.optional(z.int()),
+    offset: z.optional(z.int()),
+    order: z.optional(CommitmentFilterOrder$outboundSchema),
+    scopeEntityIds: z.optional(z.array(z.string())),
+    scopeEntityType: z.optional(CommitmentScopeType$outboundSchema),
+    sort: z.optional(z.array(SortCondition$outboundSchema)),
+    startTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    status: z.optional(Status$outboundSchema),
+    statuses: z.optional(z.array(CommitmentStatus$outboundSchema)),
+    subscriptionIds: z.optional(z.array(z.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      activeFrom: "active_from",
+      activeTo: "active_to",
+      customerIds: "customer_ids",
+      endTime: "end_time",
+      scopeEntityIds: "scope_entity_ids",
+      scopeEntityType: "scope_entity_type",
+      startTime: "start_time",
+      subscriptionIds: "subscription_ids",
+    });
+  }),
+);
+
+export function commitmentFilterToJSON(
+  commitmentFilter: CommitmentFilter,
+): string {
+  return JSON.stringify(
+    CommitmentFilter$outboundSchema.parse(commitmentFilter),
+  );
+}

package/src/sdk/models/commitment-measurement.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 CommitmentMeasurement = {
+  BillingPeriod: "billing_period",
+  Window: "window",
+} as const;
+export type CommitmentMeasurement = OpenEnum<typeof CommitmentMeasurement>;
+
+/** @internal */
+export const CommitmentMeasurement$inboundSchema: z.ZodMiniType<
+  CommitmentMeasurement,
+  unknown
+> = openEnums.inboundSchema(CommitmentMeasurement);
+/** @internal */
+export const CommitmentMeasurement$outboundSchema: z.ZodMiniType<
+  string,
+  CommitmentMeasurement
+> = openEnums.outboundSchema(CommitmentMeasurement);