@openmeter/client 1.0.0-beta.230 → 1.0.0-beta.232

package/dist/sdk/events.d.ts

@@ -1,10 +1,34 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
 import type { ListMeteringEventsRequest, ListMeteringEventsResponse, IngestMeteringEventsRequest, IngestMeteringEventsResponse } from '../models/operations/events.js';
+import type { IngestedEvent } from '../models/types.js';
 export declare class Events {
     private readonly _client;
     constructor(_client: Client);
+    /**
+     * List metering events
+     *
+     * List ingested events.
+     *
+     * GET /openmeter/events
+     */
     list(request?: ListMeteringEventsRequest, options?: RequestOptions): Promise<ListMeteringEventsResponse>;
+    /**
+     * List metering events
+     *
+     * List ingested events.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/events
+     */
+    listAll(request?: ListMeteringEventsRequest, options?: RequestOptions): AsyncIterable<IngestedEvent>;
+    /**
+     * Ingest metering events
+     *
+     * Ingests an event or batch of events following the CloudEvents specification.
+     *
+     * POST /openmeter/events
+     */
     ingest(request: IngestMeteringEventsRequest, options?: RequestOptions): Promise<IngestMeteringEventsResponse>;
 }
-//# sourceMappingURL=events.d.ts.map

package/dist/sdk/events.js

@@ -1,15 +1,42 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
+import { paginateCursor } from '../lib/paginate.js';
 import { listMeteringEvents, ingestMeteringEvents } from '../funcs/events.js';
 export class Events {
     _client;
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * List metering events
+     *
+     * List ingested events.
+     *
+     * GET /openmeter/events
+     */
     async list(request, options) {
         return unwrap(await listMeteringEvents(this._client, request, options));
     }
+    /**
+     * List metering events
+     *
+     * List ingested events.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/events
+     */
+    listAll(request, options) {
+        return paginateCursor((req, opts) => listMeteringEvents(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Ingest metering events
+     *
+     * Ingests an event or batch of events following the CloudEvents specification.
+     *
+     * POST /openmeter/events
+     */
     async ingest(request, options) {
         return unwrap(await ingestMeteringEvents(this._client, request, options));
     }
 }
-//# sourceMappingURL=events.js.map

package/dist/sdk/features.d.ts

@@ -1,14 +1,66 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
 import type { ListFeaturesRequest, ListFeaturesResponse, CreateFeatureRequest, CreateFeatureResponse, GetFeatureRequest, GetFeatureResponse, UpdateFeatureRequest, UpdateFeatureResponse, DeleteFeatureRequest, DeleteFeatureResponse, QueryFeatureCostRequest, QueryFeatureCostResponse } from '../models/operations/features.js';
+import type { Feature } from '../models/types.js';
 export declare class Features {
     private readonly _client;
     constructor(_client: Client);
+    /**
+     * List features
+     *
+     * List all features.
+     *
+     * GET /openmeter/features
+     */
     list(request?: ListFeaturesRequest, options?: RequestOptions): Promise<ListFeaturesResponse>;
+    /**
+     * List features
+     *
+     * List all features.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/features
+     */
+    listAll(request?: ListFeaturesRequest, options?: RequestOptions): AsyncIterable<Feature>;
+    /**
+     * Create feature
+     *
+     * Create a feature.
+     *
+     * POST /openmeter/features
+     */
     create(request: CreateFeatureRequest, options?: RequestOptions): Promise<CreateFeatureResponse>;
+    /**
+     * Get feature
+     *
+     * Get a feature by id.
+     *
+     * GET /openmeter/features/{featureId}
+     */
     get(request: GetFeatureRequest, options?: RequestOptions): Promise<GetFeatureResponse>;
+    /**
+     * Update feature
+     *
+     * Update a feature by id. Currently only the unit_cost field can be updated.
+     *
+     * PATCH /openmeter/features/{featureId}
+     */
     update(request: UpdateFeatureRequest, options?: RequestOptions): Promise<UpdateFeatureResponse>;
+    /**
+     * Delete feature
+     *
+     * Delete a feature by id.
+     *
+     * DELETE /openmeter/features/{featureId}
+     */
     delete(request: DeleteFeatureRequest, options?: RequestOptions): Promise<DeleteFeatureResponse>;
+    /**
+     * Query feature cost
+     *
+     * Query the cost of a feature.
+     *
+     * POST /openmeter/features/{featureId}/cost/query
+     */
     queryCost(request: QueryFeatureCostRequest, options?: RequestOptions): Promise<QueryFeatureCostResponse>;
 }
-//# sourceMappingURL=features.d.ts.map

package/dist/sdk/features.js

@@ -1,27 +1,82 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
+import { paginatePages } from '../lib/paginate.js';
 import { listFeatures, createFeature, getFeature, updateFeature, deleteFeature, queryFeatureCost, } from '../funcs/features.js';
 export class Features {
     _client;
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * List features
+     *
+     * List all features.
+     *
+     * GET /openmeter/features
+     */
     async list(request, options) {
         return unwrap(await listFeatures(this._client, request, options));
     }
+    /**
+     * List features
+     *
+     * List all features.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/features
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listFeatures(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Create feature
+     *
+     * Create a feature.
+     *
+     * POST /openmeter/features
+     */
     async create(request, options) {
         return unwrap(await createFeature(this._client, request, options));
     }
+    /**
+     * Get feature
+     *
+     * Get a feature by id.
+     *
+     * GET /openmeter/features/{featureId}
+     */
     async get(request, options) {
         return unwrap(await getFeature(this._client, request, options));
     }
+    /**
+     * Update feature
+     *
+     * Update a feature by id. Currently only the unit_cost field can be updated.
+     *
+     * PATCH /openmeter/features/{featureId}
+     */
     async update(request, options) {
         return unwrap(await updateFeature(this._client, request, options));
     }
+    /**
+     * Delete feature
+     *
+     * Delete a feature by id.
+     *
+     * DELETE /openmeter/features/{featureId}
+     */
     async delete(request, options) {
         return unwrap(await deleteFeature(this._client, request, options));
     }
+    /**
+     * Query feature cost
+     *
+     * Query the cost of a feature.
+     *
+     * POST /openmeter/features/{featureId}/cost/query
+     */
     async queryCost(request, options) {
         return unwrap(await queryFeatureCost(this._client, request, options));
     }
 }
-//# sourceMappingURL=features.js.map

package/dist/sdk/internal.d.ts

@@ -0,0 +1,328 @@
+import { type Client } from '../core.js';
+import { type RequestOptions } from '../lib/types.js';
+import type { CreateSubscriptionAddonRequest, CreateSubscriptionAddonResponse } from '../models/operations/subscriptions.js';
+import type { ListAppsRequest, ListAppsResponse, GetAppRequest, GetAppResponse, 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 { ListCurrenciesRequest, ListCurrenciesResponse, CreateCustomCurrencyRequest, CreateCustomCurrencyResponse, GetCustomCurrencyRequest, GetCustomCurrencyResponse, ListCostBasesRequest, ListCostBasesResponse, CreateCostBasisRequest, CreateCostBasisResponse } from '../models/operations/currencies.js';
+import type { QueryGovernanceAccessRequest, QueryGovernanceAccessResponse } from '../models/operations/governance.js';
+import type { App, AppCatalogItem, CostBasis, Currency, Invoice } 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
+ * can change or be removed without notice or semver consideration.
+ */
+export declare class Internal {
+    private readonly _client;
+    constructor(_client: Client);
+    private _subscriptions?;
+    get subscriptions(): InternalSubscriptions;
+    private _apps?;
+    get apps(): InternalApps;
+    private _invoices?;
+    get invoices(): InternalInvoices;
+    private _currencies?;
+    get currencies(): InternalCurrencies;
+    private _governance?;
+    get governance(): InternalGovernance;
+}
+export declare class InternalSubscriptions {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * Create a new subscription add-on
+     *
+     * Add add-on to a subscription.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/addons
+     */
+    createAddon(request: CreateSubscriptionAddonRequest, options?: RequestOptions): Promise<CreateSubscriptionAddonResponse>;
+}
+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>;
+    /**
+     * Get app
+     *
+     * Get an installed app.
+     *
+     * GET /openmeter/apps/{appId}
+     */
+    get(request: GetAppRequest, options?: RequestOptions): Promise<GetAppResponse>;
+    /**
+     * 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
+     *
+     * Get an app catalog item by type.
+     *
+     * GET /openmeter/app-catalog/{appType}
+     */
+    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;
+    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>;
+}
+export declare class InternalCurrencies {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * List currencies
+     *
+     * List currencies supported by the billing system.
+     *
+     * GET /openmeter/currencies
+     */
+    list(request?: ListCurrenciesRequest, options?: RequestOptions): Promise<ListCurrenciesResponse>;
+    /**
+     * List currencies
+     *
+     * List currencies supported by the billing system.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/currencies
+     */
+    listAll(request?: ListCurrenciesRequest, options?: RequestOptions): AsyncIterable<Currency>;
+    /**
+     * Create custom currency
+     *
+     * Create a custom currency. This operation allows defining your own custom
+     * currency for billing purposes.
+     *
+     * 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
+     *
+     * List cost bases for a currency. For custom currencies, there can be multiple
+     * cost bases with different `effective_from` dates.
+     *
+     * GET /openmeter/currencies/custom/{currencyId}/cost-bases
+     */
+    listCostBases(request: ListCostBasesRequest, options?: RequestOptions): Promise<ListCostBasesResponse>;
+    /**
+     * List cost bases
+     *
+     * List cost bases for a currency. For custom currencies, there can be multiple
+     * cost bases with different `effective_from` dates.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/currencies/custom/{currencyId}/cost-bases
+     */
+    listCostBasesAll(request: ListCostBasesRequest, options?: RequestOptions): AsyncIterable<CostBasis>;
+    /**
+     * Create cost basis
+     *
+     * Create a cost basis for a currency.
+     *
+     * POST /openmeter/currencies/custom/{currencyId}/cost-bases
+     */
+    createCostBasis(request: CreateCostBasisRequest, options?: RequestOptions): Promise<CreateCostBasisResponse>;
+}
+export declare class InternalGovernance {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * Query governance access
+     *
+     * Query feature access for a list of customers.
+     *
+     * The endpoint resolves each provided identifier to a customer and returns the
+     * access status for the requested features, plus optional credit balance
+     * availability.
+     *
+     * _Designed to be called on a fixed refresh interval and the query response is
+     * intended to be cached._
+     *
+     * POST /openmeter/governance/query
+     */
+    queryAccess(request: QueryGovernanceAccessRequest, options?: RequestOptions): Promise<QueryGovernanceAccessResponse>;
+}