@flexprice/sdk 2.1.44-dev.7 → 2.1.45-dev.11

package/src/sdk/models/waterfall-request.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 {
+  RevenueReportGroupBy,
+  RevenueReportGroupBy$outboundSchema,
+} from "./revenue-report-group-by.js";
+
+export type WaterfallRequest = {
+  /**
+   * report date: pending and scheduled split here; defaults to now
+   */
+  asOf?: string | undefined;
+  contractIds?: Array<string> | undefined;
+  currency: string;
+  customerIds?: Array<string> | undefined;
+  /**
+   * month-end deferred and unbilled balances
+   */
+  details?: boolean | undefined;
+  groupBy?: RevenueReportGroupBy | undefined;
+  /**
+   * rows per page; totals are never paged
+   */
+  limit?: number | undefined;
+  offset?: number | undefined;
+  /**
+   * YYYY-MM, at most 36 months from period_start
+   */
+  periodEnd: Date;
+  /**
+   * YYYY-MM
+   */
+  periodStart: Date;
+  pobIds?: Array<string> | undefined;
+};
+
+/** @internal */
+export type WaterfallRequest$Outbound = {
+  as_of?: string | undefined;
+  contract_ids?: Array<string> | undefined;
+  currency: string;
+  customer_ids?: Array<string> | undefined;
+  details?: boolean | undefined;
+  group_by?: string | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  period_end: string;
+  period_start: string;
+  pob_ids?: Array<string> | undefined;
+};
+
+/** @internal */
+export const WaterfallRequest$outboundSchema: z.ZodMiniType<
+  WaterfallRequest$Outbound,
+  WaterfallRequest
+> = z.pipe(
+  z.object({
+    asOf: z.optional(z.string()),
+    contractIds: z.optional(z.array(z.string())),
+    currency: z.string(),
+    customerIds: z.optional(z.array(z.string())),
+    details: z.optional(z.boolean()),
+    groupBy: z.optional(RevenueReportGroupBy$outboundSchema),
+    limit: z.optional(z.int()),
+    offset: z.optional(z.int()),
+    periodEnd: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    periodStart: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    pobIds: z.optional(z.array(z.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      asOf: "as_of",
+      contractIds: "contract_ids",
+      customerIds: "customer_ids",
+      groupBy: "group_by",
+      periodEnd: "period_end",
+      periodStart: "period_start",
+      pobIds: "pob_ids",
+    });
+  }),
+);
+
+export function waterfallRequestToJSON(
+  waterfallRequest: WaterfallRequest,
+): string {
+  return JSON.stringify(
+    WaterfallRequest$outboundSchema.parse(waterfallRequest),
+  );
+}

package/src/sdk/models/waterfall-response.ts

@@ -0,0 +1,47 @@
+/*
+ * 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 {
+  PaginationResponse,
+  PaginationResponse$inboundSchema,
+} from "./pagination-response.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  WaterfallCell,
+  WaterfallCell$inboundSchema,
+} from "./waterfall-cell.js";
+import { WaterfallRow, WaterfallRow$inboundSchema } from "./waterfall-row.js";
+
+export type WaterfallResponse = {
+  items?: Array<WaterfallRow> | undefined;
+  pagination?: PaginationResponse | undefined;
+  /**
+   * per period over all rows, never paged
+   */
+  totals?: Array<WaterfallCell> | undefined;
+};
+
+/** @internal */
+export const WaterfallResponse$inboundSchema: z.ZodMiniType<
+  WaterfallResponse,
+  unknown
+> = z.object({
+  items: types.optional(z.array(WaterfallRow$inboundSchema)),
+  pagination: types.optional(PaginationResponse$inboundSchema),
+  totals: types.optional(z.array(WaterfallCell$inboundSchema)),
+});
+
+export function waterfallResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<WaterfallResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WaterfallResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WaterfallResponse' from JSON`,
+  );
+}

package/src/sdk/models/waterfall-row.ts

@@ -0,0 +1,52 @@
+/*
+ * 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 { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  WaterfallCell,
+  WaterfallCell$inboundSchema,
+} from "./waterfall-cell.js";
+
+export type WaterfallRow = {
+  /**
+   * one per requested period, in order
+   */
+  cells?: Array<WaterfallCell> | undefined;
+  contractId?: string | undefined;
+  customerId?: string | undefined;
+  pobId?: string | undefined;
+};
+
+/** @internal */
+export const WaterfallRow$inboundSchema: z.ZodMiniType<WaterfallRow, unknown> =
+  z.pipe(
+    z.object({
+      cells: types.optional(z.array(WaterfallCell$inboundSchema)),
+      contract_id: types.optional(types.string()),
+      customer_id: types.optional(types.string()),
+      pob_id: types.optional(types.string()),
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        "contract_id": "contractId",
+        "customer_id": "customerId",
+        "pob_id": "pobId",
+      });
+    }),
+  );
+
+export function waterfallRowFromJSON(
+  jsonString: string,
+): SafeParseResult<WaterfallRow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WaterfallRow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WaterfallRow' from JSON`,
+  );
+}

package/src/sdk/performance-obligations.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { performanceObligationsGetPerformanceObligation } from "../funcs/performance-obligations-get-performance-obligation.js";
+import { performanceObligationsQueryPerformanceObligation } from "../funcs/performance-obligations-query-performance-obligation.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import * as models from "./models/index.js";
+
+export class PerformanceObligations extends ClientSDK {
+  /**
+   * Query performance obligations
+   *
+   * @remarks
+   * Use when searching performance obligations by contract, customer, status or recognition method. Returns a paginated list.
+   */
+  async queryPerformanceObligation(
+    request: models.PobFilter,
+    options?: RequestOptions,
+  ): Promise<models.ListPerformanceObligationsResponse> {
+    return unwrapAsync(performanceObligationsQueryPerformanceObligation(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get performance obligation
+   *
+   * @remarks
+   * Use when you need to load a single performance obligation with the subscription line items it covers. Performance obligations are derived from subscriptions and are read-only.
+   */
+  async getPerformanceObligation(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<models.PerformanceObligationResponse> {
+    return unwrapAsync(performanceObligationsGetPerformanceObligation(
+      this,
+      id,
+      options,
+    ));
+  }
+}

package/src/sdk/products.ts

@@ -0,0 +1,119 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { productsCreateProduct } from "../funcs/products-create-product.js";
+import { productsDeleteProduct } from "../funcs/products-delete-product.js";
+import { productsGetProduct } from "../funcs/products-get-product.js";
+import { productsListProducts } from "../funcs/products-list-products.js";
+import { productsQueryProduct } from "../funcs/products-query-product.js";
+import { productsUpdateProduct } from "../funcs/products-update-product.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import * as models from "./models/index.js";
+
+export class Products extends ClientSDK {
+  /**
+   * List products
+   *
+   * @remarks
+   * Use when listing products. Returns a paginated list.
+   */
+  async listProducts(
+    request?: models.ListProductsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.ListProductsResponse> {
+    return unwrapAsync(productsListProducts(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create product
+   *
+   * @remarks
+   * Use when defining a reusable commercial identity for what you sell. Prices can reference it through product_id.
+   */
+  async createProduct(
+    request: models.CreateProductRequest,
+    options?: RequestOptions,
+  ): Promise<models.ProductResponse> {
+    return unwrapAsync(productsCreateProduct(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query products
+   *
+   * @remarks
+   * Use when searching products by ids, lookup keys, filters and sorts. Returns a paginated list.
+   */
+  async queryProduct(
+    request: models.ProductFilter,
+    options?: RequestOptions,
+  ): Promise<models.ListProductsResponse> {
+    return unwrapAsync(productsQueryProduct(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get product
+   *
+   * @remarks
+   * Use when you need to load a single product.
+   */
+  async getProduct(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<models.ProductResponse> {
+    return unwrapAsync(productsGetProduct(
+      this,
+      id,
+      options,
+    ));
+  }
+
+  /**
+   * Update product
+   *
+   * @remarks
+   * Use when changing a product's name or description. The lookup key never changes.
+   */
+  async updateProduct(
+    id: string,
+    body: models.UpdateProductRequest,
+    options?: RequestOptions,
+  ): Promise<models.ProductResponse> {
+    return unwrapAsync(productsUpdateProduct(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+
+  /**
+   * Delete product
+   *
+   * @remarks
+   * Use when retiring a product. Fails while any published price references it.
+   */
+  async deleteProduct(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<models.SuccessResponse> {
+    return unwrapAsync(productsDeleteProduct(
+      this,
+      id,
+      options,
+    ));
+  }
+}

package/src/sdk/revenue-reports.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { revenueReportsGetRevenueRollforward } from "../funcs/revenue-reports-get-revenue-rollforward.js";
+import { revenueReportsGetRevenueWaterfall } from "../funcs/revenue-reports-get-revenue-waterfall.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import * as models from "./models/index.js";
+
+export class RevenueReports extends ClientSDK {
+  /**
+   * Get revenue rollforward
+   *
+   * @remarks
+   * Use when explaining how deferred revenue, unbilled receivable or another ledger account moved in ended months: opening balance, movements by category (invoiced, earned, adjustments, payments, refunds) and closing balance, optionally per customer, contract or performance obligation.
+   */
+  async getRevenueRollforward(
+    request: models.RollforwardRequest,
+    options?: RequestOptions,
+  ): Promise<models.RollforwardResponse> {
+    return unwrapAsync(revenueReportsGetRevenueRollforward(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get revenue waterfall
+   *
+   * @remarks
+   * Use when showing revenue per customer, contract or performance obligation and month: actual (posted), pending (earned, not yet posted) and scheduled (invoiced, not yet earned), with optional month-end deferred and unbilled balances. Covers at most 36 months.
+   */
+  async getRevenueWaterfall(
+    request: models.WaterfallRequest,
+    options?: RequestOptions,
+  ): Promise<models.WaterfallResponse> {
+    return unwrapAsync(revenueReportsGetRevenueWaterfall(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -3,6 +3,7 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
+import { AccountingPeriods } from "./accounting-periods.js";
 import { Activity } from "./activity.js";
 import { Addons } from "./addons.js";
 import { AlertSettings } from "./alert-settings.js";
@@ -10,6 +11,7 @@ import { Alerts } from "./alerts.js";
 import { Analytics } from "./analytics.js";
 import { Checkout } from "./checkout.js";
 import { Commitments } from "./commitments.js";
+import { Contracts } from "./contracts.js";
 import { Costs } from "./costs.js";
 import { CouponAssociations } from "./coupon-associations.js";
 import { Coupons } from "./coupons.js";
@@ -24,13 +26,17 @@ import { FXRates } from "./fx-rates.js";
 import { Groups } from "./groups.js";
 import { Integrations } from "./integrations.js";
 import { Invoices } from "./invoices.js";
+import { JournalEntries } from "./journal-entries.js";
 import { Marketplace } from "./marketplace.js";
 import { Payments } from "./payments.js";
+import { PerformanceObligations } from "./performance-obligations.js";
 import { Plans } from "./plans.js";
 import { PriceUnits } from "./price-units.js";
 import { Prices } from "./prices.js";
+import { Products } from "./products.js";
 import { Rbac } from "./rbac.js";
 import { Refunds } from "./refunds.js";
+import { RevenueReports } from "./revenue-reports.js";
 import { ScheduledTasks } from "./scheduled-tasks.js";
 import { Secrets } from "./secrets.js";
 import { SelfBilling } from "./self-billing.js";
@@ -46,6 +52,11 @@ import { WebhookEvents } from "./webhook-events.js";
 import { Workflows } from "./workflows.js";
 
 export class Flexprice extends ClientSDK {
+  private _accountingPeriods?: AccountingPeriods;
+  get accountingPeriods(): AccountingPeriods {
+    return (this._accountingPeriods ??= new AccountingPeriods(this._options));
+  }
+
   private _activity?: Activity;
   get activity(): Activity {
     return (this._activity ??= new Activity(this._options));
@@ -91,6 +102,11 @@ export class Flexprice extends ClientSDK {
     return (this._commitments ??= new Commitments(this._options));
   }
 
+  private _contracts?: Contracts;
+  get contracts(): Contracts {
+    return (this._contracts ??= new Contracts(this._options));
+  }
+
   private _costs?: Costs;
   get costs(): Costs {
     return (this._costs ??= new Costs(this._options));
@@ -156,6 +172,11 @@ export class Flexprice extends ClientSDK {
     return (this._integrations ??= new Integrations(this._options));
   }
 
+  private _journalEntries?: JournalEntries;
+  get journalEntries(): JournalEntries {
+    return (this._journalEntries ??= new JournalEntries(this._options));
+  }
+
   private _marketplace?: Marketplace;
   get marketplace(): Marketplace {
     return (this._marketplace ??= new Marketplace(this._options));
@@ -166,6 +187,13 @@ export class Flexprice extends ClientSDK {
     return (this._payments ??= new Payments(this._options));
   }
 
+  private _performanceObligations?: PerformanceObligations;
+  get performanceObligations(): PerformanceObligations {
+    return (this._performanceObligations ??= new PerformanceObligations(
+      this._options,
+    ));
+  }
+
   private _plans?: Plans;
   get plans(): Plans {
     return (this._plans ??= new Plans(this._options));
@@ -186,6 +214,11 @@ export class Flexprice extends ClientSDK {
     return (this._priceUnits ??= new PriceUnits(this._options));
   }
 
+  private _products?: Products;
+  get products(): Products {
+    return (this._products ??= new Products(this._options));
+  }
+
   private _rbac?: Rbac;
   get rbac(): Rbac {
     return (this._rbac ??= new Rbac(this._options));
@@ -196,6 +229,11 @@ export class Flexprice extends ClientSDK {
     return (this._refunds ??= new Refunds(this._options));
   }
 
+  private _revenueReports?: RevenueReports;
+  get revenueReports(): RevenueReports {
+    return (this._revenueReports ??= new RevenueReports(this._options));
+  }
+
   private _secrets?: Secrets;
   get secrets(): Secrets {
     return (this._secrets ??= new Secrets(this._options));