@openmeter/sdk 1.0.0-beta-bb4645e4fad7 → 1.0.0-beta-56a331f85792

package/dist/cjs/src/client/customers.d.cts

@@ -590,6 +590,9 @@ export declare class CustomerEntitlementsV2 {
         readonly overage?: number;
         readonly totalAvailableGrantAmount?: number;
         readonly config?: string;
+        readonly grantBalances?: {
+            [key: string]: number;
+        };
     } | undefined>;
     /**
      * Get the history of a customer entitlement

package/dist/cjs/src/client/schemas.d.cts

@@ -1011,29 +1011,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    '/api/v1/features/{featureId}/cost': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Query feature cost
-         * @description Query the cost of a feature based on its unit cost configuration and underlying meter usage.
-         *     For features with manual unit cost, the cost is usage × fixed amount.
-         *     For features with LLM unit cost, the cost is resolved per row from the LLM cost database.
-         *     The feature must have a meter and unit cost configured.
-         */
-        get: operations['queryFeatureCost'];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     '/api/v1/grants': {
         parameters: {
             query?: never;
@@ -5796,6 +5773,50 @@ export interface components {
              */
             readonly config?: string;
         };
+        /** @description EntitlementValueV2 returns entitlement access state and value fields for customer-scoped V2 APIs. */
+        EntitlementValueV2: {
+            /**
+             * @description Whether the subject has access to the feature. Shared accross all entitlement types.
+             * @example true
+             */
+            readonly hasAccess: boolean;
+            /**
+             * Format: double
+             * @description Only available for metered entitlements. Metered entitlements are built around a balance calculation where feature usage is deducted from the issued grants. Balance represents the remaining balance of the entitlement, it's value never turns negative.
+             * @example 100
+             */
+            readonly balance?: number;
+            /**
+             * Format: double
+             * @description Only available for metered entitlements. Returns the total feature usage in the current period.
+             * @example 50
+             */
+            readonly usage?: number;
+            /**
+             * Format: double
+             * @description Only available for metered entitlements. Overage represents the usage that wasn't covered by grants, e.g. if the subject had a total feature usage of 100 in the period but they were only granted 80, there would be 20 overage.
+             * @example 0
+             */
+            readonly overage?: number;
+            /**
+             * Format: double
+             * @description Only available for metered entitlements. The summed amount of all grant active at query time PLUS the used amount of since inactive grants.
+             * @example 100
+             */
+            readonly totalAvailableGrantAmount?: number;
+            /**
+             * @description Only available for static entitlements. The JSON parsable config of the entitlement.
+             * @example { key: "value" }
+             */
+            readonly config?: string;
+            /**
+             * @description Only available for metered entitlements. The closing balance of each active grant at query time.
+             *     The key is the grant ID and the value is the remaining balance.
+             */
+            readonly grantBalances?: {
+                [key: string]: number;
+            };
+        };
         /** @description Generic ErrorExtension as part of HTTPProblem.Extensions.[StatusCode] */
         ErrorExtension: {
             /**
@@ -6024,58 +6045,6 @@ export interface components {
              */
             readonly id: string;
         };
-        /** @description Result of a feature cost query. */
-        FeatureCostQueryResult: {
-            /**
-             * Format: date-time
-             * @description Start of the queried period.
-             * @example 2023-01-01T01:01:01.001Z
-             */
-            from?: Date;
-            /**
-             * Format: date-time
-             * @description End of the queried period.
-             * @example 2023-01-01T01:01:01.001Z
-             */
-            to?: Date;
-            /** @description The window size that the cost is aggregated. */
-            windowSize?: components['schemas']['WindowSize'];
-            /** @description The currency code of the cost amounts. */
-            currency: components['schemas']['CurrencyCode'];
-            /** @description The cost data rows. */
-            data: components['schemas']['FeatureCostQueryRow'][];
-        };
-        /** @description A row in the result of a feature cost query. */
-        FeatureCostQueryRow: {
-            /** @description The metered usage value for the period. */
-            usage: components['schemas']['Numeric'];
-            /** @description The computed cost amount (usage × unit cost). Null when pricing is not available for the group-by combination. */
-            cost: (string & components['schemas']['Numeric']) | null;
-            /** @description The currency code of the cost amount. */
-            currency: components['schemas']['CurrencyCode'];
-            /** @description Detail message when cost amount is null, explaining why the cost could not be resolved. */
-            detail?: string;
-            /**
-             * Format: date-time
-             * @description The start of the window the value is aggregated over.
-             * @example 2023-01-01T01:01:01.001Z
-             */
-            windowStart: Date;
-            /**
-             * Format: date-time
-             * @description The end of the window the value is aggregated over.
-             * @example 2023-01-01T01:01:01.001Z
-             */
-            windowEnd: Date;
-            /** @description The subject the value is aggregated over. */
-            subject?: string;
-            /** @description The customer ID the value is aggregated over. */
-            customerId?: string;
-            /** @description The group by values the value is aggregated over. */
-            groupBy?: {
-                [key: string]: string | null;
-            };
-        };
         /**
          * @description Represents a feature that can be enabled or disabled for a plan.
          *     Used both for product catalog and entitlements.
@@ -12316,14 +12285,13 @@ export type EntitlementV2 = components['schemas']['EntitlementV2'];
 export type EntitlementV2CreateInputs = components['schemas']['EntitlementV2CreateInputs'];
 export type EntitlementV2PaginatedResponse = components['schemas']['EntitlementV2PaginatedResponse'];
 export type EntitlementValue = components['schemas']['EntitlementValue'];
+export type EntitlementValueV2 = components['schemas']['EntitlementValueV2'];
 export type ErrorExtension = components['schemas']['ErrorExtension'];
 export type Event = components['schemas']['Event'];
 export type EventDeliveryAttemptResponse = components['schemas']['EventDeliveryAttemptResponse'];
 export type ExpirationDuration = components['schemas']['ExpirationDuration'];
 export type ExpirationPeriod = components['schemas']['ExpirationPeriod'];
 export type Feature = components['schemas']['Feature'];
-export type FeatureCostQueryResult = components['schemas']['FeatureCostQueryResult'];
-export type FeatureCostQueryRow = components['schemas']['FeatureCostQueryRow'];
 export type FeatureCreateInputs = components['schemas']['FeatureCreateInputs'];
 export type FeatureLlmUnitCost = components['schemas']['FeatureLLMUnitCost'];
 export type FeatureLlmUnitCostPricing = components['schemas']['FeatureLLMUnitCostPricing'];
@@ -18617,168 +18585,6 @@ export interface operations {
             };
         };
     };
-    queryFeatureCost: {
-        parameters: {
-            query?: {
-                /**
-                 * @description Client ID
-                 *     Useful to track progress of a query.
-                 */
-                clientId?: components['parameters']['MeterQuery.clientId'];
-                /**
-                 * @description Start date-time in RFC 3339 format.
-                 *
-                 *     Inclusive.
-                 *
-                 *     For example: ?from=2025-01-01T00%3A00%3A00.000Z
-                 */
-                from?: components['parameters']['MeterQuery.from'];
-                /**
-                 * @description End date-time in RFC 3339 format.
-                 *
-                 *     Inclusive.
-                 *
-                 *     For example: ?to=2025-02-01T00%3A00%3A00.000Z
-                 */
-                to?: components['parameters']['MeterQuery.to'];
-                /**
-                 * @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.
-                 *
-                 *     For example: ?windowSize=DAY
-                 */
-                windowSize?: components['parameters']['MeterQuery.windowSize'];
-                /**
-                 * @description The value is the name of the time zone as defined in the IANA Time Zone Database (http://www.iana.org/time-zones).
-                 *     If not specified, the UTC timezone will be used.
-                 *
-                 *     For example: ?windowTimeZone=UTC
-                 */
-                windowTimeZone?: components['parameters']['MeterQuery.windowTimeZone'];
-                /**
-                 * @description Filtering by multiple subjects.
-                 *
-                 *     For example: ?subject=subject-1&subject=subject-2
-                 */
-                subject?: components['parameters']['MeterQuery.subject'];
-                /**
-                 * @description Filtering by multiple customers.
-                 *
-                 *     For example: ?filterCustomerId=customer-1&filterCustomerId=customer-2
-                 */
-                filterCustomerId?: components['parameters']['MeterQuery.filterCustomerId'];
-                /**
-                 * @deprecated
-                 * @description Simple filter for group bys with exact match.
-                 *
-                 *     For example: ?filterGroupBy[vendor]=openai&filterGroupBy[model]=gpt-4-turbo
-                 *
-                 *     ⚠️ __Deprecated__: Use `advancedMeterGroupByFilters` instead
-                 */
-                filterGroupBy?: components['parameters']['MeterQuery.filterGroupBy'];
-                /**
-                 * @description Optional advanced meter group by filters.
-                 *     You can use this to filter for values of the meter groupBy fields.
-                 */
-                advancedMeterGroupByFilters?: components['parameters']['MeterQuery.advancedMeterGroupByFilters'];
-                /**
-                 * @description If not specified a single aggregate will be returned for each subject and time window.
-                 *     `subject` is a reserved group by value.
-                 *
-                 *     For example: ?groupBy=subject&groupBy=model
-                 */
-                groupBy?: components['parameters']['MeterQuery.groupBy'];
-            };
-            header?: never;
-            path: {
-                featureId: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description The request has succeeded. */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['FeatureCostQueryResult'];
-                };
-            };
-            /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/problem+json': components['schemas']['BadRequestProblemResponse'];
-                };
-            };
-            /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
-                };
-            };
-            /** @description The server understood the request but refuses to authorize it. */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
-                };
-            };
-            /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/problem+json': components['schemas']['NotFoundProblemResponse'];
-                };
-            };
-            /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
-            412: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
-                };
-            };
-            /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
-            500: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
-                };
-            };
-            /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
-            503: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
-                };
-            };
-            /** @description An unexpected error response. */
-            default: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
-                };
-            };
-        };
-    };
     listGrants: {
         parameters: {
             query?: {
@@ -27518,7 +27324,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    'application/json': components['schemas']['EntitlementValue'];
+                    'application/json': components['schemas']['EntitlementValueV2'];
                 };
             };
             /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */