@openmeter/sdk 1.0.0-alpha.4 → 1.0.0-beta.13

package/dist/generated/models/MeterAggregation.d.ts

@@ -1,10 +0,0 @@
-/**
- * The aggregation type to use for the meter.
- */
-export declare enum MeterAggregation {
-    SUM = "SUM",
-    COUNT = "COUNT",
-    AVG = "AVG",
-    MIN = "MIN",
-    MAX = "MAX"
-}

package/dist/generated/models/MeterAggregation.js

@@ -1,12 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-/**
- * The aggregation type to use for the meter.
- */
-export var MeterAggregation;
-(function (MeterAggregation) {
-    MeterAggregation["SUM"] = "SUM";
-    MeterAggregation["COUNT"] = "COUNT";
-    MeterAggregation["AVG"] = "AVG";
-    MeterAggregation["MIN"] = "MIN";
-    MeterAggregation["MAX"] = "MAX";
-})(MeterAggregation || (MeterAggregation = {}));

package/dist/generated/models/MeterValue.d.ts

@@ -1,10 +0,0 @@
-export type MeterValue = {
-    /**
-     * The subject of the meter value.
-     */
-    subject?: string;
-    windowStart?: string;
-    windowEnd?: string;
-    value?: number;
-    groupBy?: Record<string, string> | null;
-};

package/dist/generated/models/MeterValue.js

@@ -1,2 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export {};

package/dist/generated/models/Namespace.d.ts

@@ -1,6 +0,0 @@
-export type Namespace = {
-    /**
-     * A namespace
-     */
-    namespace: string;
-};

package/dist/generated/models/Namespace.js

@@ -1,2 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export {};

package/dist/generated/models/Problem.d.ts

@@ -1,4 +0,0 @@
-/**
- * A Problem Details object (RFC 7807)
- */
-export type Problem = Record<string, any>;

package/dist/generated/models/Problem.js

@@ -1,2 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export {};

package/dist/generated/models/WindowSize.d.ts

@@ -1,5 +0,0 @@
-export declare enum WindowSize {
-    MINUTE = "MINUTE",
-    HOUR = "HOUR",
-    DAY = "DAY"
-}

package/dist/generated/models/WindowSize.js

@@ -1,7 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export var WindowSize;
-(function (WindowSize) {
-    WindowSize["MINUTE"] = "MINUTE";
-    WindowSize["HOUR"] = "HOUR";
-    WindowSize["DAY"] = "DAY";
-})(WindowSize || (WindowSize = {}));

package/dist/generated/models/meterIdOrSlug.d.ts

@@ -1,5 +0,0 @@
-import type { IdOrSlug } from './IdOrSlug.js';
-/**
- * A unique identifier for the meter.
- */
-export type meterIdOrSlug = IdOrSlug;

package/dist/generated/models/meterIdOrSlug.js

@@ -1,2 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export {};

package/dist/generated/models/namespaceParam.d.ts

@@ -1,4 +0,0 @@
-/**
- * Optional namespace
- */
-export type namespaceParam = string;

package/dist/generated/models/namespaceParam.js

@@ -1,2 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export {};

package/dist/generated/schemas/$Event.d.ts

@@ -1,59 +0,0 @@
-export declare const $Event: {
-    readonly description: "CloudEvents Specification JSON Schema";
-    readonly properties: {
-        readonly id: {
-            readonly type: "string";
-            readonly description: "Identifies the event.";
-            readonly isRequired: true;
-            readonly minLength: 1;
-        };
-        readonly source: {
-            readonly type: "string";
-            readonly description: "Identifies the context in which an event happened.";
-            readonly isRequired: true;
-            readonly format: "uri-reference";
-            readonly minLength: 1;
-        };
-        readonly specversion: {
-            readonly type: "string";
-            readonly description: "The version of the CloudEvents specification which the event uses.";
-            readonly isRequired: true;
-            readonly minLength: 1;
-        };
-        readonly type: {
-            readonly type: "string";
-            readonly description: "Describes the type of event related to the originating occurrence.";
-            readonly isRequired: true;
-        };
-        readonly datacontenttype: {
-            readonly type: "Enum";
-            readonly isNullable: true;
-        };
-        readonly dataschema: {
-            readonly type: "string";
-            readonly description: "Identifies the schema that data adheres to.";
-            readonly isNullable: true;
-            readonly format: "uri";
-            readonly minLength: 1;
-        };
-        readonly subject: {
-            readonly type: "string";
-            readonly description: "Describes the subject of the event in the context of the event producer (identified by source).";
-            readonly isRequired: true;
-            readonly minLength: 1;
-        };
-        readonly time: {
-            readonly type: "string";
-            readonly description: "Timestamp of when the occurrence happened. Must adhere to RFC 3339.";
-            readonly isNullable: true;
-            readonly format: "date-time";
-            readonly minLength: 1;
-        };
-        readonly data: {
-            readonly type: "dictionary";
-            readonly contains: {
-                readonly properties: {};
-            };
-        };
-    };
-};

package/dist/generated/schemas/$Event.js

@@ -1,60 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export const $Event = {
-    description: `CloudEvents Specification JSON Schema`,
-    properties: {
-        id: {
-            type: 'string',
-            description: `Identifies the event.`,
-            isRequired: true,
-            minLength: 1,
-        },
-        source: {
-            type: 'string',
-            description: `Identifies the context in which an event happened.`,
-            isRequired: true,
-            format: 'uri-reference',
-            minLength: 1,
-        },
-        specversion: {
-            type: 'string',
-            description: `The version of the CloudEvents specification which the event uses.`,
-            isRequired: true,
-            minLength: 1,
-        },
-        type: {
-            type: 'string',
-            description: `Describes the type of event related to the originating occurrence.`,
-            isRequired: true,
-        },
-        datacontenttype: {
-            type: 'Enum',
-            isNullable: true,
-        },
-        dataschema: {
-            type: 'string',
-            description: `Identifies the schema that data adheres to.`,
-            isNullable: true,
-            format: 'uri',
-            minLength: 1,
-        },
-        subject: {
-            type: 'string',
-            description: `Describes the subject of the event in the context of the event producer (identified by source).`,
-            isRequired: true,
-            minLength: 1,
-        },
-        time: {
-            type: 'string',
-            description: `Timestamp of when the occurrence happened. Must adhere to RFC 3339.`,
-            isNullable: true,
-            format: 'date-time',
-            minLength: 1,
-        },
-        data: {
-            type: 'dictionary',
-            contains: {
-                properties: {},
-            },
-        },
-    },
-};

package/dist/generated/schemas/$IdOrSlug.d.ts

@@ -1,13 +0,0 @@
-export declare const $IdOrSlug: {
-    readonly type: "one-of";
-    readonly contains: readonly [{
-        readonly type: "string";
-        readonly maxLength: 26;
-        readonly minLength: 26;
-    }, {
-        readonly type: "string";
-        readonly maxLength: 63;
-        readonly minLength: 1;
-        readonly pattern: "^[a-z0-9]+(?:_[a-z0-9]+)*$";
-    }];
-};

package/dist/generated/schemas/$IdOrSlug.js

@@ -1,14 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export const $IdOrSlug = {
-    type: 'one-of',
-    contains: [{
-            type: 'string',
-            maxLength: 26,
-            minLength: 26,
-        }, {
-            type: 'string',
-            maxLength: 63,
-            minLength: 1,
-            pattern: '^[a-z0-9]+(?:_[a-z0-9]+)*$',
-        }],
-};

package/dist/generated/schemas/$Meter.d.ts

@@ -1,44 +0,0 @@
-export declare const $Meter: {
-    readonly properties: {
-        readonly id: {
-            readonly type: "string";
-            readonly description: "A unique identifier for the meter.";
-            readonly isReadOnly: true;
-        };
-        readonly slug: {
-            readonly type: "string";
-            readonly description: "A unique identifier for the meter.";
-            readonly isRequired: true;
-            readonly pattern: "^[a-z0-9]+(?:_[a-z0-9]+)*$";
-        };
-        readonly description: {
-            readonly type: "string";
-            readonly description: "A description of the meter.";
-            readonly isNullable: true;
-        };
-        readonly aggregation: {
-            readonly type: "MeterAggregation";
-            readonly isRequired: true;
-        };
-        readonly eventType: {
-            readonly type: "string";
-            readonly description: "The event type to aggregate.";
-            readonly isRequired: true;
-        };
-        readonly valueProperty: {
-            readonly type: "string";
-            readonly description: "JSONPath expression to extract the value from the event data.";
-            readonly isRequired: true;
-        };
-        readonly groupBy: {
-            readonly type: "dictionary";
-            readonly contains: {
-                readonly type: "string";
-            };
-        };
-        readonly windowSize: {
-            readonly type: "WindowSize";
-            readonly isRequired: true;
-        };
-    };
-};

package/dist/generated/schemas/$Meter.js

@@ -1,45 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export const $Meter = {
-    properties: {
-        id: {
-            type: 'string',
-            description: `A unique identifier for the meter.`,
-            isReadOnly: true,
-        },
-        slug: {
-            type: 'string',
-            description: `A unique identifier for the meter.`,
-            isRequired: true,
-            pattern: '^[a-z0-9]+(?:_[a-z0-9]+)*$',
-        },
-        description: {
-            type: 'string',
-            description: `A description of the meter.`,
-            isNullable: true,
-        },
-        aggregation: {
-            type: 'MeterAggregation',
-            isRequired: true,
-        },
-        eventType: {
-            type: 'string',
-            description: `The event type to aggregate.`,
-            isRequired: true,
-        },
-        valueProperty: {
-            type: 'string',
-            description: `JSONPath expression to extract the value from the event data.`,
-            isRequired: true,
-        },
-        groupBy: {
-            type: 'dictionary',
-            contains: {
-                type: 'string',
-            },
-        },
-        windowSize: {
-            type: 'WindowSize',
-            isRequired: true,
-        },
-    },
-};

package/dist/generated/schemas/$MeterAggregation.d.ts

@@ -1,3 +0,0 @@
-export declare const $MeterAggregation: {
-    readonly type: "Enum";
-};

package/dist/generated/schemas/$MeterAggregation.js

@@ -1,4 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export const $MeterAggregation = {
-    type: 'Enum',
-};

package/dist/generated/schemas/$MeterValue.d.ts

@@ -1,26 +0,0 @@
-export declare const $MeterValue: {
-    readonly properties: {
-        readonly subject: {
-            readonly type: "string";
-            readonly description: "The subject of the meter value.";
-        };
-        readonly windowStart: {
-            readonly type: "string";
-            readonly format: "date-time";
-        };
-        readonly windowEnd: {
-            readonly type: "string";
-            readonly format: "date-time";
-        };
-        readonly value: {
-            readonly type: "number";
-        };
-        readonly groupBy: {
-            readonly type: "dictionary";
-            readonly contains: {
-                readonly type: "string";
-            };
-            readonly isNullable: true;
-        };
-    };
-};

package/dist/generated/schemas/$MeterValue.js

@@ -1,27 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export const $MeterValue = {
-    properties: {
-        subject: {
-            type: 'string',
-            description: `The subject of the meter value.`,
-        },
-        windowStart: {
-            type: 'string',
-            format: 'date-time',
-        },
-        windowEnd: {
-            type: 'string',
-            format: 'date-time',
-        },
-        value: {
-            type: 'number',
-        },
-        groupBy: {
-            type: 'dictionary',
-            contains: {
-                type: 'string',
-            },
-            isNullable: true,
-        },
-    },
-};

package/dist/generated/schemas/$Namespace.d.ts

@@ -1,9 +0,0 @@
-export declare const $Namespace: {
-    readonly properties: {
-        readonly namespace: {
-            readonly type: "string";
-            readonly description: "A namespace";
-            readonly isRequired: true;
-        };
-    };
-};

package/dist/generated/schemas/$Namespace.js

@@ -1,10 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export const $Namespace = {
-    properties: {
-        namespace: {
-            type: 'string',
-            description: `A namespace`,
-            isRequired: true,
-        },
-    },
-};

package/dist/generated/schemas/$Problem.d.ts

@@ -1,6 +0,0 @@
-export declare const $Problem: {
-    readonly type: "dictionary";
-    readonly contains: {
-        readonly properties: {};
-    };
-};

package/dist/generated/schemas/$Problem.js

@@ -1,7 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export const $Problem = {
-    type: 'dictionary',
-    contains: {
-        properties: {},
-    },
-};

package/dist/generated/schemas/$WindowSize.d.ts

@@ -1,3 +0,0 @@
-export declare const $WindowSize: {
-    readonly type: "Enum";
-};

package/dist/generated/schemas/$WindowSize.js

@@ -1,4 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export const $WindowSize = {
-    type: 'Enum',
-};

package/dist/generated/schemas/$meterIdOrSlug.d.ts

@@ -1,4 +0,0 @@
-export declare const $meterIdOrSlug: {
-    readonly type: "IdOrSlug";
-    readonly description: "A unique identifier for the meter.";
-};

package/dist/generated/schemas/$meterIdOrSlug.js

@@ -1,5 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export const $meterIdOrSlug = {
-    type: 'IdOrSlug',
-    description: `A unique identifier for the meter.`,
-};

package/dist/generated/schemas/$namespaceParam.d.ts

@@ -1,5 +0,0 @@
-export declare const $namespaceParam: {
-    readonly type: "string";
-    readonly description: "Optional namespace";
-    readonly pattern: "^[A-Za-z0-9]+(?:_[A-Za-z0-9]+)*$";
-};

package/dist/generated/schemas/$namespaceParam.js

@@ -1,6 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export const $namespaceParam = {
-    type: 'string',
-    description: `Optional namespace`,
-    pattern: '^[A-Za-z0-9]+(?:_[A-Za-z0-9]+)*$',
-};

package/dist/generated/services/DefaultService.d.ts

@@ -1,16 +0,0 @@
-import type { BaseHttpRequest } from '../core/BaseHttpRequest.js';
-import type { CancelablePromise } from '../core/CancelablePromise.js';
-import type { Namespace } from '../models/Namespace.js';
-import type { Problem } from '../models/Problem.js';
-export declare class DefaultService {
-    readonly httpRequest: BaseHttpRequest;
-    constructor(httpRequest: BaseHttpRequest);
-    /**
-     * Create namespace
-     * @param requestBody
-     * @returns Problem Unexpected error
-     * @returns Namespace Created
-     * @throws ApiError
-     */
-    createNamespace(requestBody: Namespace): CancelablePromise<Problem | Namespace>;
-}

package/dist/generated/services/DefaultService.js

@@ -1,22 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export class DefaultService {
-    httpRequest;
-    constructor(httpRequest) {
-        this.httpRequest = httpRequest;
-    }
-    /**
-     * Create namespace
-     * @param requestBody
-     * @returns Problem Unexpected error
-     * @returns Namespace Created
-     * @throws ApiError
-     */
-    createNamespace(requestBody) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/api/v1/namespaces',
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-}

package/dist/generated/services/EventsService.d.ts

@@ -1,17 +0,0 @@
-import type { BaseHttpRequest } from '../core/BaseHttpRequest.js';
-import type { CancelablePromise } from '../core/CancelablePromise.js';
-import type { Event } from '../models/Event.js';
-import type { Problem } from '../models/Problem.js';
-export declare class EventsService {
-    readonly httpRequest: BaseHttpRequest;
-    constructor(httpRequest: BaseHttpRequest);
-    /**
-     * Ingest events
-     * @param requestBody
-     * @param omNamespace Optional namespace
-     * @returns any OK
-     * @returns Problem Unexpected error
-     * @throws ApiError
-     */
-    ingestEvents(requestBody: Event, omNamespace?: string): CancelablePromise<any | Problem>;
-}

package/dist/generated/services/EventsService.js

@@ -1,29 +0,0 @@
-/* generated using openapi-typescript-codegen -- do no edit */
-export class EventsService {
-    httpRequest;
-    constructor(httpRequest) {
-        this.httpRequest = httpRequest;
-    }
-    /**
-     * Ingest events
-     * @param requestBody
-     * @param omNamespace Optional namespace
-     * @returns any OK
-     * @returns Problem Unexpected error
-     * @throws ApiError
-     */
-    ingestEvents(requestBody, omNamespace) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/api/v1/events',
-            headers: {
-                'OM-Namespace': omNamespace,
-            },
-            body: requestBody,
-            mediaType: 'application/cloudevents+json',
-            errors: {
-                400: `Bad Request`,
-            },
-        });
-    }
-}

package/dist/generated/services/MetersService.d.ts

@@ -1,75 +0,0 @@
-import type { BaseHttpRequest } from '../core/BaseHttpRequest.js';
-import type { CancelablePromise } from '../core/CancelablePromise.js';
-import type { IdOrSlug } from '../models/IdOrSlug.js';
-import type { Meter } from '../models/Meter.js';
-import type { MeterAggregation } from '../models/MeterAggregation.js';
-import type { MeterValue } from '../models/MeterValue.js';
-import type { Problem } from '../models/Problem.js';
-import type { WindowSize } from '../models/WindowSize.js';
-export declare class MetersService {
-    readonly httpRequest: BaseHttpRequest;
-    constructor(httpRequest: BaseHttpRequest);
-    /**
-     * List meters
-     * @param omNamespace Optional namespace
-     * @returns Meter Meters response
-     * @returns Problem Unexpected error
-     * @throws ApiError
-     */
-    listMeters(omNamespace?: string): CancelablePromise<Array<Meter> | Problem>;
-    /**
-     * Create meter
-     * @param requestBody
-     * @param omNamespace Optional namespace
-     * @returns Problem Unexpected error
-     * @returns Meter Created
-     * @throws ApiError
-     */
-    createMeter(requestBody: Meter, omNamespace?: string): CancelablePromise<Problem | Meter>;
-    /**
-     * Get meter by slugs
-     * @param meterIdOrSlug A unique identifier for the meter.
-     * @param omNamespace Optional namespace
-     * @returns Meter OK
-     * @returns Problem Unexpected error
-     * @throws ApiError
-     */
-    getMeter(meterIdOrSlug: IdOrSlug, omNamespace?: string): CancelablePromise<Meter | Problem>;
-    /**
-     * Delete meter by slug
-     * @param meterIdOrSlug A unique identifier for the meter.
-     * @param omNamespace Optional namespace
-     * @returns Problem Unexpected error
-     * @throws ApiError
-     */
-    deleteMeter(meterIdOrSlug: IdOrSlug, omNamespace?: string): CancelablePromise<Problem>;
-    /**
-     * Get meter values
-     * @param meterIdOrSlug A unique identifier for the meter.
-     * @param omNamespace Optional namespace
-     * @param subject
-     * @param from Start date-time in RFC 3339 format.
-     * Must be aligned with the window size.
-     * Inclusive.
-     *
-     * @param to End date-time in RFC 3339 format.
-     * Must be aligned with the window size.
-     * Inclusive.
-     *
-     * @param windowSize If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.
-     *
-     * @param aggregation 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.
-     *
-     * @param groupBy If not specified a single aggregate will be returned for each subject and time window.
-     *
-     * @returns any OK
-     * @returns Problem Unexpected error
-     * @throws ApiError
-     */
-    getMeterValues(meterIdOrSlug: IdOrSlug, omNamespace?: string, subject?: string, from?: string, to?: string, windowSize?: WindowSize, aggregation?: MeterAggregation, groupBy?: string): CancelablePromise<{
-        windowSize?: WindowSize;
-        data: Array<MeterValue>;
-    } | Problem>;
-}