@openmeter/sdk 1.0.0-beta.5 → 1.0.0-beta.51

package/dist/schemas/openapi.d.ts

@@ -3,29 +3,54 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
-    "/api/v1/events": {
+    '/api/v1/events': {
+        /** @description Retrieve latest raw events. */
+        get: operations['listEvents'];
         /** @description Ingest events */
-        post: operations["ingestEvents"];
+        post: operations['ingestEvents'];
     };
-    "/api/v1/meters": {
+    '/api/v1/meters': {
         /** @description List meters */
-        get: operations["listMeters"];
+        get: operations['listMeters'];
         /** @description Create meter */
-        post: operations["createMeter"];
+        post: operations['createMeter'];
     };
-    "/api/v1/meters/{meterIdOrSlug}": {
+    '/api/v1/meters/{meterIdOrSlug}': {
         /** @description Get meter by slugs */
-        get: operations["getMeter"];
+        get: operations['getMeter'];
         /** @description Delete meter by slug */
-        delete: operations["deleteMeter"];
+        delete: operations['deleteMeter'];
     };
-    "/api/v1/meters/{meterIdOrSlug}/values": {
-        /** @description Get meter values */
-        get: operations["getMeterValues"];
+    '/api/v1/meters/{meterIdOrSlug}/query': {
+        /** @description Query meter */
+        get: operations['queryMeter'];
     };
-    "/api/v1/namespaces": {
-        /** @description Create namespace */
-        post: operations["createNamespace"];
+    '/api/v1/meters/{meterIdOrSlug}/subjects': {
+        /** @description List meter subjects */
+        get: operations['listMeterSubjects'];
+    };
+    '/api/v1/portal/tokens': {
+        get: operations['listPortalTokens'];
+        post: operations['createPortalToken'];
+    };
+    '/api/v1/portal/tokens/invalidate': {
+        post: operations['invalidatePortalTokens'];
+    };
+    '/api/v1/subjects': {
+        get: operations['listSubjects'];
+        /**
+         * @description Upserts a subject. Creates or updates subject.
+         * If the subject doesn't exist, it will be created.
+         * If the subject exists, it will be partially updated with the provided fields.
+         */
+        post: operations['upsertSubject'];
+    };
+    '/api/v1/subjects/{subjectIdOrKey}': {
+        get: operations['getSubject'];
+        delete: operations['deleteSubject'];
+    };
+    '/api/v1/portal/meters/{meterSlug}/query': {
+        get: operations['queryPortalMeter'];
     };
 }
 export type webhooks = Record<string, never>;
@@ -100,7 +125,7 @@ export interface components {
              * @example application/json
              * @enum {string|null}
              */
-            datacontenttype?: "application/json" | null;
+            datacontenttype?: 'application/json' | null;
             /**
              * Format: uri
              * @description Identifies the schema that data adheres to.
@@ -128,6 +153,10 @@ export interface components {
                 [key: string]: unknown;
             };
         };
+        IngestedEvent: {
+            event: components['schemas']['Event'];
+            validationError?: string;
+        };
         Meter: {
             /**
              * @description A unique identifier for the meter.
@@ -136,7 +165,7 @@ export interface components {
             id?: string;
             /**
              * @description A unique identifier for the meter.
-             * @example my-meter
+             * @example my_meter
              */
             slug: string;
             /**
@@ -144,7 +173,8 @@ export interface components {
              * @example My Meter Description
              */
             description?: string | null;
-            aggregation: components["schemas"]["MeterAggregation"];
+            aggregation: components['schemas']['MeterAggregation'];
+            windowSize: components['schemas']['WindowSize'];
             /**
              * @description The event type to aggregate.
              * @example api_request
@@ -154,101 +184,177 @@ export interface components {
              * @description JSONPath expression to extract the value from the event data.
              * @example $.duration_ms
              */
-            valueProperty: string;
+            valueProperty?: string;
             /**
              * @description Named JSONPath expressions to extract the group by values from the event data.
              * @example {
-             *   "duration_ms": "$.duration_ms",
+             *   "method": "$.method",
              *   "path": "$.path"
              * }
              */
             groupBy?: {
                 [key: string]: string;
             };
-            windowSize: components["schemas"]["WindowSize"];
         };
         /**
          * @description The aggregation type to use for the meter.
          * @enum {string}
          */
-        MeterAggregation: "SUM" | "COUNT" | "AVG" | "MIN" | "MAX";
-        /** @enum {string} */
-        WindowSize: "MINUTE" | "HOUR" | "DAY";
-        MeterValue: {
-            /** @description The subject of the meter value. */
-            subject?: string;
+        MeterAggregation: 'SUM' | 'COUNT' | 'AVG' | 'MIN' | 'MAX';
+        /**
+         * @description Aggregation window size.
+         * @enum {string}
+         */
+        WindowSize: 'MINUTE' | 'HOUR' | 'DAY';
+        MeterQueryResult: {
+            /** Format: date-time */
+            from?: string;
+            /** Format: date-time */
+            to?: string;
+            windowSize?: components['schemas']['WindowSize'];
+            data: components['schemas']['MeterQueryRow'][];
+        };
+        MeterQueryRow: {
+            value: number;
             /** Format: date-time */
             windowStart: string;
             /** Format: date-time */
             windowEnd: string;
-            value: number;
+            /** @description The subject of the meter value. */
+            subject?: string | null;
             groupBy?: {
                 [key: string]: string;
             } | null;
         };
-        IdOrSlug: string;
-        Namespace: {
-            /**
-             * @description A namespace
-             * @example my-namesapce
-             */
-            namespace: string;
+        PortalToken: {
+            id: string;
+            subject: string;
+            /** Format: date-time */
+            expiresAt: string;
+            expired?: boolean;
+            /** Format: date-time */
+            createdAt: string;
+            /** @description The token is only returned at creation. */
+            token?: string;
+            /** @description Optional, if defined only the specified meters will be allowed */
+            allowedMeterSlugs?: string[];
+        };
+        Subject: {
+            id: string;
+            key: string;
+            displayName?: string | null;
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /** Format: date-time */
+            currentPeriodStart?: string | null;
+            /** Format: date-time */
+            currentPeriodEnd?: string | null;
+            stripeCustomerId?: string | null;
         };
+        IdOrSlug: string;
     };
     responses: {
         /** @description Bad Request */
         BadRequestProblemResponse: {
             content: {
-                "application/problem+json": components["schemas"]["Problem"];
+                'application/problem+json': components['schemas']['Problem'];
+            };
+        };
+        /** @description Unauthorized */
+        UnauthorizedProblemResponse: {
+            content: {
+                'application/problem+json': components['schemas']['Problem'];
             };
         };
         /** @description Method not allowed, feature not supported */
         MethodNotAllowedProblemResponse: {
             content: {
-                "application/problem+json": components["schemas"]["Problem"];
+                'application/problem+json': components['schemas']['Problem'];
             };
         };
         /** @description Not Found */
         NotFoundProblemResponse: {
             content: {
-                "application/problem+json": components["schemas"]["Problem"];
+                'application/problem+json': components['schemas']['Problem'];
             };
         };
         /** @description Not Implemented */
         NotImplementedProblemResponse: {
             content: {
-                "application/problem+json": components["schemas"]["Problem"];
+                'application/problem+json': components['schemas']['Problem'];
             };
         };
         /** @description Unexpected error */
         UnexpectedProblemResponse: {
             content: {
-                "application/problem+json": components["schemas"]["Problem"];
+                'application/problem+json': components['schemas']['Problem'];
             };
         };
     };
     parameters: {
         /** @description A unique identifier for the meter. */
-        meterIdOrSlug: components["schemas"]["IdOrSlug"];
-        /** @description Optional namespace */
-        namespaceParam?: string;
+        meterIdOrSlug: components['schemas']['IdOrSlug'];
+        /** @description A unique identifier for a subject. */
+        subjectIdOrKey: string;
+        /**
+         * @description Start date-time in RFC 3339 format.
+         * Inclusive.
+         */
+        queryFrom?: string;
+        /**
+         * @description End date-time in RFC 3339 format.
+         * Inclusive.
+         */
+        queryTo?: string;
+        /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
+        queryWindowSize?: components['schemas']['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.
+         */
+        queryWindowTimeZone?: string;
+        querySubject?: string[];
+        /**
+         * @description If not specified a single aggregate will be returned for each subject and time window.
+         * `subject` is a reserved group by value.
+         */
+        queryGroupBy?: string[];
     };
     requestBodies: never;
     headers: never;
     pathItems: never;
 }
+export type $defs = Record<string, never>;
 export type external = Record<string, never>;
 export interface operations {
-    /** @description Ingest events */
-    ingestEvents: {
+    /** @description Retrieve latest raw events. */
+    listEvents: {
         parameters: {
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
+            query?: {
+                from?: components['parameters']['queryFrom'];
+                to?: components['parameters']['queryTo'];
+                /** @description Number of events to return. */
+                limit?: number;
+            };
+        };
+        responses: {
+            /** @description Events response */
+            200: {
+                content: {
+                    'application/json': components['schemas']['IngestedEvent'][];
+                };
             };
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
+    };
+    /** @description Ingest events */
+    ingestEvents: {
         requestBody: {
             content: {
-                "application/cloudevents+json": components["schemas"]["Event"];
+                'application/cloudevents+json': components['schemas']['Event'];
+                'application/cloudevents-batch+json': components['schemas']['Event'][];
             };
         };
         responses: {
@@ -256,80 +362,64 @@ export interface operations {
             204: {
                 content: never;
             };
-            400: components["responses"]["BadRequestProblemResponse"];
-            default: components["responses"]["UnexpectedProblemResponse"];
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /** @description List meters */
     listMeters: {
-        parameters: {
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
-            };
-        };
         responses: {
             /** @description Meters response */
             200: {
                 content: {
-                    "application/json": components["schemas"]["Meter"][];
+                    'application/json': components['schemas']['Meter'][];
                 };
             };
-            default: components["responses"]["UnexpectedProblemResponse"];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /** @description Create meter */
     createMeter: {
-        parameters: {
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
-            };
-        };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["Meter"];
+                'application/json': components['schemas']['Meter'];
             };
         };
         responses: {
             /** @description Created */
             201: {
                 content: {
-                    "application/json": components["schemas"]["Meter"];
+                    'application/json': components['schemas']['Meter'];
                 };
             };
-            400: components["responses"]["BadRequestProblemResponse"];
-            501: components["responses"]["NotImplementedProblemResponse"];
-            default: components["responses"]["UnexpectedProblemResponse"];
+            400: components['responses']['BadRequestProblemResponse'];
+            501: components['responses']['NotImplementedProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /** @description Get meter by slugs */
     getMeter: {
         parameters: {
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
-            };
             path: {
-                meterIdOrSlug: components["parameters"]["meterIdOrSlug"];
+                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
             };
         };
         responses: {
             /** @description OK */
             200: {
                 content: {
-                    "application/json": components["schemas"]["Meter"];
+                    'application/json': components['schemas']['Meter'];
                 };
             };
-            404: components["responses"]["NotFoundProblemResponse"];
-            default: components["responses"]["UnexpectedProblemResponse"];
+            404: components['responses']['NotFoundProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /** @description Delete meter by slug */
     deleteMeter: {
         parameters: {
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
-            };
             path: {
-                meterIdOrSlug: components["parameters"]["meterIdOrSlug"];
+                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
             };
         };
         responses: {
@@ -337,75 +427,199 @@ export interface operations {
             204: {
                 content: never;
             };
-            404: components["responses"]["NotFoundProblemResponse"];
-            501: components["responses"]["NotImplementedProblemResponse"];
-            default: components["responses"]["UnexpectedProblemResponse"];
+            404: components['responses']['NotFoundProblemResponse'];
+            501: components['responses']['NotImplementedProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
-    /** @description Get meter values */
-    getMeterValues: {
+    /** @description Query meter */
+    queryMeter: {
         parameters: {
             query?: {
-                subject?: string;
-                /**
-                 * @description Start date-time in RFC 3339 format.
-                 * Must be aligned with the window size.
-                 * Inclusive.
-                 */
-                from?: string;
-                /**
-                 * @description End date-time in RFC 3339 format.
-                 * Must be aligned with the window size.
-                 * Inclusive.
-                 */
-                to?: string;
-                /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
-                windowSize?: components["schemas"]["WindowSize"];
-                /**
-                 * @description If not specified, OpenMeter will use the default aggregation type.
-                 * As OpenMeter stores aggregates defined by meter config, passing a different aggregate can lead to inaccurate results.
-                 * For example getting the MIN of SUMs.
-                 */
-                aggregation?: components["schemas"]["MeterAggregation"];
-                /** @description If not specified a single aggregate will be returned for each subject and time window. */
-                groupBy?: string;
-            };
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
+                from?: components['parameters']['queryFrom'];
+                to?: components['parameters']['queryTo'];
+                windowSize?: components['parameters']['queryWindowSize'];
+                windowTimeZone?: components['parameters']['queryWindowTimeZone'];
+                subject?: components['parameters']['querySubject'];
+                groupBy?: components['parameters']['queryGroupBy'];
             };
             path: {
-                meterIdOrSlug: components["parameters"]["meterIdOrSlug"];
+                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
             };
         };
         responses: {
             /** @description OK */
             200: {
                 content: {
-                    "application/json": {
-                        windowSize?: components["schemas"]["WindowSize"];
-                        data: components["schemas"]["MeterValue"][];
-                    };
+                    'application/json': components['schemas']['MeterQueryResult'];
+                    'text/csv': string;
                 };
             };
-            400: components["responses"]["BadRequestProblemResponse"];
-            default: components["responses"]["UnexpectedProblemResponse"];
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
-    /** @description Create namespace */
-    createNamespace: {
-        requestBody: {
+    /** @description List meter subjects */
+    listMeterSubjects: {
+        parameters: {
+            path: {
+                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    'application/json': string[];
+                };
+            };
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
+        };
+    };
+    listPortalTokens: {
+        parameters: {
+            query?: {
+                /** @description Number of portal tokens to return. Default is 25. */
+                limit?: number;
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    'application/json': components['schemas']['PortalToken'][];
+                };
+            };
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
+        };
+    };
+    createPortalToken: {
+        requestBody?: {
             content: {
-                "application/json": components["schemas"]["Namespace"];
+                'application/json': components['schemas']['PortalToken'];
             };
         };
         responses: {
-            /** @description Created */
-            201: {
+            /** @description OK */
+            200: {
+                content: {
+                    'application/json': components['schemas']['PortalToken'];
+                };
+            };
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
+        };
+    };
+    invalidatePortalTokens: {
+        requestBody?: {
+            content: {
+                'application/json': {
+                    /** @description Optional portal token ID to invalidate one token by. */
+                    id?: string;
+                    /** @description Optional subject to invalidate all tokens for subject. */
+                    subject?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description No Content */
+            204: {
+                content: never;
+            };
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
+        };
+    };
+    listSubjects: {
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    'application/json': components['schemas']['Subject'][];
+                };
+            };
+            default: components['responses']['UnexpectedProblemResponse'];
+        };
+    };
+    /**
+     * @description Upserts a subject. Creates or updates subject.
+     * If the subject doesn't exist, it will be created.
+     * If the subject exists, it will be partially updated with the provided fields.
+     */
+    upsertSubject: {
+        requestBody?: {
+            content: {
+                'application/json': components['schemas']['Subject'][];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    'application/json': components['schemas']['Subject'][];
+                };
+            };
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
+        };
+    };
+    getSubject: {
+        parameters: {
+            path: {
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    'application/json': components['schemas']['Subject'];
+                };
+            };
+            default: components['responses']['UnexpectedProblemResponse'];
+        };
+    };
+    deleteSubject: {
+        parameters: {
+            path: {
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
+            };
+        };
+        responses: {
+            /** @description No Content */
+            204: {
+                content: never;
+            };
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
+        };
+    };
+    queryPortalMeter: {
+        parameters: {
+            query?: {
+                from?: components['parameters']['queryFrom'];
+                to?: components['parameters']['queryTo'];
+                windowSize?: components['parameters']['queryWindowSize'];
+                windowTimeZone?: components['parameters']['queryWindowTimeZone'];
+                groupBy?: components['parameters']['queryGroupBy'];
+            };
+            path: {
+                meterSlug: string;
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
                 content: {
-                    "application/json": components["schemas"]["Namespace"];
+                    'application/json': components['schemas']['MeterQueryResult'];
+                    'text/csv': string;
                 };
             };
-            default: components["responses"]["UnexpectedProblemResponse"];
+            400: components['responses']['BadRequestProblemResponse'];
+            401: components['responses']['UnauthorizedProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
 }