@openmeter/client 1.0.0-beta.231 → 1.0.0-beta.233

package/dist/sdk/internal.js

@@ -1,10 +1,14 @@
 // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
 import { paginatePages } from '../lib/paginate.js';
-import { createSubscriptionAddon } from '../funcs/subscriptions.js';
-import { listInvoices, getInvoice, updateInvoice, deleteInvoice, } from '../funcs/invoices.js';
-import { listCurrencies, createCustomCurrency, listCostBases, createCostBasis, } from '../funcs/currencies.js';
-import { queryGovernanceAccess } from '../funcs/governance.js';
+import { voidCreditGrant, listCustomerCharges, createCustomerCharges, } from '../funcs/customers.js';
+import { unscheduleSubscription, restoreSubscription, migrateSubscription, updateSubscriptionAddon, } from '../funcs/subscriptions.js';
+import { listApps, uninstallApp, updateApp, listAppCatalog, getAppCatalogItem, installApp, } from '../funcs/apps.js';
+import { listInvoices, getInvoice, updateInvoice, deleteInvoice, advanceInvoice, approveInvoice, retryInvoice, snapshotQuantitiesInvoice, } from '../funcs/invoices.js';
+import { listCharges } from '../funcs/charges.js';
+import { listCurrencies, createCustomCurrency, getCustomCurrency, listCostBases, createCostBasis, } from '../funcs/currencies.js';
+import { listPlanAddons } from '../funcs/planAddons.js';
+import { queryEntitlementAccess } from '../funcs/entitlementAccess.js';
 /**
  * Operations marked internal in the API definition. They are not part of
  * the customer surface: they may require additional permissions, and they
@@ -15,21 +19,129 @@ export class Internal {
     constructor(_client) {
         this._client = _client;
     }
+    _customers;
+    get customers() {
+        return (this._customers ??= new InternalCustomers(this._client));
+    }
     _subscriptions;
     get subscriptions() {
         return (this._subscriptions ??= new InternalSubscriptions(this._client));
     }
+    _apps;
+    get apps() {
+        return (this._apps ??= new InternalApps(this._client));
+    }
     _invoices;
     get invoices() {
         return (this._invoices ??= new InternalInvoices(this._client));
     }
+    _charges;
+    get charges() {
+        return (this._charges ??= new InternalCharges(this._client));
+    }
     _currencies;
     get currencies() {
         return (this._currencies ??= new InternalCurrencies(this._client));
     }
-    _governance;
-    get governance() {
-        return (this._governance ??= new InternalGovernance(this._client));
+    _planAddons;
+    get planAddons() {
+        return (this._planAddons ??= new InternalPlanAddons(this._client));
+    }
+    _entitlementAccess;
+    get entitlementAccess() {
+        return (this._entitlementAccess ??= new InternalEntitlementAccess(this._client));
+    }
+}
+export class InternalCustomers {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    _credits;
+    get credits() {
+        return (this._credits ??= new InternalCustomersCredits(this._client));
+    }
+    _charges;
+    get charges() {
+        return (this._charges ??= new InternalCustomersCharges(this._client));
+    }
+}
+export class InternalCustomersCredits {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    _grants;
+    get grants() {
+        return (this._grants ??= new InternalCustomersCreditsGrants(this._client));
+    }
+}
+export class InternalCustomersCreditsGrants {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * Void credit grant
+     *
+     * Void a credit grant, forfeiting the remaining unused balance.
+     *
+     * Voiding is a forward-looking, irreversible operation. Credits already consumed
+     * by usage remain unaffected — only the remaining balance is forfeited. The grant
+     * reads as `voided` status afterwards. Payment state is not adjusted when
+     * `payment_adjustment` is `none`, so invoice-backed or externally collected
+     * payments may still collect the original amount. Only `active` grants can be
+     * voided; voiding a pending, expired, or fully consumed grant returns a conflict.
+     * Retrying a successful void is an idempotent success.
+     *
+     * POST /openmeter/customers/{customerId}/credits/grants/{creditGrantId}/void
+     */
+    async void(request, options) {
+        return unwrap(await voidCreditGrant(this._client, request, options));
+    }
+}
+export class InternalCustomersCharges {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * List customer charges
+     *
+     * List customer charges.
+     *
+     * Returns the customer's charges that are represented as either flat fee or
+     * usage-based charges.
+     *
+     * GET /openmeter/customers/{customerId}/charges
+     */
+    async list(request, options) {
+        return unwrap(await listCustomerCharges(this._client, request, options));
+    }
+    /**
+     * List customer charges
+     *
+     * List customer charges.
+     *
+     * Returns the customer's charges that are represented as either flat fee or
+     * usage-based charges.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/customers/{customerId}/charges
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listCustomerCharges(this._client, req, opts), request, options);
+    }
+    /**
+     * Create customer charge
+     *
+     * Create customer charge.
+     *
+     * POST /openmeter/customers/{customerId}/charges
+     */
+    async create(request, options) {
+        return unwrap(await createCustomerCharges(this._client, request, options));
     }
 }
 export class InternalSubscriptions {
@@ -38,14 +150,150 @@ export class InternalSubscriptions {
         this._client = _client;
     }
     /**
-     * Create a new subscription add-on
+     * Unschedule subscription
+     *
+     * Deletes a scheduled subscription that has not yet become active, removing it and
+     * resolving any scheduling conflict it was holding. This is distinct from
+     * canceling: cancel ends a running subscription, whereas unscheduling removes a
+     * not-yet-active one. Only scheduled subscriptions can be unscheduled;
+     * unscheduling an active or already-started subscription is rejected.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/unschedule
+     */
+    async unschedule(request, options) {
+        return unwrap(await unscheduleSubscription(this._client, request, options));
+    }
+    /**
+     * Restore subscription
+     *
+     * Restores the subscription by deleting any later-scheduled successor
+     * subscriptions and continuing this one indefinitely. This is the inverse of a
+     * future-dated change, which schedules a successor. Restore is not available when
+     * multi-subscription is enabled.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/restore
+     */
+    async restore(request, options) {
+        return unwrap(await restoreSubscription(this._client, request, options));
+    }
+    /**
+     * Migrate subscription
+     *
+     * Migrates to a later version of the current plan. With starting_phase omitted and
+     * billing_anchor omitted or unchanged, migration amends the subscription in place:
+     * unchanged items retain their service periods and both response entries have the
+     * same ID. Existing addons must remain compatible with the target plan.
+     * Incompatible phase timelines or billing settings return an error. Providing
+     * starting_phase or a different billing_anchor explicitly requests replacement,
+     * which resets the phase timeline, may produce billing adjustments, and does not
+     * transfer addons. Custom subscriptions cannot be migrated.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/migrate
+     */
+    async migrate(request, options) {
+        return unwrap(await migrateSubscription(this._client, request, options));
+    }
+    /**
+     * Update subscription addon
+     *
+     * Update a subscription add-on. Only the quantity is mutable; the timing controls
+     * when the new quantity takes effect. A new entry is appended to the add-on's
+     * timeline.
+     *
+     * PATCH /openmeter/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}
+     */
+    async updateAddon(request, options) {
+        return unwrap(await updateSubscriptionAddon(this._client, request, options));
+    }
+}
+export class InternalApps {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * List apps
+     *
+     * List installed apps.
+     *
+     * GET /openmeter/apps
+     */
+    async list(request, options) {
+        return unwrap(await listApps(this._client, request, options));
+    }
+    /**
+     * List apps
+     *
+     * List installed apps.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/apps
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listApps(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Uninstall app
+     *
+     * Uninstall an app by ID.
+     *
+     * DELETE /openmeter/apps/{appId}
+     */
+    async uninstall(request, options) {
+        return unwrap(await uninstallApp(this._client, request, options));
+    }
+    /**
+     * Update app
      *
-     * Add add-on to a subscription.
+     * Update an installed app.
      *
-     * POST /openmeter/subscriptions/{subscriptionId}/addons
+     * PUT /openmeter/apps/{appId}
      */
-    async createAddon(request, options) {
-        return unwrap(await createSubscriptionAddon(this._client, request, options));
+    async update(request, options) {
+        return unwrap(await updateApp(this._client, request, options));
+    }
+    /**
+     * List app catalog
+     *
+     * List available apps.
+     *
+     * GET /openmeter/app-catalog
+     */
+    async listCatalog(request, options) {
+        return unwrap(await listAppCatalog(this._client, request, options));
+    }
+    /**
+     * List app catalog
+     *
+     * List available apps.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/app-catalog
+     */
+    listCatalogAll(request, options) {
+        return paginatePages((req, opts) => listAppCatalog(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Get app catalog item by type
+     *
+     * Get an app catalog item by type.
+     *
+     * GET /openmeter/app-catalog/{appType}
+     */
+    async getCatalogItem(request, options) {
+        return unwrap(await getAppCatalogItem(this._client, request, options));
+    }
+    /**
+     * Install app from the catalog
+     *
+     * Install an app from the catalog.
+     *
+     * POST /openmeter/app-catalog/install
+     */
+    async install(request, options) {
+        return unwrap(await installApp(this._client, request, options));
     }
 }
 export class InternalInvoices {
@@ -125,6 +373,105 @@ export class InternalInvoices {
     async delete(request, options) {
         return unwrap(await deleteInvoice(this._client, request, options));
     }
+    /**
+     * Advance billing invoice's next status
+     *
+     * Advance a billing invoice.
+     *
+     * Advances the invoice to the next workflow state. The next state is determined by
+     * the invoice's current status and workflow configuration. Only invoices in draft
+     * or issued status can be advanced.
+     *
+     * POST /openmeter/billing/invoices/{invoiceId}/advance
+     */
+    async advance(request, options) {
+        return unwrap(await advanceInvoice(this._client, request, options));
+    }
+    /**
+     * Send the invoice to the customer
+     *
+     * Approve a billing invoice.
+     *
+     * This call instantly sends the invoice to the customer using the configured
+     * billing profile app.
+     *
+     * This call is valid in two invoice statuses:
+     *
+     * - draft: the invoice will be sent to the customer, the invoice state becomes
+     * issued
+     * - manual_approval_needed: the invoice will be sent to the customer, the invoice
+     * state becomes issued
+     *
+     * POST /openmeter/billing/invoices/{invoiceId}/approve
+     */
+    async approve(request, options) {
+        return unwrap(await approveInvoice(this._client, request, options));
+    }
+    /**
+     * Retry advancing the invoice after a failed attempt
+     *
+     * Retry sending a billing invoice.
+     *
+     * Retry advancing the invoice after a failed attempt.
+     *
+     * The action can be called when the invoice's statusDetails' actions field contain
+     * the "retry" action.
+     *
+     * POST /openmeter/billing/invoices/{invoiceId}/retry
+     */
+    async retry(request, options) {
+        return unwrap(await retryInvoice(this._client, request, options));
+    }
+    /**
+     * Snapshot quantities for usage based line items
+     *
+     * Snapshot quantities for usage-based line items.
+     *
+     * This call will snapshot the quantities for all usage based line items in the
+     * invoice.
+     *
+     * This call is only valid in draft.waiting_for_collection status, where the
+     * collection period can be skipped using this action.
+     *
+     * POST /openmeter/billing/invoices/{invoiceId}/snapshot-quantities
+     */
+    async snapshotQuantities(request, options) {
+        return unwrap(await snapshotQuantitiesInvoice(this._client, request, options));
+    }
+}
+export class InternalCharges {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * List charges
+     *
+     * List charges.
+     *
+     * Returns the charges of every customer that are represented as either flat fee or
+     * usage-based charges.
+     *
+     * GET /openmeter/charges
+     */
+    async list(request, options) {
+        return unwrap(await listCharges(this._client, request, options));
+    }
+    /**
+     * List charges
+     *
+     * List charges.
+     *
+     * Returns the charges of every customer that are represented as either flat fee or
+     * usage-based charges.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/charges
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listCharges(this._client, req, opts), request ?? {}, options);
+    }
 }
 export class InternalCurrencies {
     _client;
@@ -164,6 +511,16 @@ export class InternalCurrencies {
     async createCustomCurrency(request, options) {
         return unwrap(await createCustomCurrency(this._client, request, options));
     }
+    /**
+     * Get custom currency
+     *
+     * Get a custom currency.
+     *
+     * GET /openmeter/currencies/custom/{currencyId}
+     */
+    async getCustomCurrency(request, options) {
+        return unwrap(await getCustomCurrency(this._client, request, options));
+    }
     /**
      * List cost bases
      *
@@ -199,13 +556,41 @@ export class InternalCurrencies {
         return unwrap(await createCostBasis(this._client, request, options));
     }
 }
-export class InternalGovernance {
+export class InternalPlanAddons {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * List add-ons for plan
+     *
+     * List add-ons associated with a plan.
+     *
+     * GET /openmeter/plans/{planId}/addons
+     */
+    async list(request, options) {
+        return unwrap(await listPlanAddons(this._client, request, options));
+    }
+    /**
+     * List add-ons for plan
+     *
+     * List add-ons associated with a plan.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/plans/{planId}/addons
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listPlanAddons(this._client, req, opts), request, options);
+    }
+}
+export class InternalEntitlementAccess {
     _client;
     constructor(_client) {
         this._client = _client;
     }
     /**
-     * Query governance access
+     * Query entitlement access
      *
      * Query feature access for a list of customers.
      *
@@ -216,9 +601,9 @@ export class InternalGovernance {
      * _Designed to be called on a fixed refresh interval and the query response is
      * intended to be cached._
      *
-     * POST /openmeter/governance/query
+     * POST /openmeter/entitlement-access/query
      */
-    async queryAccess(request, options) {
-        return unwrap(await queryGovernanceAccess(this._client, request, options));
+    async query(request, options) {
+        return unwrap(await queryEntitlementAccess(this._client, request, options));
     }
 }

package/dist/sdk/invoices.d.ts

@@ -0,0 +1,127 @@
+import { type Client } from '../core.js';
+import { type RequestOptions } from '../lib/types.js';
+import type { ListInvoicesRequest, ListInvoicesResponse, GetInvoiceRequest, GetInvoiceResponse, UpdateInvoiceRequest, UpdateInvoiceResponse, DeleteInvoiceRequest, DeleteInvoiceResponse, AdvanceInvoiceRequest, AdvanceInvoiceResponse, ApproveInvoiceRequest, ApproveInvoiceResponse, RetryInvoiceRequest, RetryInvoiceResponse, SnapshotQuantitiesInvoiceRequest, SnapshotQuantitiesInvoiceResponse } from '../models/operations/invoices.js';
+import type { Invoice } from '../models/types.js';
+export declare class Invoices {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * List billing invoices
+     *
+     * List billing invoices.
+     *
+     * Returns a page of invoices. Gathering invoices are never included. Use `filter`
+     * to narrow by status, customer, dates, or service period start. Use `sort` to
+     * control ordering.
+     *
+     * GET /openmeter/billing/invoices
+     */
+    list(request?: ListInvoicesRequest, options?: RequestOptions): Promise<ListInvoicesResponse>;
+    /**
+     * List billing invoices
+     *
+     * List billing invoices.
+     *
+     * Returns a page of invoices. Gathering invoices are never included. Use `filter`
+     * to narrow by status, customer, dates, or service period start. Use `sort` to
+     * control ordering.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/billing/invoices
+     */
+    listAll(request?: ListInvoicesRequest, options?: RequestOptions): AsyncIterable<Invoice>;
+    /**
+     * Get a billing invoice
+     *
+     * Get a billing invoice by ID.
+     *
+     * Returns the full invoice resource including line items, status details, totals,
+     * and workflow configuration snapshot.
+     *
+     * GET /openmeter/billing/invoices/{invoiceId}
+     */
+    get(request: GetInvoiceRequest, options?: RequestOptions): Promise<GetInvoiceResponse>;
+    /**
+     * Update a billing invoice
+     *
+     * Update a billing invoice.
+     *
+     * Only the mutable fields of the invoice can be edited: description, labels,
+     * supplier, customer, workflow settings, and top-level lines. Top-level lines are
+     * matched by `id`; lines without an `id` are created, and existing lines omitted
+     * from `lines` are deleted. Detailed (child) lines are always computed and cannot
+     * be edited directly. Only invoices in draft status can be updated.
+     *
+     * PUT /openmeter/billing/invoices/{invoiceId}
+     */
+    update(request: UpdateInvoiceRequest, options?: RequestOptions): Promise<UpdateInvoiceResponse>;
+    /**
+     * Delete a billing invoice
+     *
+     * Delete a billing invoice.
+     *
+     * Only standard invoices in draft status can be deleted. Deleting an invoice will
+     * also delete all associated line items and workflow configuration.
+     *
+     * DELETE /openmeter/billing/invoices/{invoiceId}
+     */
+    delete(request: DeleteInvoiceRequest, options?: RequestOptions): Promise<DeleteInvoiceResponse>;
+    /**
+     * Advance billing invoice's next status
+     *
+     * Advance a billing invoice.
+     *
+     * Advances the invoice to the next workflow state. The next state is determined by
+     * the invoice's current status and workflow configuration. Only invoices in draft
+     * or issued status can be advanced.
+     *
+     * POST /openmeter/billing/invoices/{invoiceId}/advance
+     */
+    advance(request: AdvanceInvoiceRequest, options?: RequestOptions): Promise<AdvanceInvoiceResponse>;
+    /**
+     * Send the invoice to the customer
+     *
+     * Approve a billing invoice.
+     *
+     * This call instantly sends the invoice to the customer using the configured
+     * billing profile app.
+     *
+     * This call is valid in two invoice statuses:
+     *
+     * - draft: the invoice will be sent to the customer, the invoice state becomes
+     * issued
+     * - manual_approval_needed: the invoice will be sent to the customer, the invoice
+     * state becomes issued
+     *
+     * POST /openmeter/billing/invoices/{invoiceId}/approve
+     */
+    approve(request: ApproveInvoiceRequest, options?: RequestOptions): Promise<ApproveInvoiceResponse>;
+    /**
+     * Retry advancing the invoice after a failed attempt
+     *
+     * Retry sending a billing invoice.
+     *
+     * Retry advancing the invoice after a failed attempt.
+     *
+     * The action can be called when the invoice's statusDetails' actions field contain
+     * the "retry" action.
+     *
+     * POST /openmeter/billing/invoices/{invoiceId}/retry
+     */
+    retry(request: RetryInvoiceRequest, options?: RequestOptions): Promise<RetryInvoiceResponse>;
+    /**
+     * Snapshot quantities for usage based line items
+     *
+     * Snapshot quantities for usage-based line items.
+     *
+     * This call will snapshot the quantities for all usage based line items in the
+     * invoice.
+     *
+     * This call is only valid in draft.waiting_for_collection status, where the
+     * collection period can be skipped using this action.
+     *
+     * POST /openmeter/billing/invoices/{invoiceId}/snapshot-quantities
+     */
+    snapshotQuantities(request: SnapshotQuantitiesInvoiceRequest, options?: RequestOptions): Promise<SnapshotQuantitiesInvoiceResponse>;
+}