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

package/dist/funcs/invoices.d.ts

@@ -1,8 +1,51 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListInvoicesRequest, ListInvoicesResponse, GetInvoiceRequest, GetInvoiceResponse, UpdateInvoiceRequest, UpdateInvoiceResponse, DeleteInvoiceRequest, DeleteInvoiceResponse } from '../models/operations/invoices.js';
+/**
+ * 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
+ */
 export declare function listInvoices(client: Client, req?: ListInvoicesRequest, options?: RequestOptions): Promise<Result<ListInvoicesResponse>>;
+/**
+ * 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}
+ */
 export declare function getInvoice(client: Client, req: GetInvoiceRequest, options?: RequestOptions): Promise<Result<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}
+ */
 export declare function updateInvoice(client: Client, req: UpdateInvoiceRequest, options?: RequestOptions): Promise<Result<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}
+ */
 export declare function deleteInvoice(client: Client, req: DeleteInvoiceRequest, options?: RequestOptions): Promise<Result<DeleteInvoiceResponse>>;
-//# sourceMappingURL=invoices.d.ts.map

package/dist/funcs/invoices.js

@@ -1,8 +1,20 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
 import { toURLSearchParams, encodeSort } from '../lib/encodings.js';
 import { toWire, fromWire, assertValid, toSnakeCase } from '../lib/wire.js';
 import * as schemas from '../models/schemas.js';
+/**
+ * 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
+ */
 export function listInvoices(client, req = {}, options) {
     return request(() => {
         const query = toWire({
@@ -25,6 +37,16 @@ export function listInvoices(client, req = {}, 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}
+ */
 export function getInvoice(client, req, options) {
     return request(() => {
         const path = `openmeter/billing/invoices/${(() => {
@@ -44,6 +66,19 @@ export function getInvoice(client, req, 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}
+ */
 export function updateInvoice(client, req, options) {
     return request(() => {
         const path = `openmeter/billing/invoices/${(() => {
@@ -67,6 +102,16 @@ export function updateInvoice(client, req, 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}
+ */
 export function deleteInvoice(client, req, options) {
     return request(async () => {
         const path = `openmeter/billing/invoices/${(() => {
@@ -78,4 +123,3 @@ export function deleteInvoice(client, req, options) {
         await http(client).delete(path, options);
     });
 }
-//# sourceMappingURL=invoices.js.map

package/dist/funcs/llmCost.d.ts

@@ -1,9 +1,44 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListLlmCostPricesRequest, ListLlmCostPricesResponse, GetLlmCostPriceRequest, GetLlmCostPriceResponse, ListLlmCostOverridesRequest, ListLlmCostOverridesResponse, CreateLlmCostOverrideRequest, CreateLlmCostOverrideResponse, DeleteLlmCostOverrideRequest, DeleteLlmCostOverrideResponse } from '../models/operations/llmCost.js';
+/**
+ * List LLM cost prices
+ *
+ * List global LLM cost prices. Returns prices with overrides applied if any.
+ *
+ * GET /openmeter/llm-cost/prices
+ */
 export declare function listLlmCostPrices(client: Client, req?: ListLlmCostPricesRequest, options?: RequestOptions): Promise<Result<ListLlmCostPricesResponse>>;
+/**
+ * Get LLM cost price
+ *
+ * Get a specific LLM cost price by ID. Returns the price with overrides applied if
+ * any.
+ *
+ * GET /openmeter/llm-cost/prices/{priceId}
+ */
 export declare function getLlmCostPrice(client: Client, req: GetLlmCostPriceRequest, options?: RequestOptions): Promise<Result<GetLlmCostPriceResponse>>;
+/**
+ * List LLM cost overrides
+ *
+ * List per-namespace price overrides.
+ *
+ * GET /openmeter/llm-cost/overrides
+ */
 export declare function listLlmCostOverrides(client: Client, req?: ListLlmCostOverridesRequest, options?: RequestOptions): Promise<Result<ListLlmCostOverridesResponse>>;
+/**
+ * Create LLM cost override
+ *
+ * Create a per-namespace price override.
+ *
+ * POST /openmeter/llm-cost/overrides
+ */
 export declare function createLlmCostOverride(client: Client, req: CreateLlmCostOverrideRequest, options?: RequestOptions): Promise<Result<CreateLlmCostOverrideResponse>>;
+/**
+ * Delete LLM cost override
+ *
+ * Delete a per-namespace price override.
+ *
+ * DELETE /openmeter/llm-cost/overrides/{priceId}
+ */
 export declare function deleteLlmCostOverride(client: Client, req: DeleteLlmCostOverrideRequest, options?: RequestOptions): Promise<Result<DeleteLlmCostOverrideResponse>>;
-//# sourceMappingURL=llmCost.d.ts.map

package/dist/funcs/llmCost.js

@@ -1,8 +1,16 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
 import { toURLSearchParams, encodeSort } from '../lib/encodings.js';
 import { toWire, fromWire, assertValid, toSnakeCase } from '../lib/wire.js';
 import * as schemas from '../models/schemas.js';
+/**
+ * List LLM cost prices
+ *
+ * List global LLM cost prices. Returns prices with overrides applied if any.
+ *
+ * GET /openmeter/llm-cost/prices
+ */
 export function listLlmCostPrices(client, req = {}, options) {
     return request(() => {
         const query = toWire({
@@ -25,6 +33,14 @@ export function listLlmCostPrices(client, req = {}, options) {
         });
     });
 }
+/**
+ * Get LLM cost price
+ *
+ * Get a specific LLM cost price by ID. Returns the price with overrides applied if
+ * any.
+ *
+ * GET /openmeter/llm-cost/prices/{priceId}
+ */
 export function getLlmCostPrice(client, req, options) {
     return request(() => {
         const path = `openmeter/llm-cost/prices/${(() => {
@@ -44,6 +60,13 @@ export function getLlmCostPrice(client, req, options) {
         });
     });
 }
+/**
+ * List LLM cost overrides
+ *
+ * List per-namespace price overrides.
+ *
+ * GET /openmeter/llm-cost/overrides
+ */
 export function listLlmCostOverrides(client, req = {}, options) {
     return request(() => {
         const query = toWire({
@@ -65,6 +88,13 @@ export function listLlmCostOverrides(client, req = {}, options) {
         });
     });
 }
+/**
+ * Create LLM cost override
+ *
+ * Create a per-namespace price override.
+ *
+ * POST /openmeter/llm-cost/overrides
+ */
 export function createLlmCostOverride(client, req, options) {
     return request(() => {
         const body = toWire(req, schemas.createLlmCostOverrideBody);
@@ -82,6 +112,13 @@ export function createLlmCostOverride(client, req, options) {
         });
     });
 }
+/**
+ * Delete LLM cost override
+ *
+ * Delete a per-namespace price override.
+ *
+ * DELETE /openmeter/llm-cost/overrides/{priceId}
+ */
 export function deleteLlmCostOverride(client, req, options) {
     return request(async () => {
         const path = `openmeter/llm-cost/overrides/${(() => {
@@ -93,4 +130,3 @@ export function deleteLlmCostOverride(client, req, options) {
         await http(client).delete(path, options);
     });
 }
-//# sourceMappingURL=llmCost.js.map

package/dist/funcs/meters.d.ts

@@ -1,11 +1,63 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { CreateMeterRequest, CreateMeterResponse, GetMeterRequest, GetMeterResponse, ListMetersRequest, ListMetersResponse, UpdateMeterRequest, UpdateMeterResponse, DeleteMeterRequest, DeleteMeterResponse, QueryMeterRequest, QueryMeterResponse, QueryMeterCsvRequest, QueryMeterCsvResponse } from '../models/operations/meters.js';
+/**
+ * Create meter
+ *
+ * Create a meter.
+ *
+ * POST /openmeter/meters
+ */
 export declare function createMeter(client: Client, req: CreateMeterRequest, options?: RequestOptions): Promise<Result<CreateMeterResponse>>;
+/**
+ * Get meter
+ *
+ * Get a meter by ID.
+ *
+ * GET /openmeter/meters/{meterId}
+ */
 export declare function getMeter(client: Client, req: GetMeterRequest, options?: RequestOptions): Promise<Result<GetMeterResponse>>;
+/**
+ * List meters
+ *
+ * List meters.
+ *
+ * GET /openmeter/meters
+ */
 export declare function listMeters(client: Client, req?: ListMetersRequest, options?: RequestOptions): Promise<Result<ListMetersResponse>>;
+/**
+ * Update meter
+ *
+ * Update a meter.
+ *
+ * PUT /openmeter/meters/{meterId}
+ */
 export declare function updateMeter(client: Client, req: UpdateMeterRequest, options?: RequestOptions): Promise<Result<UpdateMeterResponse>>;
+/**
+ * Delete meter
+ *
+ * Delete a meter.
+ *
+ * DELETE /openmeter/meters/{meterId}
+ */
 export declare function deleteMeter(client: Client, req: DeleteMeterRequest, options?: RequestOptions): Promise<Result<DeleteMeterResponse>>;
+/**
+ * Query meter
+ *
+ * Query a meter for usage.
+ *
+ * Set `Accept: application/json` (the default) to get a structured JSON response.
+ * Set `Accept: text/csv` to download the same data as a CSV file suitable for
+ * spreadsheets. The CSV columns, in order, are:
+ *
+ * `from, to, [subject,] [customer_id, customer_key, customer_name,] <dimensions...>, value`
+ *
+ * The `subject` column is emitted only when `subject` is in the query's
+ * `group_by_dimensions`. The three `customer_*` columns are emitted together only
+ * when `customer_id` is in the query's `group_by_dimensions`.
+ *
+ * POST /openmeter/meters/{meterId}/query
+ */
 export declare function queryMeter(client: Client, req: QueryMeterRequest, options?: RequestOptions): Promise<Result<QueryMeterResponse>>;
+/** POST /openmeter/meters/{meterId}/query */
 export declare function queryMeterCsv(client: Client, req: QueryMeterCsvRequest, options?: RequestOptions): Promise<Result<QueryMeterCsvResponse>>;
-//# sourceMappingURL=meters.d.ts.map

package/dist/funcs/meters.js

@@ -1,8 +1,16 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
 import { toURLSearchParams, encodeSort } from '../lib/encodings.js';
 import { toWire, fromWire, assertValid, toSnakeCase } from '../lib/wire.js';
 import * as schemas from '../models/schemas.js';
+/**
+ * Create meter
+ *
+ * Create a meter.
+ *
+ * POST /openmeter/meters
+ */
 export function createMeter(client, req, options) {
     return request(() => {
         const body = toWire(req, schemas.createMeterBody);
@@ -20,6 +28,13 @@ export function createMeter(client, req, options) {
         });
     });
 }
+/**
+ * Get meter
+ *
+ * Get a meter by ID.
+ *
+ * GET /openmeter/meters/{meterId}
+ */
 export function getMeter(client, req, options) {
     return request(() => {
         const path = `openmeter/meters/${(() => {
@@ -39,6 +54,13 @@ export function getMeter(client, req, options) {
         });
     });
 }
+/**
+ * List meters
+ *
+ * List meters.
+ *
+ * GET /openmeter/meters
+ */
 export function listMeters(client, req = {}, options) {
     return request(() => {
         const query = toWire({
@@ -61,6 +83,13 @@ export function listMeters(client, req = {}, options) {
         });
     });
 }
+/**
+ * Update meter
+ *
+ * Update a meter.
+ *
+ * PUT /openmeter/meters/{meterId}
+ */
 export function updateMeter(client, req, options) {
     return request(() => {
         const path = `openmeter/meters/${(() => {
@@ -84,6 +113,13 @@ export function updateMeter(client, req, options) {
         });
     });
 }
+/**
+ * Delete meter
+ *
+ * Delete a meter.
+ *
+ * DELETE /openmeter/meters/{meterId}
+ */
 export function deleteMeter(client, req, options) {
     return request(async () => {
         const path = `openmeter/meters/${(() => {
@@ -95,6 +131,23 @@ export function deleteMeter(client, req, options) {
         await http(client).delete(path, options);
     });
 }
+/**
+ * Query meter
+ *
+ * Query a meter for usage.
+ *
+ * Set `Accept: application/json` (the default) to get a structured JSON response.
+ * Set `Accept: text/csv` to download the same data as a CSV file suitable for
+ * spreadsheets. The CSV columns, in order, are:
+ *
+ * `from, to, [subject,] [customer_id, customer_key, customer_name,] <dimensions...>, value`
+ *
+ * The `subject` column is emitted only when `subject` is in the query's
+ * `group_by_dimensions`. The three `customer_*` columns are emitted together only
+ * when `customer_id` is in the query's `group_by_dimensions`.
+ *
+ * POST /openmeter/meters/{meterId}/query
+ */
 export function queryMeter(client, req, options) {
     return request(() => {
         const path = `openmeter/meters/${(() => {
@@ -118,6 +171,7 @@ export function queryMeter(client, req, options) {
         });
     });
 }
+/** POST /openmeter/meters/{meterId}/query */
 export function queryMeterCsv(client, req, options) {
     const headers = new Headers(options?.headers);
     headers.set('accept', 'text/csv');
@@ -137,4 +191,3 @@ export function queryMeterCsv(client, req, options) {
             .text();
     });
 }
-//# sourceMappingURL=meters.js.map

package/dist/funcs/planAddons.d.ts

@@ -1,9 +1,43 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListPlanAddonsRequest, ListPlanAddonsResponse, CreatePlanAddonRequest, CreatePlanAddonResponse, GetPlanAddonRequest, GetPlanAddonResponse, UpdatePlanAddonRequest, UpdatePlanAddonResponse, DeletePlanAddonRequest, DeletePlanAddonResponse } from '../models/operations/planAddons.js';
+/**
+ * List add-ons for plan
+ *
+ * List add-ons associated with a plan.
+ *
+ * GET /openmeter/plans/{planId}/addons
+ */
 export declare function listPlanAddons(client: Client, req: ListPlanAddonsRequest, options?: RequestOptions): Promise<Result<ListPlanAddonsResponse>>;
+/**
+ * Add add-on to plan
+ *
+ * Add an add-on to a plan.
+ *
+ * POST /openmeter/plans/{planId}/addons
+ */
 export declare function createPlanAddon(client: Client, req: CreatePlanAddonRequest, options?: RequestOptions): Promise<Result<CreatePlanAddonResponse>>;
+/**
+ * Get add-on association for plan
+ *
+ * Get an add-on association for a plan.
+ *
+ * GET /openmeter/plans/{planId}/addons/{planAddonId}
+ */
 export declare function getPlanAddon(client: Client, req: GetPlanAddonRequest, options?: RequestOptions): Promise<Result<GetPlanAddonResponse>>;
+/**
+ * Update add-on association for plan
+ *
+ * Update an add-on association for a plan.
+ *
+ * PUT /openmeter/plans/{planId}/addons/{planAddonId}
+ */
 export declare function updatePlanAddon(client: Client, req: UpdatePlanAddonRequest, options?: RequestOptions): Promise<Result<UpdatePlanAddonResponse>>;
+/**
+ * Remove add-on from plan
+ *
+ * Remove an add-on from a plan.
+ *
+ * DELETE /openmeter/plans/{planId}/addons/{planAddonId}
+ */
 export declare function deletePlanAddon(client: Client, req: DeletePlanAddonRequest, options?: RequestOptions): Promise<Result<DeletePlanAddonResponse>>;
-//# sourceMappingURL=planAddons.d.ts.map

package/dist/funcs/planAddons.js

@@ -1,8 +1,16 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
 import { toURLSearchParams } from '../lib/encodings.js';
 import { toWire, fromWire, assertValid } from '../lib/wire.js';
 import * as schemas from '../models/schemas.js';
+/**
+ * List add-ons for plan
+ *
+ * List add-ons associated with a plan.
+ *
+ * GET /openmeter/plans/{planId}/addons
+ */
 export function listPlanAddons(client, req, options) {
     return request(() => {
         const path = `openmeter/plans/${(() => {
@@ -29,6 +37,13 @@ export function listPlanAddons(client, req, options) {
         });
     });
 }
+/**
+ * Add add-on to plan
+ *
+ * Add an add-on to a plan.
+ *
+ * POST /openmeter/plans/{planId}/addons
+ */
 export function createPlanAddon(client, req, options) {
     return request(() => {
         const path = `openmeter/plans/${(() => {
@@ -52,6 +67,13 @@ export function createPlanAddon(client, req, options) {
         });
     });
 }
+/**
+ * Get add-on association for plan
+ *
+ * Get an add-on association for a plan.
+ *
+ * GET /openmeter/plans/{planId}/addons/{planAddonId}
+ */
 export function getPlanAddon(client, req, options) {
     return request(() => {
         const path = `openmeter/plans/${(() => {
@@ -76,6 +98,13 @@ export function getPlanAddon(client, req, options) {
         });
     });
 }
+/**
+ * Update add-on association for plan
+ *
+ * Update an add-on association for a plan.
+ *
+ * PUT /openmeter/plans/{planId}/addons/{planAddonId}
+ */
 export function updatePlanAddon(client, req, options) {
     return request(() => {
         const path = `openmeter/plans/${(() => {
@@ -104,6 +133,13 @@ export function updatePlanAddon(client, req, options) {
         });
     });
 }
+/**
+ * Remove add-on from plan
+ *
+ * Remove an add-on from a plan.
+ *
+ * DELETE /openmeter/plans/{planId}/addons/{planAddonId}
+ */
 export function deletePlanAddon(client, req, options) {
     return request(async () => {
         const path = `openmeter/plans/${(() => {
@@ -120,4 +156,3 @@ export function deletePlanAddon(client, req, options) {
         await http(client).delete(path, options);
     });
 }
-//# sourceMappingURL=planAddons.js.map

package/dist/funcs/plans.d.ts

@@ -1,11 +1,59 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListPlansRequest, ListPlansResponse, CreatePlanRequest, CreatePlanResponse, UpdatePlanRequest, UpdatePlanResponse, GetPlanRequest, GetPlanResponse, DeletePlanRequest, DeletePlanResponse, ArchivePlanRequest, ArchivePlanResponse, PublishPlanRequest, PublishPlanResponse } from '../models/operations/plans.js';
+/**
+ * List plans
+ *
+ * List all plans.
+ *
+ * GET /openmeter/plans
+ */
 export declare function listPlans(client: Client, req?: ListPlansRequest, options?: RequestOptions): Promise<Result<ListPlansResponse>>;
+/**
+ * Create plan
+ *
+ * Create a new plan.
+ *
+ * POST /openmeter/plans
+ */
 export declare function createPlan(client: Client, req: CreatePlanRequest, options?: RequestOptions): Promise<Result<CreatePlanResponse>>;
+/**
+ * Update plan
+ *
+ * Update a plan by id.
+ *
+ * PUT /openmeter/plans/{planId}
+ */
 export declare function updatePlan(client: Client, req: UpdatePlanRequest, options?: RequestOptions): Promise<Result<UpdatePlanResponse>>;
+/**
+ * Get plan
+ *
+ * Get a plan by id.
+ *
+ * GET /openmeter/plans/{planId}
+ */
 export declare function getPlan(client: Client, req: GetPlanRequest, options?: RequestOptions): Promise<Result<GetPlanResponse>>;
+/**
+ * Delete plan
+ *
+ * Delete a plan by id.
+ *
+ * DELETE /openmeter/plans/{planId}
+ */
 export declare function deletePlan(client: Client, req: DeletePlanRequest, options?: RequestOptions): Promise<Result<DeletePlanResponse>>;
+/**
+ * Archive plan version
+ *
+ * Archive a plan version.
+ *
+ * POST /openmeter/plans/{planId}/archive
+ */
 export declare function archivePlan(client: Client, req: ArchivePlanRequest, options?: RequestOptions): Promise<Result<ArchivePlanResponse>>;
+/**
+ * Publish plan version
+ *
+ * Publish a plan version.
+ *
+ * POST /openmeter/plans/{planId}/publish
+ */
 export declare function publishPlan(client: Client, req: PublishPlanRequest, options?: RequestOptions): Promise<Result<PublishPlanResponse>>;
-//# sourceMappingURL=plans.d.ts.map