@openmeter/sdk 1.0.0-beta.197 → 1.0.0-beta.199

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

@@ -16,11 +16,16 @@ export declare class Meters {
      */
     create(meter: MeterCreate, options?: RequestOptions): Promise<{
         readonly id: string;
-        slug: string;
         description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        name?: string;
+        slug: string;
         aggregation: import("./schemas.cjs").components["schemas"]["MeterAggregation"];
-        windowSize?: import("./schemas.cjs").components["schemas"]["WindowSize"];
         eventType: string;
+        eventFrom?: Date;
         valueProperty?: string;
         groupBy?: {
             [key: string]: string;
@@ -34,11 +39,16 @@ export declare class Meters {
      */
     get(idOrSlug: operations['getMeter']['parameters']['path']['meterIdOrSlug'], options?: RequestOptions): Promise<{
         readonly id: string;
-        slug: string;
         description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        name?: string;
+        slug: string;
         aggregation: import("./schemas.cjs").components["schemas"]["MeterAggregation"];
-        windowSize?: import("./schemas.cjs").components["schemas"]["WindowSize"];
         eventType: string;
+        eventFrom?: Date;
         valueProperty?: string;
         groupBy?: {
             [key: string]: string;
@@ -51,11 +61,16 @@ export declare class Meters {
      */
     list(options?: RequestOptions): Promise<{
         readonly id: string;
-        slug: string;
         description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        name?: string;
+        slug: string;
         aggregation: import("./schemas.cjs").components["schemas"]["MeterAggregation"];
-        windowSize?: import("./schemas.cjs").components["schemas"]["WindowSize"];
         eventType: string;
+        eventFrom?: Date;
         valueProperty?: string;
         groupBy?: {
             [key: string]: string;

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

@@ -762,6 +762,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/api/v1/info/progress/{id}': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get progress
+         * @description Get progress
+         */
+        get: operations['getProgress'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/v1/marketplace/listings': {
         parameters: {
             query?: never;
@@ -5082,53 +5102,87 @@ export interface components {
          * @example {
          *       "id": "01G65Z755AFWAKHE12NY0CQ9FH",
          *       "slug": "tokens_total",
+         *       "name": "Tokens Total",
          *       "description": "AI Token Usage",
          *       "aggregation": "SUM",
-         *       "windowSize": "MINUTE",
          *       "eventType": "prompt",
          *       "valueProperty": "$.tokens",
          *       "groupBy": {
          *         "model": "$.model",
          *         "type": "$.type"
-         *       }
+         *       },
+         *       "createdAt": "2024-01-01T01:01:01.001Z",
+         *       "updatedAt": "2024-01-01T01:01:01.001Z"
          *     }
          */
         Meter: {
             /**
-             * @description A unique identifier for the meter.
+             * ID
+             * @description A unique identifier for the resource.
              * @example 01G65Z755AFWAKHE12NY0CQ9FH
              */
             readonly id: string;
+            /**
+             * Description
+             * @description Optional description of the resource. Maximum 1024 characters.
+             */
+            description?: string;
+            /**
+             * Metadata
+             * @description Additional metadata for the resource.
+             */
+            metadata?: components['schemas']['Metadata'] | null;
+            /**
+             * Creation Time
+             * Format: date-time
+             * @description Timestamp of when the resource was created.
+             * @example 2024-01-01T01:01:01.001Z
+             */
+            readonly createdAt: Date;
+            /**
+             * Last Update Time
+             * Format: date-time
+             * @description Timestamp of when the resource was last updated.
+             * @example 2024-01-01T01:01:01.001Z
+             */
+            readonly updatedAt: Date;
+            /**
+             * Deletion Time
+             * Format: date-time
+             * @description Timestamp of when the resource was permanently deleted.
+             * @example 2024-01-01T01:01:01.001Z
+             */
+            readonly deletedAt?: Date;
+            /**
+             * Display name
+             * @description Human-readable name for the resource. Between 1 and 256 characters.
+             *     Defaults to the slug if not specified.
+             */
+            name?: string;
             /**
              * @description A unique, human-readable identifier for the meter.
              *     Must consist only alphanumeric and underscore characters.
              * @example tokens_total
              */
             slug: string;
-            /**
-             * @description A description of the meter.
-             * @example AI Token Usage
-             */
-            description?: string;
             /**
              * @description The aggregation type to use for the meter.
              * @example SUM
              */
             aggregation: components['schemas']['MeterAggregation'];
-            /**
-             * @description The window size that the usage is stored in.
-             *     This controls the query granularity of the usage data.
-             *     The larger the window size, the less space is used to store the data.
-             *     By default, the window size is a minute.
-             * @default MINUTE
-             * @example MINUTE
-             */
-            windowSize?: components['schemas']['WindowSize'];
             /**
              * @description The event type to aggregate.
              * @example prompt
              */
             eventType: string;
+            /**
+             * Format: date-time
+             * @description The date since the meter should include events.
+             *     Useful to skip old events.
+             *     If not specified, all historical events are included.
+             * @example 2023-01-01T01:01:01.001Z
+             */
+            eventFrom?: Date;
             /**
              * @description JSONPath expression to extract the value from the ingested event's data property.
              *
@@ -5161,9 +5215,9 @@ export interface components {
          * @description A meter is a configuration that defines how to match and aggregate events.
          * @example {
          *       "slug": "tokens_total",
+         *       "name": "Tokens Total",
          *       "description": "AI Token Usage",
          *       "aggregation": "SUM",
-         *       "windowSize": "MINUTE",
          *       "eventType": "prompt",
          *       "valueProperty": "$.tokens",
          *       "groupBy": {
@@ -5173,36 +5227,46 @@ export interface components {
          *     }
          */
         MeterCreate: {
+            /**
+             * Description
+             * @description Optional description of the resource. Maximum 1024 characters.
+             */
+            description?: string;
+            /**
+             * Metadata
+             * @description Additional metadata for the resource.
+             */
+            metadata?: components['schemas']['Metadata'] | null;
+            /**
+             * Display name
+             * @description Human-readable name for the resource. Between 1 and 256 characters.
+             *     Defaults to the slug if not specified.
+             */
+            name?: string;
             /**
              * @description A unique, human-readable identifier for the meter.
              *     Must consist only alphanumeric and underscore characters.
              * @example tokens_total
              */
             slug: string;
-            /**
-             * @description A description of the meter.
-             * @example AI Token Usage
-             */
-            description?: string;
             /**
              * @description The aggregation type to use for the meter.
              * @example SUM
              */
             aggregation: components['schemas']['MeterAggregation'];
-            /**
-             * @description The window size that the usage is stored in.
-             *     This controls the query granularity of the usage data.
-             *     The larger the window size, the less space is used to store the data.
-             *     By default, the window size is a minute.
-             * @default MINUTE
-             * @example MINUTE
-             */
-            windowSize?: components['schemas']['WindowSize'];
             /**
              * @description The event type to aggregate.
              * @example prompt
              */
             eventType: string;
+            /**
+             * Format: date-time
+             * @description The date since the meter should include events.
+             *     Useful to skip old events.
+             *     If not specified, all historical events are included.
+             * @example 2023-01-01T01:01:01.001Z
+             */
+            eventFrom?: Date;
             /**
              * @description JSONPath expression to extract the value from the ingested event's data property.
              *
@@ -6185,6 +6249,30 @@ export interface components {
              */
             unitPrice: components['schemas']['UnitPrice'] | null;
         };
+        /** @description Progress describes a progress of a task. */
+        Progress: {
+            /**
+             * Format: uint64
+             * @description Success is the number of items that succeeded
+             */
+            success: number;
+            /**
+             * Format: uint64
+             * @description Failed is the number of items that failed
+             */
+            failed: number;
+            /**
+             * Format: uint64
+             * @description The total number of items to process
+             */
+            total: number;
+            /**
+             * Format: date-time
+             * @description The time the progress was last updated
+             * @example 2023-01-01T01:01:01.001Z
+             */
+            updatedAt: Date;
+        };
         /** @description A rate card defines the pricing and entitlement of a feature or service. */
         RateCard: components['schemas']['RateCardFlatFee'] | components['schemas']['RateCardUsageBased'];
         /** @description Entitlement template of a boolean entitlement. */
@@ -7567,6 +7655,9 @@ export interface components {
         'MarketplaceApiKeyInstallRequest.type': components['schemas']['AppType'];
         /** @description The type of the app to install. */
         'MarketplaceOAuth2InstallAuthorizeRequest.type': components['schemas']['AppType'];
+        /** @description Client ID
+         *     Useful to track progress of a query. */
+        'MeterQuery.clientId': string;
         /** @description Simple filter for group bys with exact match. */
         'MeterQuery.filterGroupBy': {
             [key: string]: string;
@@ -7889,6 +7980,7 @@ export type PortalToken = components['schemas']['PortalToken'];
 export type PreconditionFailedProblemResponse = components['schemas']['PreconditionFailedProblemResponse'];
 export type PricePaymentTerm = components['schemas']['PricePaymentTerm'];
 export type PriceTier = components['schemas']['PriceTier'];
+export type Progress = components['schemas']['Progress'];
 export type RateCard = components['schemas']['RateCard'];
 export type RateCardBooleanEntitlement = components['schemas']['RateCardBooleanEntitlement'];
 export type RateCardEntitlement = components['schemas']['RateCardEntitlement'];
@@ -7978,6 +8070,7 @@ export type ParameterLimitOffsetLimit = components['parameters']['LimitOffset.li
 export type ParameterLimitOffsetOffset = components['parameters']['LimitOffset.offset'];
 export type ParameterMarketplaceApiKeyInstallRequestType = components['parameters']['MarketplaceApiKeyInstallRequest.type'];
 export type ParameterMarketplaceOAuth2InstallAuthorizeRequestType = components['parameters']['MarketplaceOAuth2InstallAuthorizeRequest.type'];
+export type ParameterMeterQueryClientId = components['parameters']['MeterQuery.clientId'];
 export type ParameterMeterQueryFilterGroupBy = components['parameters']['MeterQuery.filterGroupBy'];
 export type ParameterMeterQueryFrom = components['parameters']['MeterQuery.from'];
 export type ParameterMeterQueryGroupBy = components['parameters']['MeterQuery.groupBy'];
@@ -11402,6 +11495,9 @@ export interface operations {
     listEvents: {
         parameters: {
             query?: {
+                /** @description Client ID
+                 *     Useful to track progress of a query. */
+                clientId?: string;
                 /** @description Start date-time in RFC 3339 format.
                  *
                  *     Inclusive. */
@@ -12200,6 +12296,91 @@ export interface operations {
             };
         };
     };
+    getProgress: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['Progress'];
+                };
+            };
+            /** @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 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'];
+                };
+            };
+        };
+    };
     listMarketplaceListings: {
         parameters: {
             query?: {
@@ -12929,6 +13110,9 @@ export interface operations {
     queryMeter: {
         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. */
@@ -15031,6 +15215,9 @@ export interface operations {
     queryPortalMeter: {
         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. */