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

package/dist/funcs/invoices.js

@@ -1,10 +1,25 @@
+// 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 { toWire, toPathWire, 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(() => {
+        if (client._options.validate && req.sort !== undefined) {
+            assertValid(schemas.listInvoicesQueryParams.shape.sort, req.sort);
+        }
         const query = toWire({
             page: req.page,
             sort: encodeSort(req.sort, toSnakeCase),
@@ -25,13 +40,32 @@ 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 pathParamsInput = {
+            invoiceId: req.invoiceId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getInvoicePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getInvoicePathParamsWire, pathParams);
+        }
         const path = `openmeter/billing/invoices/${(() => {
-            if (req.invoiceId === undefined) {
+            if (pathParams.invoiceId === undefined) {
                 throw new Error('missing path parameter: invoiceId');
             }
-            return encodeURIComponent(String(req.invoiceId));
+            return encodeURIComponent(String(pathParams.invoiceId));
         })()}`;
         return http(client)
             .get(path, options)
@@ -44,13 +78,35 @@ 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 pathParamsInput = {
+            invoiceId: req.invoiceId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.updateInvoicePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.updateInvoicePathParamsWire, pathParams);
+        }
         const path = `openmeter/billing/invoices/${(() => {
-            if (req.invoiceId === undefined) {
+            if (pathParams.invoiceId === undefined) {
                 throw new Error('missing path parameter: invoiceId');
             }
-            return encodeURIComponent(String(req.invoiceId));
+            return encodeURIComponent(String(pathParams.invoiceId));
         })()}`;
         const body = toWire(req.body, schemas.updateInvoiceBody);
         if (client._options.validate) {
@@ -67,15 +123,198 @@ 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 pathParamsInput = {
+            invoiceId: req.invoiceId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.deleteInvoicePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.deleteInvoicePathParamsWire, pathParams);
+        }
         const path = `openmeter/billing/invoices/${(() => {
-            if (req.invoiceId === undefined) {
+            if (pathParams.invoiceId === undefined) {
                 throw new Error('missing path parameter: invoiceId');
             }
-            return encodeURIComponent(String(req.invoiceId));
+            return encodeURIComponent(String(pathParams.invoiceId));
         })()}`;
         await http(client).delete(path, options);
     });
 }
-//# sourceMappingURL=invoices.js.map
+/**
+ * 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
+ */
+export function advanceInvoice(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            invoiceId: req.invoiceId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.advanceInvoicePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.advanceInvoicePathParamsWire, pathParams);
+        }
+        const path = `openmeter/billing/invoices/${(() => {
+            if (pathParams.invoiceId === undefined) {
+                throw new Error('missing path parameter: invoiceId');
+            }
+            return encodeURIComponent(String(pathParams.invoiceId));
+        })()}/advance`;
+        return http(client)
+            .post(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.advanceInvoiceResponseWire, data);
+            }
+            return fromWire(data, schemas.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
+ */
+export function approveInvoice(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            invoiceId: req.invoiceId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.approveInvoicePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.approveInvoicePathParamsWire, pathParams);
+        }
+        const path = `openmeter/billing/invoices/${(() => {
+            if (pathParams.invoiceId === undefined) {
+                throw new Error('missing path parameter: invoiceId');
+            }
+            return encodeURIComponent(String(pathParams.invoiceId));
+        })()}/approve`;
+        return http(client)
+            .post(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.approveInvoiceResponseWire, data);
+            }
+            return fromWire(data, schemas.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
+ */
+export function retryInvoice(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            invoiceId: req.invoiceId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.retryInvoicePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.retryInvoicePathParamsWire, pathParams);
+        }
+        const path = `openmeter/billing/invoices/${(() => {
+            if (pathParams.invoiceId === undefined) {
+                throw new Error('missing path parameter: invoiceId');
+            }
+            return encodeURIComponent(String(pathParams.invoiceId));
+        })()}/retry`;
+        return http(client)
+            .post(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.retryInvoiceResponseWire, data);
+            }
+            return fromWire(data, schemas.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
+ */
+export function snapshotQuantitiesInvoice(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            invoiceId: req.invoiceId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.snapshotQuantitiesInvoicePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.snapshotQuantitiesInvoicePathParamsWire, pathParams);
+        }
+        const path = `openmeter/billing/invoices/${(() => {
+            if (pathParams.invoiceId === undefined) {
+                throw new Error('missing path parameter: invoiceId');
+            }
+            return encodeURIComponent(String(pathParams.invoiceId));
+        })()}/snapshot-quantities`;
+        return http(client)
+            .post(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.snapshotQuantitiesInvoiceResponseWire, data);
+            }
+            return fromWire(data, schemas.snapshotQuantitiesInvoiceResponse);
+        });
+    });
+}

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,10 +1,21 @@
+// 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 { toWire, toPathWire, 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(() => {
+        if (client._options.validate && req.sort !== undefined) {
+            assertValid(schemas.listLlmCostPricesQueryParams.shape.sort, req.sort);
+        }
         const query = toWire({
             filter: req.filter,
             sort: encodeSort(req.sort, toSnakeCase),
@@ -25,13 +36,30 @@ 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 pathParamsInput = {
+            priceId: req.priceId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getLlmCostPricePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getLlmCostPricePathParamsWire, pathParams);
+        }
         const path = `openmeter/llm-cost/prices/${(() => {
-            if (req.priceId === undefined) {
+            if (pathParams.priceId === undefined) {
                 throw new Error('missing path parameter: priceId');
             }
-            return encodeURIComponent(String(req.priceId));
+            return encodeURIComponent(String(pathParams.priceId));
         })()}`;
         return http(client)
             .get(path, options)
@@ -44,6 +72,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 +100,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,15 +124,30 @@ 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 pathParamsInput = {
+            priceId: req.priceId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.deleteLlmCostOverridePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.deleteLlmCostOverridePathParamsWire, pathParams);
+        }
         const path = `openmeter/llm-cost/overrides/${(() => {
-            if (req.priceId === undefined) {
+            if (pathParams.priceId === undefined) {
                 throw new Error('missing path parameter: priceId');
             }
-            return encodeURIComponent(String(req.priceId));
+            return encodeURIComponent(String(pathParams.priceId));
         })()}`;
         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