@openmeter/client 1.0.0-beta-72c0e4789aae → 1.0.0-beta-e609679efd27

package/dist/sdk/customers.js

@@ -1,7 +1,7 @@
 // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
 import { paginateCursor, paginatePages } from '../lib/paginate.js';
-import { createCustomer, getCustomer, listCustomers, upsertCustomer, deleteCustomer, getCustomerBilling, updateCustomerBilling, updateCustomerBillingAppData, createCustomerStripeCheckoutSession, createCustomerStripePortalSession, createCreditGrant, getCreditGrant, listCreditGrants, getCustomerCreditBalance, createCreditAdjustment, updateCreditGrantExternalSettlement, listCreditTransactions, } from '../funcs/customers.js';
+import { createCustomer, getCustomer, listCustomers, upsertCustomer, deleteCustomer, getCustomerBilling, updateCustomerBilling, updateCustomerBillingAppData, createCustomerStripeCheckoutSession, createCustomerStripePortalSession, createCustomerEntitlement, overrideCustomerEntitlement, getCustomerEntitlementHistory, getCustomerEntitlement, listCustomerEntitlements, resetCustomerEntitlementUsage, deleteCustomerEntitlement, createCustomerEntitlementGrant, listCustomerEntitlementGrants, createCreditGrant, getCreditGrant, listCreditGrants, getCustomerCreditBalance, createCreditAdjustment, voidCreditGrant, updateCreditGrantExternalSettlement, listCreditTransactions, listCustomerCharges, createCustomerCharges, } from '../funcs/customers.js';
 export class Customers {
     _client;
     constructor(_client) {
@@ -61,10 +61,18 @@ export class Customers {
     get billing() {
         return (this._billing ??= new CustomersBilling(this._client));
     }
+    _entitlements;
+    get entitlements() {
+        return (this._entitlements ??= new CustomersEntitlements(this._client));
+    }
     _credits;
     get credits() {
         return (this._credits ??= new CustomersCredits(this._client));
     }
+    _charges;
+    get charges() {
+        return (this._charges ??= new CustomersCharges(this._client));
+    }
 }
 export class CustomersBilling {
     _client;
@@ -131,6 +139,181 @@ export class CustomersBilling {
         return unwrap(await createCustomerStripePortalSession(this._client, request, options));
     }
 }
+export class CustomersEntitlements {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * Create customer entitlement
+     *
+     * Create an entitlement for the customer.
+     *
+     * A customer can have only one active entitlement per feature. The feature must be
+     * compatible with the entitlement type. Entitlements cannot be modified after
+     * creation, only deleted.
+     *
+     * POST /openmeter/customers/{customerId}/entitlements
+     */
+    async create(request, options) {
+        return unwrap(await createCustomerEntitlement(this._client, request, options));
+    }
+    /**
+     * Override customer entitlement
+     *
+     * Override an entitlement of the customer with a new one.
+     *
+     * The referenced entitlement ends and the new one starts at the same instant, so
+     * access continues without a gap. Both must belong to the same feature. Use this
+     * for upgrades and downgrades.
+     *
+     * Fails if the referenced entitlement does not exist, is deleted, or is no longer
+     * active.
+     *
+     * PUT /openmeter/customers/{customerId}/entitlements/{entitlementId}/override
+     */
+    async override(request, options) {
+        return unwrap(await overrideCustomerEntitlement(this._client, request, options));
+    }
+    /**
+     * Get customer entitlement history
+     *
+     * Get the balance and usage history of a metered entitlement. The queried range
+     * may span multiple usage periods.
+     *
+     * `windowed_history` groups usage into windows of the requested size and reports
+     * the balance at the start of each window. `burndown_history` lists the periods in
+     * which grants were consumed in a fixed order, together with the usage taken from
+     * each grant.
+     *
+     * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/history
+     */
+    async getHistory(request, options) {
+        return unwrap(await getCustomerEntitlementHistory(this._client, request, options));
+    }
+    /**
+     * Get customer entitlement
+     *
+     * Get an entitlement of the customer by ID. For checking entitlement access, use
+     * the entitlement access endpoints instead.
+     *
+     * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}
+     */
+    async get(request, options) {
+        return unwrap(await getCustomerEntitlement(this._client, request, options));
+    }
+    /**
+     * List customer entitlements
+     *
+     * List the entitlements of the customer that are active at the time of the
+     * request. For checking entitlement access, use the entitlement access endpoints
+     * instead.
+     *
+     * GET /openmeter/customers/{customerId}/entitlements
+     */
+    async list(request, options) {
+        return unwrap(await listCustomerEntitlements(this._client, request, options));
+    }
+    /**
+     * List customer entitlements
+     *
+     * List the entitlements of the customer that are active at the time of the
+     * request. For checking entitlement access, use the entitlement access endpoints
+     * instead.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/customers/{customerId}/entitlements
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listCustomerEntitlements(this._client, req, opts), request, options);
+    }
+    /**
+     * Reset customer entitlement usage
+     *
+     * Reset the usage of a metered entitlement. The reset starts a new usage period:
+     * usage is zeroed and grants roll over according to their rollover settings.
+     *
+     * Usage is reset automatically at the end of each usage period. Use this operation
+     * to reset it earlier, for example to align the entitlement with the customer's
+     * billing period. The usage period anchor can be moved at the same time.
+     *
+     * POST /openmeter/customers/{customerId}/entitlements/{entitlementId}/reset
+     */
+    async resetUsage(request, options) {
+        return unwrap(await resetCustomerEntitlementUsage(this._client, request, options));
+    }
+    /**
+     * Delete customer entitlement
+     *
+     * Deletes the entitlement and revokes access to its feature. A customer can hold
+     * only one active entitlement per feature, so migrating a feature requires
+     * deleting the previous entitlement first.
+     *
+     * Deletion sets the `deleted_at` timestamp instead of removing history. Access and
+     * status queries for earlier points in time still treat the entitlement as active,
+     * so access changes are never retroactive.
+     *
+     * DELETE /openmeter/customers/{customerId}/entitlements/{entitlementId}
+     */
+    async delete(request, options) {
+        return unwrap(await deleteCustomerEntitlement(this._client, request, options));
+    }
+    _grants;
+    get grants() {
+        return (this._grants ??= new CustomersEntitlementsGrants(this._client));
+    }
+}
+export class CustomersEntitlementsGrants {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * Create customer entitlement grant
+     *
+     * Issue a grant for a metered entitlement of the customer. Boolean and static
+     * entitlements cannot have grants, so the request is rejected for them.
+     *
+     * Grants are immutable. The amount is added to the balance from `effective_at`,
+     * which cannot be earlier than the start of the current usage period.
+     *
+     * POST /openmeter/customers/{customerId}/entitlements/{entitlementId}/grants
+     */
+    async create(request, options) {
+        return unwrap(await createCustomerEntitlementGrant(this._client, request, options));
+    }
+    /**
+     * List customer entitlement grants
+     *
+     * List the grants issued for an entitlement of the customer. Grants only exist for
+     * metered entitlements, so the list is empty for boolean and static entitlements.
+     *
+     * Deleted grants are excluded unless `include_deleted` is set. Voided and expired
+     * grants are always included, as they are part of the balance history.
+     *
+     * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/grants
+     */
+    async list(request, options) {
+        return unwrap(await listCustomerEntitlementGrants(this._client, request, options));
+    }
+    /**
+     * List customer entitlement grants
+     *
+     * List the grants issued for an entitlement of the customer. Grants only exist for
+     * metered entitlements, so the list is empty for boolean and static entitlements.
+     *
+     * Deleted grants are excluded unless `include_deleted` is set. Voided and expired
+     * grants are always included, as they are part of the balance history.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/grants
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listCustomerEntitlementGrants(this._client, req, opts), request, options);
+    }
+}
 export class CustomersCredits {
     _client;
     constructor(_client) {
@@ -201,6 +384,24 @@ export class CustomersCreditsGrants {
     listAll(request, options) {
         return paginatePages((req, opts) => listCreditGrants(this._client, req, opts), request, 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
+     */
+    async void(request, options) {
+        return unwrap(await voidCreditGrant(this._client, request, options));
+    }
     /**
      * Update credit grant external settlement status
      *
@@ -288,3 +489,47 @@ export class CustomersCreditsTransactions {
         return paginateCursor((req, opts) => listCreditTransactions(this._client, req, opts), request, options);
     }
 }
+export class CustomersCharges {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * 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
+     */
+    async list(request, options) {
+        return unwrap(await listCustomerCharges(this._client, request, options));
+    }
+    /**
+     * List customer charges
+     *
+     * List customer charges.
+     *
+     * Returns the customer's charges that are represented as either flat fee or
+     * usage-based charges.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/customers/{customerId}/charges
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listCustomerCharges(this._client, req, opts), request, options);
+    }
+    /**
+     * Create customer charge
+     *
+     * Create customer charge.
+     *
+     * POST /openmeter/customers/{customerId}/charges
+     */
+    async create(request, options) {
+        return unwrap(await createCustomerCharges(this._client, request, options));
+    }
+}

package/dist/sdk/entitlementAccess.d.ts

@@ -0,0 +1,22 @@
+import { type Client } from '../core.js';
+import { type RequestOptions } from '../lib/types.js';
+import type { QueryEntitlementAccessRequest, QueryEntitlementAccessResponse } from '../models/operations/entitlementAccess.js';
+export declare class EntitlementAccess {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * Query entitlement 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/entitlement-access/query
+     */
+    query(request: QueryEntitlementAccessRequest, options?: RequestOptions): Promise<QueryEntitlementAccessResponse>;
+}

package/dist/sdk/entitlementAccess.js

@@ -0,0 +1,26 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
+import { unwrap } from '../lib/types.js';
+import { queryEntitlementAccess } from '../funcs/entitlementAccess.js';
+export class EntitlementAccess {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * Query entitlement 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/entitlement-access/query
+     */
+    async query(request, options) {
+        return unwrap(await queryEntitlementAccess(this._client, request, options));
+    }
+}

package/dist/sdk/entitlements.d.ts

@@ -1,6 +1,7 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
-import type { ListCustomerEntitlementAccessRequest, ListCustomerEntitlementAccessResponse } from '../models/operations/entitlements.js';
+import type { ListCustomerEntitlementAccessRequest, ListCustomerEntitlementAccessResponse, GetCustomerEntitlementAccessRequest, GetCustomerEntitlementAccessResponse, GetCustomerEntitlementValueByFeatureKeyRequest, GetCustomerEntitlementValueByFeatureKeyResponse, ListEntitlementsRequest, ListEntitlementsResponse, GetEntitlementRequest, GetEntitlementResponse, GetCustomerEntitlementValueRequest, GetCustomerEntitlementValueResponse } from '../models/operations/entitlements.js';
+import type { Entitlement } from '../models/types.js';
 export declare class Entitlements {
     private readonly _client;
     constructor(_client: Client);
@@ -10,4 +11,61 @@ export declare class Entitlements {
      * GET /openmeter/customers/{customerId}/entitlement-access
      */
     listCustomerAccess(request: ListCustomerEntitlementAccessRequest, options?: RequestOptions): Promise<ListCustomerEntitlementAccessResponse>;
+    /**
+     * Get customer entitlement access
+     *
+     * Get the customer's access to a single feature.
+     *
+     * GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
+     */
+    getCustomerAccess(request: GetCustomerEntitlementAccessRequest, options?: RequestOptions): Promise<GetCustomerEntitlementAccessResponse>;
+    /**
+     * Get customer entitlement value by feature key
+     *
+     * Get the customer's entitlement value for a feature at a point in time. Without
+     * an active entitlement, the result denies access and omits the type.
+     *
+     * GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}/value
+     */
+    getCustomerValueByFeatureKey(request: GetCustomerEntitlementValueByFeatureKeyRequest, options?: RequestOptions): Promise<GetCustomerEntitlementValueByFeatureKeyResponse>;
+    /**
+     * List entitlements
+     *
+     * List the active entitlements of all customers. Intended for administrative use.
+     * To list the entitlements of a single customer, use the customer entitlements
+     * endpoints; to check entitlement access, use the entitlement access endpoints.
+     *
+     * GET /openmeter/entitlements
+     */
+    list(request?: ListEntitlementsRequest, options?: RequestOptions): Promise<ListEntitlementsResponse>;
+    /**
+     * List entitlements
+     *
+     * List the active entitlements of all customers. Intended for administrative use.
+     * To list the entitlements of a single customer, use the customer entitlements
+     * endpoints; to check entitlement access, use the entitlement access endpoints.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/entitlements
+     */
+    listAll(request?: ListEntitlementsRequest, options?: RequestOptions): AsyncIterable<Entitlement>;
+    /**
+     * Get entitlement
+     *
+     * Get an entitlement by ID. To check entitlement access, use the entitlement
+     * access endpoints instead.
+     *
+     * GET /openmeter/entitlements/{entitlementId}
+     */
+    get(request: GetEntitlementRequest, options?: RequestOptions): Promise<GetEntitlementResponse>;
+    /**
+     * Get customer entitlement value
+     *
+     * Get the customer's access through a single entitlement, optionally evaluated at
+     * a point in time.
+     *
+     * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/value
+     */
+    getCustomerValue(request: GetCustomerEntitlementValueRequest, options?: RequestOptions): Promise<GetCustomerEntitlementValueResponse>;
 }

package/dist/sdk/entitlements.js

@@ -1,6 +1,7 @@
 // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
-import { listCustomerEntitlementAccess } from '../funcs/entitlements.js';
+import { paginatePages } from '../lib/paginate.js';
+import { listCustomerEntitlementAccess, getCustomerEntitlementAccess, getCustomerEntitlementValueByFeatureKey, listEntitlements, getEntitlement, getCustomerEntitlementValue, } from '../funcs/entitlements.js';
 export class Entitlements {
     _client;
     constructor(_client) {
@@ -14,4 +15,73 @@ export class Entitlements {
     async listCustomerAccess(request, options) {
         return unwrap(await listCustomerEntitlementAccess(this._client, request, options));
     }
+    /**
+     * Get customer entitlement access
+     *
+     * Get the customer's access to a single feature.
+     *
+     * GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
+     */
+    async getCustomerAccess(request, options) {
+        return unwrap(await getCustomerEntitlementAccess(this._client, request, options));
+    }
+    /**
+     * Get customer entitlement value by feature key
+     *
+     * Get the customer's entitlement value for a feature at a point in time. Without
+     * an active entitlement, the result denies access and omits the type.
+     *
+     * GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}/value
+     */
+    async getCustomerValueByFeatureKey(request, options) {
+        return unwrap(await getCustomerEntitlementValueByFeatureKey(this._client, request, options));
+    }
+    /**
+     * List entitlements
+     *
+     * List the active entitlements of all customers. Intended for administrative use.
+     * To list the entitlements of a single customer, use the customer entitlements
+     * endpoints; to check entitlement access, use the entitlement access endpoints.
+     *
+     * GET /openmeter/entitlements
+     */
+    async list(request, options) {
+        return unwrap(await listEntitlements(this._client, request, options));
+    }
+    /**
+     * List entitlements
+     *
+     * List the active entitlements of all customers. Intended for administrative use.
+     * To list the entitlements of a single customer, use the customer entitlements
+     * endpoints; to check entitlement access, use the entitlement access endpoints.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/entitlements
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listEntitlements(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Get entitlement
+     *
+     * Get an entitlement by ID. To check entitlement access, use the entitlement
+     * access endpoints instead.
+     *
+     * GET /openmeter/entitlements/{entitlementId}
+     */
+    async get(request, options) {
+        return unwrap(await getEntitlement(this._client, request, options));
+    }
+    /**
+     * Get customer entitlement value
+     *
+     * Get the customer's access through a single entitlement, optionally evaluated at
+     * a point in time.
+     *
+     * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/value
+     */
+    async getCustomerValue(request, options) {
+        return unwrap(await getCustomerEntitlementValue(this._client, request, options));
+    }
 }

package/dist/sdk/grants.d.ts

@@ -0,0 +1,43 @@
+import { type Client } from '../core.js';
+import { type RequestOptions } from '../lib/types.js';
+import type { ListGrantsRequest, ListGrantsResponse, VoidGrantRequest, VoidGrantResponse } from '../models/operations/grants.js';
+import type { EntitlementGrant } from '../models/types.js';
+export declare class Grants {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * List grants
+     *
+     * List the grants of all customers and entitlements. To list the grants of a
+     * single entitlement, use the customer entitlement grants endpoint.
+     *
+     * Deleted grants are excluded unless `include_deleted` is set. Voided and expired
+     * grants are always included, as they are part of the balance history.
+     *
+     * GET /openmeter/grants
+     */
+    list(request?: ListGrantsRequest, options?: RequestOptions): Promise<ListGrantsResponse>;
+    /**
+     * List grants
+     *
+     * List the grants of all customers and entitlements. To list the grants of a
+     * single entitlement, use the customer entitlement grants endpoint.
+     *
+     * Deleted grants are excluded unless `include_deleted` is set. Voided and expired
+     * grants are always included, as they are part of the balance history.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/grants
+     */
+    listAll(request?: ListGrantsRequest, options?: RequestOptions): AsyncIterable<EntitlementGrant>;
+    /**
+     * Void grant
+     *
+     * Void a grant so it no longer adds to the balance. Usage already deducted from
+     * the grant is kept.
+     *
+     * DELETE /openmeter/grants/{grantId}
+     */
+    void(request: VoidGrantRequest, options?: RequestOptions): Promise<VoidGrantResponse>;
+}

package/dist/sdk/grants.js

@@ -0,0 +1,51 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
+import { unwrap } from '../lib/types.js';
+import { paginatePages } from '../lib/paginate.js';
+import { listGrants, voidGrant } from '../funcs/grants.js';
+export class Grants {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * List grants
+     *
+     * List the grants of all customers and entitlements. To list the grants of a
+     * single entitlement, use the customer entitlement grants endpoint.
+     *
+     * Deleted grants are excluded unless `include_deleted` is set. Voided and expired
+     * grants are always included, as they are part of the balance history.
+     *
+     * GET /openmeter/grants
+     */
+    async list(request, options) {
+        return unwrap(await listGrants(this._client, request, options));
+    }
+    /**
+     * List grants
+     *
+     * List the grants of all customers and entitlements. To list the grants of a
+     * single entitlement, use the customer entitlement grants endpoint.
+     *
+     * Deleted grants are excluded unless `include_deleted` is set. Voided and expired
+     * grants are always included, as they are part of the balance history.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/grants
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listGrants(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Void grant
+     *
+     * Void a grant so it no longer adds to the balance. Usage already deducted from
+     * the grant is kept.
+     *
+     * DELETE /openmeter/grants/{grantId}
+     */
+    async void(request, options) {
+        return unwrap(await voidGrant(this._client, request, options));
+    }
+}