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

package/dist/funcs/defaults.js

@@ -1,7 +1,13 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
 import { toWire, fromWire, assertValid } from '../lib/wire.js';
 import * as schemas from '../models/schemas.js';
+/**
+ * Get organization default tax codes
+ *
+ * GET /openmeter/defaults/tax-codes
+ */
 export function getOrganizationDefaultTaxCodes(client, req, options) {
     return request(() => http(client)
         .get('openmeter/defaults/tax-codes', options)
@@ -13,6 +19,11 @@ export function getOrganizationDefaultTaxCodes(client, req, options) {
         return fromWire(data, schemas.getOrganizationDefaultTaxCodesResponse);
     }));
 }
+/**
+ * Update organization default tax codes
+ *
+ * PUT /openmeter/defaults/tax-codes
+ */
 export function updateOrganizationDefaultTaxCodes(client, req, options) {
     return request(() => {
         const body = toWire(req, schemas.updateOrganizationDefaultTaxCodesBody);
@@ -30,4 +41,3 @@ export function updateOrganizationDefaultTaxCodes(client, req, options) {
         });
     });
 }
-//# sourceMappingURL=defaults.js.map

package/dist/funcs/entitlements.d.ts

@@ -1,5 +1,9 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListCustomerEntitlementAccessRequest, ListCustomerEntitlementAccessResponse } from '../models/operations/entitlements.js';
+/**
+ * List customer entitlement access
+ *
+ * GET /openmeter/customers/{customerId}/entitlement-access
+ */
 export declare function listCustomerEntitlementAccess(client: Client, req: ListCustomerEntitlementAccessRequest, options?: RequestOptions): Promise<Result<ListCustomerEntitlementAccessResponse>>;
-//# sourceMappingURL=entitlements.d.ts.map

package/dist/funcs/entitlements.js

@@ -1,14 +1,29 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
-import { fromWire, assertValid } from '../lib/wire.js';
+import { toPathWire, fromWire, assertValid } from '../lib/wire.js';
 import * as schemas from '../models/schemas.js';
+/**
+ * List customer entitlement access
+ *
+ * GET /openmeter/customers/{customerId}/entitlement-access
+ */
 export function listCustomerEntitlementAccess(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            customerId: req.customerId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.listCustomerEntitlementAccessPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.listCustomerEntitlementAccessPathParamsWire, pathParams);
+        }
         const path = `openmeter/customers/${(() => {
-            if (req.customerId === undefined) {
+            if (pathParams.customerId === undefined) {
                 throw new Error('missing path parameter: customerId');
             }
-            return encodeURIComponent(String(req.customerId));
+            return encodeURIComponent(String(pathParams.customerId));
         })()}/entitlement-access`;
         return http(client)
             .get(path, options)
@@ -21,4 +36,3 @@ export function listCustomerEntitlementAccess(client, req, options) {
         });
     });
 }
-//# sourceMappingURL=entitlements.js.map

package/dist/funcs/events.d.ts

@@ -1,6 +1,19 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListMeteringEventsRequest, ListMeteringEventsResponse, IngestMeteringEventsRequest, IngestMeteringEventsResponse } from '../models/operations/events.js';
+/**
+ * List metering events
+ *
+ * List ingested events.
+ *
+ * GET /openmeter/events
+ */
 export declare function listMeteringEvents(client: Client, req?: ListMeteringEventsRequest, options?: RequestOptions): Promise<Result<ListMeteringEventsResponse>>;
+/**
+ * Ingest metering events
+ *
+ * Ingests an event or batch of events following the CloudEvents specification.
+ *
+ * POST /openmeter/events
+ */
 export declare function ingestMeteringEvents(client: Client, req: IngestMeteringEventsRequest, options?: RequestOptions): Promise<Result<IngestMeteringEventsResponse>>;
-//# sourceMappingURL=events.d.ts.map

package/dist/funcs/events.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 * as schemas from '../models/schemas.js';
+/**
+ * List metering events
+ *
+ * List ingested events.
+ *
+ * GET /openmeter/events
+ */
 export function listMeteringEvents(client, req = {}, options) {
     return request(() => {
+        if (client._options.validate && req.sort !== undefined) {
+            assertValid(schemas.listMeteringEventsQueryParams.shape.sort, req.sort);
+        }
         const query = toWire({
             page: req.page,
             filter: req.filter,
@@ -25,6 +36,13 @@ export function listMeteringEvents(client, req = {}, options) {
         });
     });
 }
+/**
+ * Ingest metering events
+ *
+ * Ingests an event or batch of events following the CloudEvents specification.
+ *
+ * POST /openmeter/events
+ */
 export function ingestMeteringEvents(client, req, options) {
     return request(async () => {
         const body = toWire(req, schemas.ingestMeteringEventsBody);
@@ -34,4 +52,3 @@ export function ingestMeteringEvents(client, req, options) {
         await http(client).post('openmeter/events', { ...options, json: body });
     });
 }
-//# sourceMappingURL=events.js.map

package/dist/funcs/features.d.ts

@@ -1,10 +1,51 @@
 import { type Client } from '../core.js';
 import { type Result, 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';
+/**
+ * List features
+ *
+ * List all features.
+ *
+ * GET /openmeter/features
+ */
 export declare function listFeatures(client: Client, req?: ListFeaturesRequest, options?: RequestOptions): Promise<Result<ListFeaturesResponse>>;
+/**
+ * Create feature
+ *
+ * Create a feature.
+ *
+ * POST /openmeter/features
+ */
 export declare function createFeature(client: Client, req: CreateFeatureRequest, options?: RequestOptions): Promise<Result<CreateFeatureResponse>>;
+/**
+ * Get feature
+ *
+ * Get a feature by id.
+ *
+ * GET /openmeter/features/{featureId}
+ */
 export declare function getFeature(client: Client, req: GetFeatureRequest, options?: RequestOptions): Promise<Result<GetFeatureResponse>>;
+/**
+ * Update feature
+ *
+ * Update a feature by id. Currently only the unit_cost field can be updated.
+ *
+ * PATCH /openmeter/features/{featureId}
+ */
 export declare function updateFeature(client: Client, req: UpdateFeatureRequest, options?: RequestOptions): Promise<Result<UpdateFeatureResponse>>;
+/**
+ * Delete feature
+ *
+ * Delete a feature by id.
+ *
+ * DELETE /openmeter/features/{featureId}
+ */
 export declare function deleteFeature(client: Client, req: DeleteFeatureRequest, options?: RequestOptions): Promise<Result<DeleteFeatureResponse>>;
+/**
+ * Query feature cost
+ *
+ * Query the cost of a feature.
+ *
+ * POST /openmeter/features/{featureId}/cost/query
+ */
 export declare function queryFeatureCost(client: Client, req: QueryFeatureCostRequest, options?: RequestOptions): Promise<Result<QueryFeatureCostResponse>>;
-//# sourceMappingURL=features.d.ts.map

package/dist/funcs/features.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 features
+ *
+ * List all features.
+ *
+ * GET /openmeter/features
+ */
 export function listFeatures(client, req = {}, options) {
     return request(() => {
+        if (client._options.validate && req.sort !== undefined) {
+            assertValid(schemas.listFeaturesQueryParams.shape.sort, req.sort);
+        }
         const query = toWire({
             page: req.page,
             sort: encodeSort(req.sort, toSnakeCase),
@@ -25,6 +36,13 @@ export function listFeatures(client, req = {}, options) {
         });
     });
 }
+/**
+ * Create feature
+ *
+ * Create a feature.
+ *
+ * POST /openmeter/features
+ */
 export function createFeature(client, req, options) {
     return request(() => {
         const body = toWire(req, schemas.createFeatureBody);
@@ -42,13 +60,29 @@ export function createFeature(client, req, options) {
         });
     });
 }
+/**
+ * Get feature
+ *
+ * Get a feature by id.
+ *
+ * GET /openmeter/features/{featureId}
+ */
 export function getFeature(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            featureId: req.featureId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getFeaturePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getFeaturePathParamsWire, pathParams);
+        }
         const path = `openmeter/features/${(() => {
-            if (req.featureId === undefined) {
+            if (pathParams.featureId === undefined) {
                 throw new Error('missing path parameter: featureId');
             }
-            return encodeURIComponent(String(req.featureId));
+            return encodeURIComponent(String(pathParams.featureId));
         })()}`;
         return http(client)
             .get(path, options)
@@ -61,13 +95,29 @@ export function getFeature(client, req, options) {
         });
     });
 }
+/**
+ * Update feature
+ *
+ * Update a feature by id. Currently only the unit_cost field can be updated.
+ *
+ * PATCH /openmeter/features/{featureId}
+ */
 export function updateFeature(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            featureId: req.featureId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.updateFeaturePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.updateFeaturePathParamsWire, pathParams);
+        }
         const path = `openmeter/features/${(() => {
-            if (req.featureId === undefined) {
+            if (pathParams.featureId === undefined) {
                 throw new Error('missing path parameter: featureId');
             }
-            return encodeURIComponent(String(req.featureId));
+            return encodeURIComponent(String(pathParams.featureId));
         })()}`;
         const body = toWire(req.body, schemas.updateFeatureBody);
         if (client._options.validate) {
@@ -84,24 +134,56 @@ export function updateFeature(client, req, options) {
         });
     });
 }
+/**
+ * Delete feature
+ *
+ * Delete a feature by id.
+ *
+ * DELETE /openmeter/features/{featureId}
+ */
 export function deleteFeature(client, req, options) {
     return request(async () => {
+        const pathParamsInput = {
+            featureId: req.featureId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.deleteFeaturePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.deleteFeaturePathParamsWire, pathParams);
+        }
         const path = `openmeter/features/${(() => {
-            if (req.featureId === undefined) {
+            if (pathParams.featureId === undefined) {
                 throw new Error('missing path parameter: featureId');
             }
-            return encodeURIComponent(String(req.featureId));
+            return encodeURIComponent(String(pathParams.featureId));
         })()}`;
         await http(client).delete(path, options);
     });
 }
+/**
+ * Query feature cost
+ *
+ * Query the cost of a feature.
+ *
+ * POST /openmeter/features/{featureId}/cost/query
+ */
 export function queryFeatureCost(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            featureId: req.featureId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.queryFeatureCostPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.queryFeatureCostPathParamsWire, pathParams);
+        }
         const path = `openmeter/features/${(() => {
-            if (req.featureId === undefined) {
+            if (pathParams.featureId === undefined) {
                 throw new Error('missing path parameter: featureId');
             }
-            return encodeURIComponent(String(req.featureId));
+            return encodeURIComponent(String(pathParams.featureId));
         })()}/cost/query`;
         const body = toWire(req.body, schemas.queryFeatureCostBody);
         if (client._options.validate) {
@@ -118,4 +200,3 @@ export function queryFeatureCost(client, req, options) {
         });
     });
 }
-//# sourceMappingURL=features.js.map

package/dist/funcs/governance.d.ts

@@ -1,5 +1,18 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { QueryGovernanceAccessRequest, QueryGovernanceAccessResponse } from '../models/operations/governance.js';
+/**
+ * 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
+ */
 export declare function queryGovernanceAccess(client: Client, req: QueryGovernanceAccessRequest, options?: RequestOptions): Promise<Result<QueryGovernanceAccessResponse>>;
-//# sourceMappingURL=governance.d.ts.map

package/dist/funcs/governance.js

@@ -1,8 +1,23 @@
+// 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';
+/**
+ * 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
+ */
 export function queryGovernanceAccess(client, req, options) {
     return request(() => {
         const body = toWire(req.body, schemas.queryGovernanceAccessBody);
@@ -31,4 +46,3 @@ export function queryGovernanceAccess(client, req, options) {
         });
     });
 }
-//# sourceMappingURL=governance.js.map

package/dist/funcs/index.d.ts

@@ -15,4 +15,3 @@ export * from './addons.js';
 export * from './planAddons.js';
 export * from './defaults.js';
 export * from './governance.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/funcs/index.js

@@ -1,3 +1,4 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 export * from './events.js';
 export * from './meters.js';
 export * from './customers.js';
@@ -15,4 +16,3 @@ export * from './addons.js';
 export * from './planAddons.js';
 export * from './defaults.js';
 export * from './governance.js';
-//# sourceMappingURL=index.js.map

package/dist/funcs/invoices.d.ts

@@ -1,8 +1,108 @@
 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';
+import type { ListInvoicesRequest, ListInvoicesResponse, GetInvoiceRequest, GetInvoiceResponse, UpdateInvoiceRequest, UpdateInvoiceResponse, DeleteInvoiceRequest, DeleteInvoiceResponse, AdvanceInvoiceRequest, AdvanceInvoiceResponse, ApproveInvoiceRequest, ApproveInvoiceResponse, RetryInvoiceRequest, RetryInvoiceResponse, SnapshotQuantitiesInvoiceRequest, SnapshotQuantitiesInvoiceResponse } 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
+/**
+ * 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 declare function advanceInvoice(client: Client, req: AdvanceInvoiceRequest, options?: RequestOptions): Promise<Result<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 declare function approveInvoice(client: Client, req: ApproveInvoiceRequest, options?: RequestOptions): Promise<Result<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 declare function retryInvoice(client: Client, req: RetryInvoiceRequest, options?: RequestOptions): Promise<Result<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 declare function snapshotQuantitiesInvoice(client: Client, req: SnapshotQuantitiesInvoiceRequest, options?: RequestOptions): Promise<Result<SnapshotQuantitiesInvoiceResponse>>;