@openmeter/client 1.0.0-beta-637770bdd2e8 → 1.0.0-beta-afebc8f9a2b9

package/dist/sdk/invoices.d.ts

@@ -1,15 +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>;
 }

package/dist/sdk/invoices.js

@@ -1,31 +1,146 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
+import { paginatePages } from '../lib/paginate.js';
 import { listInvoices, getInvoice, updateInvoice, deleteInvoice, advanceInvoice, approveInvoice, retryInvoice, snapshotQuantitiesInvoice, } from '../funcs/invoices.js';
 export class Invoices {
     _client;
     constructor(_client) {
         this._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
+     */
     async list(request, options) {
         return unwrap(await listInvoices(this._client, request, options));
     }
+    /**
+     * 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, options) {
+        return paginatePages((req, opts) => listInvoices(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * 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}
+     */
     async get(request, options) {
         return unwrap(await getInvoice(this._client, request, options));
     }
+    /**
+     * 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}
+     */
     async update(request, options) {
         return unwrap(await updateInvoice(this._client, request, options));
     }
+    /**
+     * 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}
+     */
     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));
     }

package/dist/sdk/sdk.d.ts

@@ -4,6 +4,7 @@ import { Meters } from './meters.js';
 import { Customers } from './customers.js';
 import { Entitlements } from './entitlements.js';
 import { Subscriptions } from './subscriptions.js';
+import { Apps } from './apps.js';
 import { Billing } from './billing.js';
 import { Tax } from './tax.js';
 import { Features } from './features.js';
@@ -24,6 +25,8 @@ export declare class OpenMeter extends Client {
     get entitlements(): Entitlements;
     private _subscriptions?;
     get subscriptions(): Subscriptions;
+    private _apps?;
+    get apps(): Apps;
     private _billing?;
     get billing(): Billing;
     private _tax?;

package/dist/sdk/sdk.js

@@ -5,6 +5,7 @@ import { Meters } from './meters.js';
 import { Customers } from './customers.js';
 import { Entitlements } from './entitlements.js';
 import { Subscriptions } from './subscriptions.js';
+import { Apps } from './apps.js';
 import { Billing } from './billing.js';
 import { Tax } from './tax.js';
 import { Features } from './features.js';
@@ -35,6 +36,10 @@ export class OpenMeter extends Client {
     get subscriptions() {
         return (this._subscriptions ??= new Subscriptions(this));
     }
+    _apps;
+    get apps() {
+        return (this._apps ??= new Apps(this));
+    }
     _billing;
     get billing() {
         return (this._billing ??= new Billing(this));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmeter/client",
-  "version": "1.0.0-beta-637770bdd2e8",
+  "version": "1.0.0-beta-afebc8f9a2b9",
   "description": "Official TypeScript SDK for the OpenMeter API — usage metering and billing",
   "keywords": [
     "openmeter",