@tirdad/sdk 2.1.43 → 2.1.45

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,12 +3,15 @@
  */
 
 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";
 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";
@@ -23,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";
@@ -45,6 +52,11 @@ import { WebhookEvents } from "./webhook-events.js";
 import { Workflows } from "./workflows.js";
 
 export class Tirdad 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));
@@ -85,6 +97,16 @@ export class Tirdad extends ClientSDK {
     return (this._checkout ??= new Checkout(this._options));
   }
 
+  private _commitments?: Commitments;
+  get commitments(): Commitments {
+    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));
@@ -150,6 +172,11 @@ export class Tirdad 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));
@@ -160,6 +187,13 @@ export class Tirdad 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));
@@ -180,6 +214,11 @@ export class Tirdad 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));
@@ -190,6 +229,11 @@ export class Tirdad 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));

package/src/sdk/self-billing.ts

@@ -99,7 +99,7 @@ export class SelfBilling extends ClientSDK {
    * Get self-billing summary
    *
    * @remarks
-   * Returns the caller tenant's billing status, subscription, recent invoices and usage.
+   * Returns billing status, recent invoices, usage and a plan with charges. Charges use expanded subscription line-item prices, including overrides; without a current subscription they use the configured self-serve plan. Pricing terms are not an invoice total.
    */
   async getSelfBillingSummary(
     options?: RequestOptions,

package/src/sdk/webhook-events.ts

@@ -6,6 +6,9 @@ import { webhookEventsPostWebhookEventsCheckoutSessionCompleted } from "../funcs
 import { webhookEventsPostWebhookEventsCheckoutSessionExpired } from "../funcs/webhook-events-post-webhook-events-checkout-session-expired.js";
 import { webhookEventsPostWebhookEventsCheckoutSessionFailed } from "../funcs/webhook-events-post-webhook-events-checkout-session-failed.js";
 import { webhookEventsPostWebhookEventsCheckoutSessionInitiated } from "../funcs/webhook-events-post-webhook-events-checkout-session-initiated.js";
+import { webhookEventsPostWebhookEventsCommitmentCreated } from "../funcs/webhook-events-post-webhook-events-commitment-created.js";
+import { webhookEventsPostWebhookEventsCommitmentTerminated } from "../funcs/webhook-events-post-webhook-events-commitment-terminated.js";
+import { webhookEventsPostWebhookEventsCommitmentUpdated } from "../funcs/webhook-events-post-webhook-events-commitment-updated.js";
 import { webhookEventsPostWebhookEventsCreditNoteCreated } from "../funcs/webhook-events-post-webhook-events-credit-note-created.js";
 import { webhookEventsPostWebhookEventsCreditNoteUpdated } from "../funcs/webhook-events-post-webhook-events-credit-note-updated.js";
 import { webhookEventsPostWebhookEventsCustomerCreated } from "../funcs/webhook-events-post-webhook-events-customer-created.js";
@@ -129,6 +132,51 @@ export class WebhookEvents extends ClientSDK {
     ));
   }
 
+  /**
+   * commitment.created
+   *
+   * @remarks
+   * Fired when a commitment is created on a subscription. Doc-only for parsing.
+   */
+  async postWebhookEventsCommitmentCreated(
+    options?: RequestOptions,
+  ): Promise<models.WebhookDtoCommitmentWebhookPayload> {
+    return unwrapAsync(webhookEventsPostWebhookEventsCommitmentCreated(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * commitment.terminated
+   *
+   * @remarks
+   * Fired when a commitment is terminated. Doc-only for parsing.
+   */
+  async postWebhookEventsCommitmentTerminated(
+    options?: RequestOptions,
+  ): Promise<models.WebhookDtoCommitmentWebhookPayload> {
+    return unwrapAsync(webhookEventsPostWebhookEventsCommitmentTerminated(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * commitment.updated
+   *
+   * @remarks
+   * Fired when a commitment's descriptive fields are updated. Doc-only for parsing.
+   */
+  async postWebhookEventsCommitmentUpdated(
+    options?: RequestOptions,
+  ): Promise<models.WebhookDtoCommitmentWebhookPayload> {
+    return unwrapAsync(webhookEventsPostWebhookEventsCommitmentUpdated(
+      this,
+      options,
+    ));
+  }
+
   /**
    * credit_note.created
    *