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

package/dist/funcs/customers.js

@@ -1,8 +1,14 @@
+// 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 customer
+ *
+ * POST /openmeter/customers
+ */
 export function createCustomer(client, req, options) {
     return request(() => {
         const body = toWire(req, schemas.createCustomerBody);
@@ -20,6 +26,11 @@ export function createCustomer(client, req, options) {
         });
     });
 }
+/**
+ * Get customer
+ *
+ * GET /openmeter/customers/{customerId}
+ */
 export function getCustomer(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -39,6 +50,11 @@ export function getCustomer(client, req, options) {
         });
     });
 }
+/**
+ * List customers
+ *
+ * GET /openmeter/customers
+ */
 export function listCustomers(client, req = {}, options) {
     return request(() => {
         const query = toWire({
@@ -61,6 +77,11 @@ export function listCustomers(client, req = {}, options) {
         });
     });
 }
+/**
+ * Upsert customer
+ *
+ * PUT /openmeter/customers/{customerId}
+ */
 export function upsertCustomer(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -84,6 +105,11 @@ export function upsertCustomer(client, req, options) {
         });
     });
 }
+/**
+ * Delete customer
+ *
+ * DELETE /openmeter/customers/{customerId}
+ */
 export function deleteCustomer(client, req, options) {
     return request(async () => {
         const path = `openmeter/customers/${(() => {
@@ -95,6 +121,11 @@ export function deleteCustomer(client, req, options) {
         await http(client).delete(path, options);
     });
 }
+/**
+ * Get customer billing data
+ *
+ * GET /openmeter/customers/{customerId}/billing
+ */
 export function getCustomerBilling(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -114,6 +145,11 @@ export function getCustomerBilling(client, req, options) {
         });
     });
 }
+/**
+ * Update customer billing data
+ *
+ * PUT /openmeter/customers/{customerId}/billing
+ */
 export function updateCustomerBilling(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -137,6 +173,11 @@ export function updateCustomerBilling(client, req, options) {
         });
     });
 }
+/**
+ * Update customer billing app data
+ *
+ * PUT /openmeter/customers/{customerId}/billing/app-data
+ */
 export function updateCustomerBillingAppData(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -160,6 +201,23 @@ export function updateCustomerBillingAppData(client, req, options) {
         });
     });
 }
+/**
+ * Create Stripe Checkout Session
+ *
+ * Create a [Stripe Checkout Session](https://docs.stripe.com/payments/checkout)
+ * for the customer.
+ *
+ * Creates a Checkout Session for collecting payment method information from
+ * customers. The session operates in "setup" mode, which collects payment details
+ * without charging the customer immediately. The collected payment method can be
+ * used for future subscription billing.
+ *
+ * For hosted checkout sessions, redirect customers to the returned URL. For
+ * embedded sessions, use the client_secret to initialize Stripe.js in your
+ * application.
+ *
+ * POST /openmeter/customers/{customerId}/billing/stripe/checkout-sessions
+ */
 export function createCustomerStripeCheckoutSession(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -183,6 +241,18 @@ export function createCustomerStripeCheckoutSession(client, req, options) {
         });
     });
 }
+/**
+ * Create Stripe customer portal session
+ *
+ * Create Stripe Customer Portal Session.
+ *
+ * Useful to redirect the customer to the Stripe Customer Portal to manage their
+ * payment methods, change their billing address and access their invoice history.
+ * Only returns URL if the customer billing profile is linked to a stripe app and
+ * customer.
+ *
+ * POST /openmeter/customers/{customerId}/billing/stripe/portal-sessions
+ */
 export function createCustomerStripePortalSession(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -206,6 +276,14 @@ export function createCustomerStripePortalSession(client, req, options) {
         });
     });
 }
+/**
+ * Create a new credit grant
+ *
+ * Create a new credit grant. A credit grant represents an allocation of prepaid
+ * credits to a customer.
+ *
+ * POST /openmeter/customers/{customerId}/credits/grants
+ */
 export function createCreditGrant(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -229,6 +307,13 @@ export function createCreditGrant(client, req, options) {
         });
     });
 }
+/**
+ * Get a credit grant
+ *
+ * Get a credit grant.
+ *
+ * GET /openmeter/customers/{customerId}/credits/grants/{creditGrantId}
+ */
 export function getCreditGrant(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -253,6 +338,13 @@ export function getCreditGrant(client, req, options) {
         });
     });
 }
+/**
+ * List credit grants
+ *
+ * List credit grants.
+ *
+ * GET /openmeter/customers/{customerId}/credits/grants
+ */
 export function listCreditGrants(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -280,6 +372,13 @@ export function listCreditGrants(client, req, options) {
         });
     });
 }
+/**
+ * Get a customer's credit balance
+ *
+ * Get a credit balance.
+ *
+ * GET /openmeter/customers/{customerId}/credits/balance
+ */
 export function getCustomerCreditBalance(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -307,6 +406,18 @@ export function getCustomerCreditBalance(client, req, options) {
         });
     });
 }
+/**
+ * Create a credit adjustment
+ *
+ * A credit adjustment can be used to make manual adjustments to a customer's
+ * credit balance.
+ *
+ * Supported use-cases:
+ *
+ * - Usage correction
+ *
+ * POST /openmeter/customers/{customerId}/credits/adjustments
+ */
 export function createCreditAdjustment(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -330,6 +441,59 @@ export function createCreditAdjustment(client, req, options) {
         });
     });
 }
+/**
+ * Void credit grant
+ *
+ * Void a credit grant, forfeiting the remaining unused balance.
+ *
+ * Voiding is a forward-looking, irreversible operation. Credits already consumed
+ * by usage remain unaffected — only the remaining balance is forfeited. The grant
+ * reads as `voided` status afterwards. Payment state is not adjusted when
+ * `payment_adjustment` is `none`, so invoice-backed or externally collected
+ * payments may still collect the original amount. Only `active` grants can be
+ * voided; voiding a pending, expired, or fully consumed grant returns a conflict.
+ * Retrying a successful void is an idempotent success.
+ *
+ * POST /openmeter/customers/{customerId}/credits/grants/{creditGrantId}/void
+ */
+export function voidCreditGrant(client, req, options) {
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/credits/grants/${(() => {
+            if (req.creditGrantId === undefined) {
+                throw new Error('missing path parameter: creditGrantId');
+            }
+            return encodeURIComponent(String(req.creditGrantId));
+        })()}/void`;
+        const body = toWire(req.body, schemas.voidCreditGrantBody);
+        if (client._options.validate) {
+            assertValid(schemas.voidCreditGrantBodyWire, body);
+        }
+        return http(client)
+            .post(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.voidCreditGrantResponseWire, data);
+            }
+            return fromWire(data, schemas.voidCreditGrantResponse);
+        });
+    });
+}
+/**
+ * Update credit grant external settlement status
+ *
+ * Update the payment settlement status of an externally funded credit grant.
+ *
+ * Use this endpoint to synchronize the payment state of an external payment with
+ * the system so that revenue recognition and credit availability work as expected.
+ *
+ * POST /openmeter/customers/{customerId}/credits/grants/{creditGrantId}/settlement/external
+ */
 export function updateCreditGrantExternalSettlement(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -358,6 +522,17 @@ export function updateCreditGrantExternalSettlement(client, req, options) {
         });
     });
 }
+/**
+ * List credit transactions
+ *
+ * List credit transactions for a customer.
+ *
+ * Returns an immutable, chronological record of credit movements: funded credits
+ * and consumed credits. Transactions are returned in reverse chronological order
+ * by default.
+ *
+ * GET /openmeter/customers/{customerId}/credits/transactions
+ */
 export function listCreditTransactions(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -385,6 +560,16 @@ export function listCreditTransactions(client, req, options) {
         });
     });
 }
+/**
+ * List customer charges
+ *
+ * List customer charges.
+ *
+ * Returns the customer's charges that are represented as either flat fee or
+ * usage-based charges.
+ *
+ * GET /openmeter/customers/{customerId}/charges
+ */
 export function listCustomerCharges(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -414,6 +599,13 @@ export function listCustomerCharges(client, req, options) {
         });
     });
 }
+/**
+ * Create customer charge
+ *
+ * Create customer charge.
+ *
+ * POST /openmeter/customers/{customerId}/charges
+ */
 export function createCustomerCharges(client, req, options) {
     return request(() => {
         const path = `openmeter/customers/${(() => {
@@ -437,4 +629,3 @@ export function createCustomerCharges(client, req, options) {
         });
     });
 }
-//# sourceMappingURL=customers.js.map

package/dist/funcs/defaults.d.ts

@@ -1,6 +1,15 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { GetOrganizationDefaultTaxCodesRequest, GetOrganizationDefaultTaxCodesResponse, UpdateOrganizationDefaultTaxCodesRequest, UpdateOrganizationDefaultTaxCodesResponse } from '../models/operations/defaults.js';
+/**
+ * Get organization default tax codes
+ *
+ * GET /openmeter/defaults/tax-codes
+ */
 export declare function getOrganizationDefaultTaxCodes(client: Client, req: GetOrganizationDefaultTaxCodesRequest, options?: RequestOptions): Promise<Result<GetOrganizationDefaultTaxCodesResponse>>;
+/**
+ * Update organization default tax codes
+ *
+ * PUT /openmeter/defaults/tax-codes
+ */
 export declare function updateOrganizationDefaultTaxCodes(client: Client, req: UpdateOrganizationDefaultTaxCodesRequest, options?: RequestOptions): Promise<Result<UpdateOrganizationDefaultTaxCodesResponse>>;
-//# sourceMappingURL=defaults.d.ts.map

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,7 +1,13 @@
+// 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 * 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 path = `openmeter/customers/${(() => {
@@ -21,4 +27,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,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 metering events
+ *
+ * List ingested events.
+ *
+ * GET /openmeter/events
+ */
 export function listMeteringEvents(client, req = {}, options) {
     return request(() => {
         const query = toWire({
@@ -25,6 +33,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 +49,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,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 features
+ *
+ * List all features.
+ *
+ * GET /openmeter/features
+ */
 export function listFeatures(client, req = {}, options) {
     return request(() => {
         const query = toWire({
@@ -25,6 +33,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,6 +57,13 @@ 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 path = `openmeter/features/${(() => {
@@ -61,6 +83,13 @@ 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 path = `openmeter/features/${(() => {
@@ -84,6 +113,13 @@ 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 path = `openmeter/features/${(() => {
@@ -95,6 +131,13 @@ export function deleteFeature(client, req, options) {
         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 path = `openmeter/features/${(() => {
@@ -118,4 +161,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