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

package/dist/sdk/internal.js

@@ -1,11 +1,17 @@
 // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
 import { paginatePages } from '../lib/paginate.js';
-import { createSubscriptionAddon } from '../funcs/subscriptions.js';
-import { listApps, getApp, uninstallApp, updateApp, listAppCatalog, getAppCatalogItem, installApp, } from '../funcs/apps.js';
+import { createCustomerEntitlement, overrideCustomerEntitlement, getCustomerEntitlementHistory, getCustomerEntitlement, listCustomerEntitlements, resetCustomerEntitlementUsage, deleteCustomerEntitlement, createCustomerEntitlementGrant, listCustomerEntitlementGrants, voidCreditGrant, listCustomerCharges, createCustomerCharges, } from '../funcs/customers.js';
+import { getCustomerEntitlementAccess, getCustomerEntitlementValueByFeatureKey, listEntitlements, getEntitlement, getCustomerEntitlementValue, } from '../funcs/entitlements.js';
+import { listGrants, voidGrant } from '../funcs/grants.js';
+import { unscheduleSubscription, restoreSubscription, migrateSubscription, createSubscriptionAddon, updateSubscriptionAddon, } from '../funcs/subscriptions.js';
+import { uninstallApp, updateApp, listAppCatalog, getAppCatalogItem, installApp, } from '../funcs/apps.js';
 import { listInvoices, getInvoice, updateInvoice, deleteInvoice, advanceInvoice, approveInvoice, retryInvoice, snapshotQuantitiesInvoice, } from '../funcs/invoices.js';
+import { listCharges } from '../funcs/charges.js';
 import { listCurrencies, createCustomCurrency, getCustomCurrency, listCostBases, createCostBasis, } from '../funcs/currencies.js';
-import { queryGovernanceAccess } from '../funcs/governance.js';
+import { listPlanAddons } from '../funcs/planAddons.js';
+import { queryEntitlementAccess } from '../funcs/entitlementAccess.js';
+import { listNotificationChannels, createNotificationChannel, getNotificationChannel, updateNotificationChannel, deleteNotificationChannel, } from '../funcs/notifications.js';
 /**
  * Operations marked internal in the API definition. They are not part of
  * the customer surface: they may require additional permissions, and they
@@ -16,6 +22,18 @@ export class Internal {
     constructor(_client) {
         this._client = _client;
     }
+    _customers;
+    get customers() {
+        return (this._customers ??= new InternalCustomers(this._client));
+    }
+    _entitlements;
+    get entitlements() {
+        return (this._entitlements ??= new InternalEntitlements(this._client));
+    }
+    _grants;
+    get grants() {
+        return (this._grants ??= new InternalGrants(this._client));
+    }
     _subscriptions;
     get subscriptions() {
         return (this._subscriptions ??= new InternalSubscriptions(this._client));
@@ -28,67 +46,496 @@ export class Internal {
     get invoices() {
         return (this._invoices ??= new InternalInvoices(this._client));
     }
+    _charges;
+    get charges() {
+        return (this._charges ??= new InternalCharges(this._client));
+    }
     _currencies;
     get currencies() {
         return (this._currencies ??= new InternalCurrencies(this._client));
     }
-    _governance;
-    get governance() {
-        return (this._governance ??= new InternalGovernance(this._client));
+    _planAddons;
+    get planAddons() {
+        return (this._planAddons ??= new InternalPlanAddons(this._client));
+    }
+    _entitlementAccess;
+    get entitlementAccess() {
+        return (this._entitlementAccess ??= new InternalEntitlementAccess(this._client));
+    }
+    _notifications;
+    get notifications() {
+        return (this._notifications ??= new InternalNotifications(this._client));
     }
 }
-export class InternalSubscriptions {
+export class InternalCustomers {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    _entitlements;
+    get entitlements() {
+        return (this._entitlements ??= new InternalCustomersEntitlements(this._client));
+    }
+    _credits;
+    get credits() {
+        return (this._credits ??= new InternalCustomersCredits(this._client));
+    }
+    _charges;
+    get charges() {
+        return (this._charges ??= new InternalCustomersCharges(this._client));
+    }
+}
+export class InternalCustomersEntitlements {
     _client;
     constructor(_client) {
         this._client = _client;
     }
     /**
-     * Create a new subscription add-on
+     * Create customer entitlement
      *
-     * Add add-on to a subscription.
+     * Create an entitlement for the customer.
      *
-     * POST /openmeter/subscriptions/{subscriptionId}/addons
+     * 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 createAddon(request, options) {
-        return unwrap(await createSubscriptionAddon(this._client, request, options));
+    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 InternalCustomersEntitlementsGrants(this._client));
     }
 }
-export class InternalApps {
+export class InternalCustomersEntitlementsGrants {
     _client;
     constructor(_client) {
         this._client = _client;
     }
     /**
-     * List apps
+     * 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 InternalCustomersCredits {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    _grants;
+    get grants() {
+        return (this._grants ??= new InternalCustomersCreditsGrants(this._client));
+    }
+}
+export class InternalCustomersCreditsGrants {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * 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));
+    }
+}
+export class InternalCustomersCharges {
+    _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));
+    }
+}
+export class InternalEntitlements {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * 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 installed apps.
+     * 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/apps
+     * GET /openmeter/entitlements
      */
     async list(request, options) {
-        return unwrap(await listApps(this._client, request, options));
+        return unwrap(await listEntitlements(this._client, request, options));
     }
     /**
-     * List apps
+     * List entitlements
      *
-     * List installed apps.
+     * 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/apps
+     * GET /openmeter/entitlements
      */
     listAll(request, options) {
-        return paginatePages((req, opts) => listApps(this._client, req, opts), request ?? {}, options);
+        return paginatePages((req, opts) => listEntitlements(this._client, req, opts), request ?? {}, options);
     }
     /**
-     * Get app
+     * Get entitlement
      *
-     * Get an installed app.
+     * Get an entitlement by ID. To check entitlement access, use the entitlement
+     * access endpoints instead.
      *
-     * GET /openmeter/apps/{appId}
+     * GET /openmeter/entitlements/{entitlementId}
      */
     async get(request, options) {
-        return unwrap(await getApp(this._client, 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));
+    }
+}
+export class InternalGrants {
+    _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));
+    }
+}
+export class InternalSubscriptions {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * Unschedule subscription
+     *
+     * Deletes a scheduled subscription that has not yet become active, removing it and
+     * resolving any scheduling conflict it was holding. This is distinct from
+     * canceling: cancel ends a running subscription, whereas unscheduling removes a
+     * not-yet-active one. Only scheduled subscriptions can be unscheduled;
+     * unscheduling an active or already-started subscription is rejected.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/unschedule
+     */
+    async unschedule(request, options) {
+        return unwrap(await unscheduleSubscription(this._client, request, options));
+    }
+    /**
+     * Restore subscription
+     *
+     * Restores the subscription by deleting any later-scheduled successor
+     * subscriptions and continuing this one indefinitely. This is the inverse of a
+     * future-dated change, which schedules a successor. Restore is not available when
+     * multi-subscription is enabled.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/restore
+     */
+    async restore(request, options) {
+        return unwrap(await restoreSubscription(this._client, request, options));
+    }
+    /**
+     * Migrate subscription
+     *
+     * Migrates to a later version of the current plan. With starting_phase omitted and
+     * billing_anchor omitted or unchanged, migration amends the subscription in place:
+     * unchanged items retain their service periods and both response entries have the
+     * same ID. Existing addons must remain compatible with the target plan.
+     * Incompatible phase timelines or billing settings return an error. Providing
+     * starting_phase or a different billing_anchor explicitly requests replacement,
+     * which resets the phase timeline, may produce billing adjustments, and does not
+     * transfer addons. Custom subscriptions cannot be migrated.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/migrate
+     */
+    async migrate(request, options) {
+        return unwrap(await migrateSubscription(this._client, request, options));
+    }
+    /**
+     * Create a new subscription add-on
+     *
+     * Add add-on to a subscription.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/addons
+     */
+    async createAddon(request, options) {
+        return unwrap(await createSubscriptionAddon(this._client, request, options));
+    }
+    /**
+     * Update subscription addon
+     *
+     * Update a subscription add-on. Only the quantity is mutable; the timing controls
+     * when the new quantity takes effect. A new entry is appended to the add-on's
+     * timeline.
+     *
+     * PATCH /openmeter/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}
+     */
+    async updateAddon(request, options) {
+        return unwrap(await updateSubscriptionAddon(this._client, request, options));
+    }
+}
+export class InternalApps {
+    _client;
+    constructor(_client) {
+        this._client = _client;
     }
     /**
      * Uninstall app
@@ -296,6 +743,40 @@ export class InternalInvoices {
         return unwrap(await snapshotQuantitiesInvoice(this._client, request, options));
     }
 }
+export class InternalCharges {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * List charges
+     *
+     * List charges.
+     *
+     * Returns the charges of every customer that are represented as either flat fee or
+     * usage-based charges.
+     *
+     * GET /openmeter/charges
+     */
+    async list(request, options) {
+        return unwrap(await listCharges(this._client, request, options));
+    }
+    /**
+     * List charges
+     *
+     * List charges.
+     *
+     * Returns the charges of every customer 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/charges
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listCharges(this._client, req, opts), request ?? {}, options);
+    }
+}
 export class InternalCurrencies {
     _client;
     constructor(_client) {
@@ -379,13 +860,41 @@ export class InternalCurrencies {
         return unwrap(await createCostBasis(this._client, request, options));
     }
 }
-export class InternalGovernance {
+export class InternalPlanAddons {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * List add-ons for plan
+     *
+     * List add-ons associated with a plan.
+     *
+     * GET /openmeter/plans/{planId}/addons
+     */
+    async list(request, options) {
+        return unwrap(await listPlanAddons(this._client, request, options));
+    }
+    /**
+     * List add-ons for plan
+     *
+     * List add-ons associated with a plan.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/plans/{planId}/addons
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listPlanAddons(this._client, req, opts), request, options);
+    }
+}
+export class InternalEntitlementAccess {
     _client;
     constructor(_client) {
         this._client = _client;
     }
     /**
-     * Query governance access
+     * Query entitlement access
      *
      * Query feature access for a list of customers.
      *
@@ -396,9 +905,77 @@ export class InternalGovernance {
      * _Designed to be called on a fixed refresh interval and the query response is
      * intended to be cached._
      *
-     * POST /openmeter/governance/query
+     * POST /openmeter/entitlement-access/query
+     */
+    async query(request, options) {
+        return unwrap(await queryEntitlementAccess(this._client, request, options));
+    }
+}
+export class InternalNotifications {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * List notification channels
+     *
+     * List all notification channels.
+     *
+     * GET /openmeter/notification/channels
+     */
+    async listChannels(request, options) {
+        return unwrap(await listNotificationChannels(this._client, request, options));
+    }
+    /**
+     * List notification channels
+     *
+     * List all notification channels.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/notification/channels
+     */
+    listChannelsAll(request, options) {
+        return paginatePages((req, opts) => listNotificationChannels(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Create notification channel
+     *
+     * Create a notification channel.
+     *
+     * POST /openmeter/notification/channels
+     */
+    async createChannel(request, options) {
+        return unwrap(await createNotificationChannel(this._client, request, options));
+    }
+    /**
+     * Get notification channel
+     *
+     * Get a notification channel by id.
+     *
+     * GET /openmeter/notification/channels/{notificationChannelId}
+     */
+    async getChannel(request, options) {
+        return unwrap(await getNotificationChannel(this._client, request, options));
+    }
+    /**
+     * Update notification channel
+     *
+     * Update a notification channel by id.
+     *
+     * PUT /openmeter/notification/channels/{notificationChannelId}
+     */
+    async updateChannel(request, options) {
+        return unwrap(await updateNotificationChannel(this._client, request, options));
+    }
+    /**
+     * Delete notification channel
+     *
+     * Delete a notification channel by id.
+     *
+     * DELETE /openmeter/notification/channels/{notificationChannelId}
      */
-    async queryAccess(request, options) {
-        return unwrap(await queryGovernanceAccess(this._client, request, options));
+    async deleteChannel(request, options) {
+        return unwrap(await deleteNotificationChannel(this._client, request, options));
     }
 }