@openmeter/client 1.0.0-beta-2b50cff9e992 → 1.0.0-beta-ae95f83a2a40

package/dist/models/schemas.js

@@ -388,6 +388,25 @@ export const entitlementMeasureUsageFromPreset = z
 export const entitlementHistoryWindowSize = z
     .union([z.literal('PT1H'), z.literal('P1D')])
     .describe('The meter query granularities the usage history can be grouped into. Sub-hour windows are too expensive to compute and monthly windows are not supported.');
+export const stringFieldFilterExact = z
+    .union([
+    z.string(),
+    z.object({
+        eq: z
+            .string()
+            .optional()
+            .describe('Value strictly equals the given string value.'),
+        oeq: z
+            .array(z.string())
+            .optional()
+            .describe('Returns entities that exact match any of the comma-delimited phrases in the filter string.'),
+        neq: z
+            .string()
+            .optional()
+            .describe('Value does not equal the given string value.'),
+    }),
+])
+    .describe('Filters on the given string field value by exact match. All properties are optional; provide exactly one to specify the comparison.');
 export const createLabels = z
     .record(z.string(), z.string())
     .describe('Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "\\_".');
@@ -409,25 +428,6 @@ export const creditGrantStatus = z
 export const validationIssueSeverity = z
     .enum(['critical', 'warning'])
     .describe('Severity level of a billing validation issue.');
-export const stringFieldFilterExact = z
-    .union([
-    z.string(),
-    z.object({
-        eq: z
-            .string()
-            .optional()
-            .describe('Value strictly equals the given string value.'),
-        oeq: z
-            .array(z.string())
-            .optional()
-            .describe('Returns entities that exact match any of the comma-delimited phrases in the filter string.'),
-        neq: z
-            .string()
-            .optional()
-            .describe('Value does not equal the given string value.'),
-    }),
-])
-    .describe('Filters on the given string field value by exact match. All properties are optional; provide exactly one to specify the comparison.');
 export const creditGrantVoidPaymentAdjustment = z
     .enum(['none'])
     .describe('Describes how voiding a credit grant adjusts related payment state. - `none`: Voiding does not adjust invoices, payment authorization, settlement, payment intents, or external collection state.');
@@ -2250,6 +2250,20 @@ export const subscriptionEditStretchPhase = z
 export const entitlementMeasureUsageFrom = z
     .union([entitlementMeasureUsageFromPreset, dateTime])
     .describe('The time from which usage is measured, as a preset or an explicit timestamp.');
+export const getCreditBalanceParamsFilter = z
+    .object({
+    currency: stringFieldFilterExact.optional(),
+    featureKey: stringFieldFilter.optional(),
+})
+    .describe('Filter options for getting a credit balance.');
+export const listPlansParamsFilter = z
+    .object({
+    key: stringFieldFilter.optional(),
+    name: stringFieldFilter.optional(),
+    status: stringFieldFilterExact.optional(),
+    currency: stringFieldFilterExact.optional(),
+})
+    .describe('Filter options for listing plans.');
 export const updateCreditGrantExternalSettlementRequest = z
     .object({
     status: creditPurchasePaymentSettlementStatus,
@@ -2281,20 +2295,6 @@ export const validationIssue = z
         .describe('Component that reported the validation issue, if applicable.'),
 })
     .describe('A validation issue found while processing a billing resource.');
-export const getCreditBalanceParamsFilter = z
-    .object({
-    currency: stringFieldFilterExact.optional(),
-    featureKey: stringFieldFilter.optional(),
-})
-    .describe('Filter options for getting a credit balance.');
-export const listPlansParamsFilter = z
-    .object({
-    key: stringFieldFilter.optional(),
-    name: stringFieldFilter.optional(),
-    status: stringFieldFilterExact.optional(),
-    currency: stringFieldFilterExact.optional(),
-})
-    .describe('Filter options for listing plans.');
 export const voidCreditGrantRequest = z
     .object({
     paymentAdjustment: creditGrantVoidPaymentAdjustment
@@ -2725,6 +2725,13 @@ export const listCustomersParamsFilter = z
     billingProfileId: ulidFieldFilter.optional(),
 })
     .describe('Filter options for listing customers.');
+export const listCustomerEntitlementsParamsFilter = z
+    .object({
+    featureId: ulidFieldFilter.optional(),
+    featureKey: stringFieldFilterExact.optional(),
+    type: stringFieldFilterExact.optional(),
+})
+    .describe('Filter options for listing customer entitlements.');
 export const listSubscriptionsParamsFilter = z
     .object({
     id: ulidFieldFilter.optional(),
@@ -4402,6 +4409,12 @@ export const createEntitlementRequest = z
     createEntitlementBooleanRequest,
 ])
     .describe('Entitlement create request.');
+export const entitlementPagePaginatedResponse = z
+    .object({
+    data: z.array(entitlement),
+    meta: paginatedMeta,
+})
+    .describe('Page paginated response.');
 export const workflowCollectionSettings = z
     .object({
     alignment: workflowCollectionAlignment.optional().default({
@@ -5557,6 +5570,33 @@ export const getCustomerEntitlementHistoryQueryParams = z.object({
         .describe('The IANA time zone the windows are aligned to.'),
 });
 export const getCustomerEntitlementHistoryResponse = entitlementHistory;
+export const getCustomerEntitlementPathParams = z.object({
+    customerId: ulid,
+    entitlementId: ulid,
+});
+export const getCustomerEntitlementResponse = entitlement;
+export const listCustomerEntitlementsPathParams = z.object({
+    customerId: ulid,
+});
+export const listCustomerEntitlementsQueryParams = z.object({
+    page: z
+        .object({
+        size: z.coerce
+            .number()
+            .int()
+            .optional()
+            .describe('The number of items to include per page.'),
+        number: z.coerce.number().int().optional().describe('The page number.'),
+    })
+        .optional()
+        .describe('Determines which page of the collection to retrieve.'),
+    sort: sortQuery.optional(),
+    filter: listCustomerEntitlementsParamsFilter.optional(),
+});
+export const listCustomerEntitlementsResponse = z.object({
+    data: z.array(entitlement),
+    meta: paginatedMeta,
+});
 export const createCreditGrantPathParams = z.object({
     customerId: ulid,
 });
@@ -6598,6 +6638,25 @@ export const entitlementMeasureUsageFromPresetWire = z
 export const entitlementHistoryWindowSizeWire = z
     .union([z.literal('PT1H'), z.literal('P1D')])
     .describe('The meter query granularities the usage history can be grouped into. Sub-hour windows are too expensive to compute and monthly windows are not supported.');
+export const stringFieldFilterExactWire = z
+    .union([
+    z.string(),
+    z.strictObject({
+        eq: z
+            .string()
+            .optional()
+            .describe('Value strictly equals the given string value.'),
+        oeq: z
+            .array(z.string())
+            .optional()
+            .describe('Returns entities that exact match any of the comma-delimited phrases in the filter string.'),
+        neq: z
+            .string()
+            .optional()
+            .describe('Value does not equal the given string value.'),
+    }),
+])
+    .describe('Filters on the given string field value by exact match. All properties are optional; provide exactly one to specify the comparison.');
 export const createLabelsWire = z
     .record(z.string(), z.string())
     .describe('Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "\\_".');
@@ -6619,25 +6678,6 @@ export const creditGrantStatusWire = z
 export const validationIssueSeverityWire = z
     .enum(['critical', 'warning'])
     .describe('Severity level of a billing validation issue.');
-export const stringFieldFilterExactWire = z
-    .union([
-    z.string(),
-    z.strictObject({
-        eq: z
-            .string()
-            .optional()
-            .describe('Value strictly equals the given string value.'),
-        oeq: z
-            .array(z.string())
-            .optional()
-            .describe('Returns entities that exact match any of the comma-delimited phrases in the filter string.'),
-        neq: z
-            .string()
-            .optional()
-            .describe('Value does not equal the given string value.'),
-    }),
-])
-    .describe('Filters on the given string field value by exact match. All properties are optional; provide exactly one to specify the comparison.');
 export const creditGrantVoidPaymentAdjustmentWire = z
     .enum(['none'])
     .describe('Describes how voiding a credit grant adjusts related payment state. - `none`: Voiding does not adjust invoices, payment authorization, settlement, payment intents, or external collection state.');
@@ -8442,6 +8482,20 @@ export const subscriptionEditStretchPhaseWire = z
 export const entitlementMeasureUsageFromWire = z
     .union([entitlementMeasureUsageFromPresetWire, dateTimeWire])
     .describe('The time from which usage is measured, as a preset or an explicit timestamp.');
+export const getCreditBalanceParamsFilterWire = z
+    .strictObject({
+    currency: stringFieldFilterExactWire.optional(),
+    feature_key: stringFieldFilterWire.optional(),
+})
+    .describe('Filter options for getting a credit balance.');
+export const listPlansParamsFilterWire = z
+    .strictObject({
+    key: stringFieldFilterWire.optional(),
+    name: stringFieldFilterWire.optional(),
+    status: stringFieldFilterExactWire.optional(),
+    currency: stringFieldFilterExactWire.optional(),
+})
+    .describe('Filter options for listing plans.');
 export const updateCreditGrantExternalSettlementRequestWire = z
     .strictObject({
     status: creditPurchasePaymentSettlementStatusWire,
@@ -8473,20 +8527,6 @@ export const validationIssueWire = z
         .describe('Component that reported the validation issue, if applicable.'),
 })
     .describe('A validation issue found while processing a billing resource.');
-export const getCreditBalanceParamsFilterWire = z
-    .strictObject({
-    currency: stringFieldFilterExactWire.optional(),
-    feature_key: stringFieldFilterWire.optional(),
-})
-    .describe('Filter options for getting a credit balance.');
-export const listPlansParamsFilterWire = z
-    .strictObject({
-    key: stringFieldFilterWire.optional(),
-    name: stringFieldFilterWire.optional(),
-    status: stringFieldFilterExactWire.optional(),
-    currency: stringFieldFilterExactWire.optional(),
-})
-    .describe('Filter options for listing plans.');
 export const voidCreditGrantRequestWire = z
     .strictObject({
     payment_adjustment: creditGrantVoidPaymentAdjustmentWire.optional(),
@@ -8908,6 +8948,13 @@ export const listCustomersParamsFilterWire = z
     billing_profile_id: ulidFieldFilterWire.optional(),
 })
     .describe('Filter options for listing customers.');
+export const listCustomerEntitlementsParamsFilterWire = z
+    .strictObject({
+    feature_id: ulidFieldFilterWire.optional(),
+    feature_key: stringFieldFilterExactWire.optional(),
+    type: stringFieldFilterExactWire.optional(),
+})
+    .describe('Filter options for listing customer entitlements.');
 export const listSubscriptionsParamsFilterWire = z
     .strictObject({
     id: ulidFieldFilterWire.optional(),
@@ -10579,6 +10626,12 @@ export const createEntitlementRequestWire = z
     createEntitlementBooleanRequestWire,
 ])
     .describe('Entitlement create request.');
+export const entitlementPagePaginatedResponseWire = z
+    .strictObject({
+    data: z.array(entitlementWire),
+    meta: paginatedMetaWire,
+})
+    .describe('Page paginated response.');
 export const workflowCollectionSettingsWire = z
     .strictObject({
     alignment: workflowCollectionAlignmentWire.optional(),
@@ -11740,6 +11793,36 @@ export const getCustomerEntitlementHistoryQueryParamsWire = z.object({
         .describe('The IANA time zone the windows are aligned to.'),
 });
 export const getCustomerEntitlementHistoryResponseWire = entitlementHistoryWire;
+export const getCustomerEntitlementPathParamsWire = z.object({
+    customerId: ulidWire,
+    entitlementId: ulidWire,
+});
+export const getCustomerEntitlementResponseWire = entitlementWire;
+export const listCustomerEntitlementsPathParamsWire = z.object({
+    customerId: ulidWire,
+});
+export const listCustomerEntitlementsQueryParamsWire = z.object({
+    page: z
+        .strictObject({
+        size: z.coerce
+            .number()
+            .int()
+            .optional()
+            .describe('The number of items to include per page.'),
+        number: z.coerce.number().int().optional().describe('The page number.'),
+    })
+        .optional()
+        .describe('Determines which page of the collection to retrieve.'),
+    sort: z
+        .string()
+        .optional()
+        .describe('Sort entitlements returned in the response. Supported sort attributes are: - `created_at` (default) - `updated_at` The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order.'),
+    filter: listCustomerEntitlementsParamsFilterWire.optional(),
+});
+export const listCustomerEntitlementsResponseWire = z.strictObject({
+    data: z.array(entitlementWire),
+    meta: paginatedMetaWire,
+});
 export const createCreditGrantPathParamsWire = z.object({
     customerId: ulidWire,
 });

package/dist/models/types.d.ts

@@ -1881,6 +1881,26 @@ export interface SubscriptionEditStretchPhase {
     /** The ISO-8601 duration to extend the phase by. */
     extendBy: string;
 }
+/** Filter options for getting a credit balance. */
+export interface GetCreditBalanceParamsFilter {
+    /**
+     * Filter credit balance by currency code. When historical custom currencies reuse
+     * a code, each managed currency is returned as a separate balance row.
+     */
+    currency?: StringFieldFilterExact;
+    /**
+     * Filter credit balance by feature key. Omit to return the total portfolio value.
+     * Use `exists=false` to return only unrestricted balance.
+     */
+    featureKey?: StringFieldFilter;
+}
+/** Filter options for listing plans. */
+export interface ListPlansParamsFilter {
+    key?: StringFieldFilter;
+    name?: StringFieldFilter;
+    status?: StringFieldFilterExact;
+    currency?: StringFieldFilterExact;
+}
 /**
  * Request body for updating the external payment settlement status of a credit
  * grant.
@@ -1913,26 +1933,6 @@ export interface ValidationIssue {
     /** Component that reported the validation issue, if applicable. */
     component?: string;
 }
-/** Filter options for getting a credit balance. */
-export interface GetCreditBalanceParamsFilter {
-    /**
-     * Filter credit balance by currency code. When historical custom currencies reuse
-     * a code, each managed currency is returned as a separate balance row.
-     */
-    currency?: StringFieldFilterExact;
-    /**
-     * Filter credit balance by feature key. Omit to return the total portfolio value.
-     * Use `exists=false` to return only unrestricted balance.
-     */
-    featureKey?: StringFieldFilter;
-}
-/** Filter options for listing plans. */
-export interface ListPlansParamsFilter {
-    key?: StringFieldFilter;
-    name?: StringFieldFilter;
-    status?: StringFieldFilterExact;
-    currency?: StringFieldFilterExact;
-}
 /** Request body for voiding a credit grant. */
 export interface VoidCreditGrantRequest {
     /**
@@ -2523,6 +2523,15 @@ export interface ListCustomersParamsFilter {
     planKey?: StringFieldFilter;
     billingProfileId?: UlidFieldFilter;
 }
+/** Filter options for listing customer entitlements. */
+export interface ListCustomerEntitlementsParamsFilter {
+    /** Filter entitlements by feature ID. */
+    featureId?: UlidFieldFilter;
+    /** Filter entitlements by feature key. */
+    featureKey?: StringFieldFilterExact;
+    /** Filter entitlements by type (`metered`, `static` or `boolean`). */
+    type?: StringFieldFilterExact;
+}
 /** Filter options for listing subscriptions. */
 export interface ListSubscriptionsParamsFilter {
     id?: UlidFieldFilter;
@@ -4948,6 +4957,11 @@ export interface CustomerStripeCreateCheckoutSessionRequest {
      */
     stripeOptions: AppStripeCreateCheckoutSessionRequestOptions;
 }
+/** Page paginated response. */
+export interface EntitlementPagePaginatedResponse {
+    data: Entitlement[];
+    meta: PaginatedMeta;
+}
 /**
  * Workflow collection specifies how to collect the pending line items for an
  * invoice.
@@ -7811,6 +7825,11 @@ export interface CustomerStripeCreateCheckoutSessionRequestInput {
      */
     stripeOptions: AppStripeCreateCheckoutSessionRequestOptionsInput;
 }
+/** Page paginated response. */
+export interface EntitlementPagePaginatedResponseInput {
+    data: EntitlementInput[];
+    meta: PaginatedMeta;
+}
 /**
  * Workflow collection specifies how to collect the pending line items for an
  * invoice.

package/dist/sdk/internal.d.ts

@@ -1,6 +1,6 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
-import type { CreateCustomerEntitlementRequest, CreateCustomerEntitlementResponse, GetCustomerEntitlementHistoryRequest, GetCustomerEntitlementHistoryResponse, VoidCreditGrantRequest, VoidCreditGrantResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
+import type { CreateCustomerEntitlementRequest, CreateCustomerEntitlementResponse, GetCustomerEntitlementHistoryRequest, GetCustomerEntitlementHistoryResponse, GetCustomerEntitlementRequest, GetCustomerEntitlementResponse, ListCustomerEntitlementsRequest, ListCustomerEntitlementsResponse, VoidCreditGrantRequest, VoidCreditGrantResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
 import type { GetCustomerEntitlementAccessRequest, GetCustomerEntitlementAccessResponse } from '../models/operations/entitlements.js';
 import type { UnscheduleSubscriptionRequest, UnscheduleSubscriptionResponse, RestoreSubscriptionRequest, RestoreSubscriptionResponse, MigrateSubscriptionRequest, MigrateSubscriptionResponse, CreateSubscriptionAddonRequest, CreateSubscriptionAddonResponse, UpdateSubscriptionAddonRequest, UpdateSubscriptionAddonResponse } from '../models/operations/subscriptions.js';
 import type { UninstallAppRequest, UninstallAppResponse, UpdateAppRequest, UpdateAppResponse, ListAppCatalogRequest, ListAppCatalogResponse, GetAppCatalogItemRequest, GetAppCatalogItemResponse, InstallAppRequest, InstallAppResponse } from '../models/operations/apps.js';
@@ -9,7 +9,7 @@ import type { ListChargesRequest, ListChargesResponse } from '../models/operatio
 import type { ListCurrenciesRequest, ListCurrenciesResponse, CreateCustomCurrencyRequest, CreateCustomCurrencyResponse, GetCustomCurrencyRequest, GetCustomCurrencyResponse, ListCostBasesRequest, ListCostBasesResponse, CreateCostBasisRequest, CreateCostBasisResponse } from '../models/operations/currencies.js';
 import type { ListPlanAddonsRequest, ListPlanAddonsResponse } from '../models/operations/planAddons.js';
 import type { QueryEntitlementAccessRequest, QueryEntitlementAccessResponse } from '../models/operations/entitlementAccess.js';
-import type { AppCatalogItem, Charge, CostBasis, Currency, Invoice, PlanAddon } from '../models/types.js';
+import type { AppCatalogItem, Charge, CostBasis, Currency, Entitlement, Invoice, PlanAddon } from '../models/types.js';
 /**
  * Operations marked internal in the API definition. They are not part of
  * the customer surface: they may require additional permissions, and they
@@ -76,6 +76,37 @@ export declare class InternalCustomersEntitlements {
      * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/history
      */
     getHistory(request: GetCustomerEntitlementHistoryRequest, options?: RequestOptions): Promise<GetCustomerEntitlementHistoryResponse>;
+    /**
+     * 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}
+     */
+    get(request: GetCustomerEntitlementRequest, options?: RequestOptions): Promise<GetCustomerEntitlementResponse>;
+    /**
+     * 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
+     */
+    list(request: ListCustomerEntitlementsRequest, options?: RequestOptions): Promise<ListCustomerEntitlementsResponse>;
+    /**
+     * 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: ListCustomerEntitlementsRequest, options?: RequestOptions): AsyncIterable<Entitlement>;
 }
 export declare class InternalCustomersCredits {
     private readonly _client;

package/dist/sdk/internal.js

@@ -1,7 +1,7 @@
 // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
 import { paginatePages } from '../lib/paginate.js';
-import { createCustomerEntitlement, getCustomerEntitlementHistory, voidCreditGrant, listCustomerCharges, createCustomerCharges, } from '../funcs/customers.js';
+import { createCustomerEntitlement, getCustomerEntitlementHistory, getCustomerEntitlement, listCustomerEntitlements, voidCreditGrant, listCustomerCharges, createCustomerCharges, } from '../funcs/customers.js';
 import { getCustomerEntitlementAccess } from '../funcs/entitlements.js';
 import { unscheduleSubscription, restoreSubscription, migrateSubscription, createSubscriptionAddon, updateSubscriptionAddon, } from '../funcs/subscriptions.js';
 import { uninstallApp, updateApp, listAppCatalog, getAppCatalogItem, installApp, } from '../funcs/apps.js';
@@ -110,6 +110,43 @@ export class InternalCustomersEntitlements {
     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);
+    }
 }
 export class InternalCustomersCredits {
     _client;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmeter/client",
-  "version": "1.0.0-beta-2b50cff9e992",
+  "version": "1.0.0-beta-ae95f83a2a40",
   "description": "Official TypeScript SDK for the OpenMeter API — usage metering and billing",
   "keywords": [
     "openmeter",