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

package/dist/sdk/internal.d.ts

@@ -1,10 +1,14 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
-import type { CreateSubscriptionAddonRequest, CreateSubscriptionAddonResponse } from '../models/operations/subscriptions.js';
-import type { ListInvoicesRequest, ListInvoicesResponse, GetInvoiceRequest, GetInvoiceResponse, UpdateInvoiceRequest, UpdateInvoiceResponse, DeleteInvoiceRequest, DeleteInvoiceResponse } from '../models/operations/invoices.js';
-import type { ListCurrenciesRequest, ListCurrenciesResponse, CreateCustomCurrencyRequest, CreateCustomCurrencyResponse, ListCostBasesRequest, ListCostBasesResponse, CreateCostBasisRequest, CreateCostBasisResponse } from '../models/operations/currencies.js';
-import type { QueryGovernanceAccessRequest, QueryGovernanceAccessResponse } from '../models/operations/governance.js';
-import type { CostBasis, Currency, Invoice } from '../models/types.js';
+import type { VoidCreditGrantRequest, VoidCreditGrantResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
+import type { UnscheduleSubscriptionRequest, UnscheduleSubscriptionResponse, RestoreSubscriptionRequest, RestoreSubscriptionResponse, MigrateSubscriptionRequest, MigrateSubscriptionResponse, UpdateSubscriptionAddonRequest, UpdateSubscriptionAddonResponse } from '../models/operations/subscriptions.js';
+import type { ListAppsRequest, ListAppsResponse, UninstallAppRequest, UninstallAppResponse, UpdateAppRequest, UpdateAppResponse, ListAppCatalogRequest, ListAppCatalogResponse, GetAppCatalogItemRequest, GetAppCatalogItemResponse, InstallAppRequest, InstallAppResponse } from '../models/operations/apps.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 { ListChargesRequest, ListChargesResponse } from '../models/operations/charges.js';
+import type { ListCurrenciesRequest, ListCurrenciesResponse, CreateCustomCurrencyRequest, CreateCustomCurrencyResponse, GetCustomCurrencyRequest, GetCustomCurrencyResponse, ListCostBasesRequest, ListCostBasesResponse, CreateCostBasisRequest, CreateCostBasisResponse } from '../models/operations/currencies.js';
+import type { ListPlanAddonsRequest, ListPlanAddonsResponse } from '../models/operations/planAddons.js';
+import type { QueryEntitlementAccessRequest, QueryEntitlementAccessResponse } from '../models/operations/entitlementAccess.js';
+import type { App, AppCatalogItem, Charge, CostBasis, Currency, Invoice, PlanAddon } from '../models/types.js';
 /**
  * Operations marked internal in the API definition. They are not part of
  * the customer surface: they may require additional permissions, and they
@@ -13,26 +17,216 @@ import type { CostBasis, Currency, Invoice } from '../models/types.js';
 export declare class Internal {
     private readonly _client;
     constructor(_client: Client);
+    private _customers?;
+    get customers(): InternalCustomers;
     private _subscriptions?;
     get subscriptions(): InternalSubscriptions;
+    private _apps?;
+    get apps(): InternalApps;
     private _invoices?;
     get invoices(): InternalInvoices;
+    private _charges?;
+    get charges(): InternalCharges;
     private _currencies?;
     get currencies(): InternalCurrencies;
-    private _governance?;
-    get governance(): InternalGovernance;
+    private _planAddons?;
+    get planAddons(): InternalPlanAddons;
+    private _entitlementAccess?;
+    get entitlementAccess(): InternalEntitlementAccess;
+}
+export declare class InternalCustomers {
+    private readonly _client;
+    constructor(_client: Client);
+    private _credits?;
+    get credits(): InternalCustomersCredits;
+    private _charges?;
+    get charges(): InternalCustomersCharges;
+}
+export declare class InternalCustomersCredits {
+    private readonly _client;
+    constructor(_client: Client);
+    private _grants?;
+    get grants(): InternalCustomersCreditsGrants;
+}
+export declare class InternalCustomersCreditsGrants {
+    private readonly _client;
+    constructor(_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
+     */
+    void(request: VoidCreditGrantRequest, options?: RequestOptions): Promise<VoidCreditGrantResponse>;
+}
+export declare class InternalCustomersCharges {
+    private readonly _client;
+    constructor(_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
+     */
+    list(request: ListCustomerChargesRequest, options?: RequestOptions): Promise<ListCustomerChargesResponse>;
+    /**
+     * 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: ListCustomerChargesRequest, options?: RequestOptions): AsyncIterable<Charge>;
+    /**
+     * Create customer charge
+     *
+     * Create customer charge.
+     *
+     * POST /openmeter/customers/{customerId}/charges
+     */
+    create(request: CreateCustomerChargesRequest, options?: RequestOptions): Promise<CreateCustomerChargesResponse>;
 }
 export declare class InternalSubscriptions {
     private readonly _client;
     constructor(_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
+     */
+    unschedule(request: UnscheduleSubscriptionRequest, options?: RequestOptions): Promise<UnscheduleSubscriptionResponse>;
+    /**
+     * 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
+     */
+    restore(request: RestoreSubscriptionRequest, options?: RequestOptions): Promise<RestoreSubscriptionResponse>;
+    /**
+     * 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
+     */
+    migrate(request: MigrateSubscriptionRequest, options?: RequestOptions): Promise<MigrateSubscriptionResponse>;
+    /**
+     * 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}
+     */
+    updateAddon(request: UpdateSubscriptionAddonRequest, options?: RequestOptions): Promise<UpdateSubscriptionAddonResponse>;
+}
+export declare class InternalApps {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * List apps
+     *
+     * List installed apps.
+     *
+     * GET /openmeter/apps
+     */
+    list(request?: ListAppsRequest, options?: RequestOptions): Promise<ListAppsResponse>;
+    /**
+     * List apps
+     *
+     * List installed apps.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/apps
+     */
+    listAll(request?: ListAppsRequest, options?: RequestOptions): AsyncIterable<App>;
+    /**
+     * Uninstall app
+     *
+     * Uninstall an app by ID.
+     *
+     * DELETE /openmeter/apps/{appId}
+     */
+    uninstall(request: UninstallAppRequest, options?: RequestOptions): Promise<UninstallAppResponse>;
+    /**
+     * Update app
+     *
+     * Update an installed app.
+     *
+     * PUT /openmeter/apps/{appId}
+     */
+    update(request: UpdateAppRequest, options?: RequestOptions): Promise<UpdateAppResponse>;
+    /**
+     * List app catalog
+     *
+     * List available apps.
+     *
+     * GET /openmeter/app-catalog
+     */
+    listCatalog(request?: ListAppCatalogRequest, options?: RequestOptions): Promise<ListAppCatalogResponse>;
+    /**
+     * 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?: ListAppCatalogRequest, options?: RequestOptions): AsyncIterable<AppCatalogItem>;
+    /**
+     * Get app catalog item by type
      *
-     * Add add-on to a subscription.
+     * Get an app catalog item by type.
      *
-     * POST /openmeter/subscriptions/{subscriptionId}/addons
+     * GET /openmeter/app-catalog/{appType}
      */
-    createAddon(request: CreateSubscriptionAddonRequest, options?: RequestOptions): Promise<CreateSubscriptionAddonResponse>;
+    getCatalogItem(request: GetAppCatalogItemRequest, options?: RequestOptions): Promise<GetAppCatalogItemResponse>;
+    /**
+     * Install app from the catalog
+     *
+     * Install an app from the catalog.
+     *
+     * POST /openmeter/app-catalog/install
+     */
+    install(request: InstallAppRequest, options?: RequestOptions): Promise<InstallAppResponse>;
 }
 export declare class InternalInvoices {
     private readonly _client;
@@ -99,6 +293,91 @@ export declare class InternalInvoices {
      * 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>;
+}
+export declare class InternalCharges {
+    private readonly _client;
+    constructor(_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
+     */
+    list(request?: ListChargesRequest, options?: RequestOptions): Promise<ListChargesResponse>;
+    /**
+     * 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?: ListChargesRequest, options?: RequestOptions): AsyncIterable<Charge>;
 }
 export declare class InternalCurrencies {
     private readonly _client;
@@ -130,6 +409,14 @@ export declare class InternalCurrencies {
      * POST /openmeter/currencies/custom
      */
     createCustomCurrency(request: CreateCustomCurrencyRequest, options?: RequestOptions): Promise<CreateCustomCurrencyResponse>;
+    /**
+     * Get custom currency
+     *
+     * Get a custom currency.
+     *
+     * GET /openmeter/currencies/custom/{currencyId}
+     */
+    getCustomCurrency(request: GetCustomCurrencyRequest, options?: RequestOptions): Promise<GetCustomCurrencyResponse>;
     /**
      * List cost bases
      *
@@ -159,11 +446,33 @@ export declare class InternalCurrencies {
      */
     createCostBasis(request: CreateCostBasisRequest, options?: RequestOptions): Promise<CreateCostBasisResponse>;
 }
-export declare class InternalGovernance {
+export declare class InternalPlanAddons {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * List add-ons for plan
+     *
+     * List add-ons associated with a plan.
+     *
+     * GET /openmeter/plans/{planId}/addons
+     */
+    list(request: ListPlanAddonsRequest, options?: RequestOptions): Promise<ListPlanAddonsResponse>;
+    /**
+     * 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: ListPlanAddonsRequest, options?: RequestOptions): AsyncIterable<PlanAddon>;
+}
+export declare class InternalEntitlementAccess {
     private readonly _client;
     constructor(_client: Client);
     /**
-     * Query governance access
+     * Query entitlement access
      *
      * Query feature access for a list of customers.
      *
@@ -174,7 +483,7 @@ export declare 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
      */
-    queryAccess(request: QueryGovernanceAccessRequest, options?: RequestOptions): Promise<QueryGovernanceAccessResponse>;
+    query(request: QueryEntitlementAccessRequest, options?: RequestOptions): Promise<QueryEntitlementAccessResponse>;
 }