@openmeter/sdk 1.0.0-beta.2 → 1.0.0-beta.201

package/dist/src/client/meters.d.ts

@@ -0,0 +1,160 @@
+import type { RequestOptions } from './common.js';
+import type { MeterCreate, operations, paths } from './schemas.js';
+import type { Client } from 'openapi-fetch';
+/**
+ * Meters
+ * @description Meters are used to track and manage usage of your application.
+ */
+export declare class Meters {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Create a meter
+     * @param meter - The meter to create
+     * @param signal - An optional abort signal
+     * @returns The created meter
+     */
+    create(meter: MeterCreate, options?: RequestOptions): Promise<{
+        readonly id: string;
+        description?: string;
+        metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        name?: string;
+        slug: string;
+        aggregation: import("./schemas.js").components["schemas"]["MeterAggregation"];
+        eventType: string;
+        eventFrom?: Date;
+        valueProperty?: string;
+        groupBy?: {
+            [key: string]: string;
+        };
+    }>;
+    /**
+     * Get a meter by ID or slug
+     * @param idOrSlug - The ID or slug of the meter
+     * @param signal - An optional abort signal
+     * @returns The meter
+     */
+    get(idOrSlug: operations['getMeter']['parameters']['path']['meterIdOrSlug'], options?: RequestOptions): Promise<{
+        readonly id: string;
+        description?: string;
+        metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        name?: string;
+        slug: string;
+        aggregation: import("./schemas.js").components["schemas"]["MeterAggregation"];
+        eventType: string;
+        eventFrom?: Date;
+        valueProperty?: string;
+        groupBy?: {
+            [key: string]: string;
+        };
+    }>;
+    /**
+     * List meters
+     * @param signal - An optional abort signal
+     * @returns The meters
+     */
+    list(options?: RequestOptions): Promise<{
+        readonly id: string;
+        description?: string;
+        metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        name?: string;
+        slug: string;
+        aggregation: import("./schemas.js").components["schemas"]["MeterAggregation"];
+        eventType: string;
+        eventFrom?: Date;
+        valueProperty?: string;
+        groupBy?: {
+            [key: string]: string;
+        };
+    }[]>;
+    /**
+     * Query usage data for a meter by ID or slug
+     * @param idOrSlug - The ID or slug of the meter
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The meter data
+     */
+    query(idOrSlug: operations['queryMeter']['parameters']['path']['meterIdOrSlug'], query?: operations['queryMeter']['parameters']['query'], options?: RequestOptions): Promise<import("openapi-typescript-helpers").SuccessResponse<{
+        200: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./schemas.js").components["schemas"]["MeterQueryResult"];
+                "text/csv": string;
+            };
+        };
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.js").components["schemas"]["BadRequestProblemResponse"];
+            };
+        };
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.js").components["schemas"]["UnauthorizedProblemResponse"];
+            };
+        };
+        403: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.js").components["schemas"]["ForbiddenProblemResponse"];
+            };
+        };
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.js").components["schemas"]["NotFoundProblemResponse"];
+            };
+        };
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.js").components["schemas"]["InternalServerErrorProblemResponse"];
+            };
+        };
+        503: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.js").components["schemas"]["ServiceUnavailableProblemResponse"];
+            };
+        };
+        default: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.js").components["schemas"]["UnexpectedProblemResponse"];
+            };
+        };
+    }, `${string}/${string}`>>;
+    /**
+     * Delete a meter by ID or slug
+     * @param idOrSlug - The ID or slug of the meter
+     * @param signal - An optional abort signal
+     * @returns The deleted meter
+     */
+    delete(idOrSlug: operations['deleteMeter']['parameters']['path']['meterIdOrSlug'], options?: RequestOptions): Promise<undefined>;
+}

package/dist/src/client/meters.js

@@ -0,0 +1,89 @@
+import { transformResponse } from './utils.js';
+/**
+ * Meters
+ * @description Meters are used to track and manage usage of your application.
+ */
+export class Meters {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a meter
+     * @param meter - The meter to create
+     * @param signal - An optional abort signal
+     * @returns The created meter
+     */
+    async create(meter, options) {
+        const resp = await this.client.POST('/api/v1/meters', {
+            body: meter,
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Get a meter by ID or slug
+     * @param idOrSlug - The ID or slug of the meter
+     * @param signal - An optional abort signal
+     * @returns The meter
+     */
+    async get(idOrSlug, options) {
+        const resp = await this.client.GET('/api/v1/meters/{meterIdOrSlug}', {
+            params: {
+                path: {
+                    meterIdOrSlug: idOrSlug,
+                },
+            },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * List meters
+     * @param signal - An optional abort signal
+     * @returns The meters
+     */
+    async list(options) {
+        const resp = await this.client.GET('/api/v1/meters', {
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Query usage data for a meter by ID or slug
+     * @param idOrSlug - The ID or slug of the meter
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The meter data
+     */
+    async query(idOrSlug, query, options) {
+        const resp = await this.client.GET('/api/v1/meters/{meterIdOrSlug}/query', {
+            params: {
+                path: {
+                    meterIdOrSlug: idOrSlug,
+                },
+                query,
+            },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Delete a meter by ID or slug
+     * @param idOrSlug - The ID or slug of the meter
+     * @param signal - An optional abort signal
+     * @returns The deleted meter
+     */
+    async delete(idOrSlug, options) {
+        const resp = await this.client.DELETE('/api/v1/meters/{meterIdOrSlug}', {
+            params: {
+                path: {
+                    meterIdOrSlug: idOrSlug,
+                },
+            },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+}
+//# sourceMappingURL=meters.js.map

package/dist/src/client/meters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meters.js","sourceRoot":"","sources":["../../../src/client/meters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAK9C;;;GAGG;AACH,MAAM,OAAO,MAAM;IACG;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,KAAkB,EAAE,OAAwB;QAC9D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACpD,IAAI,EAAE,KAAK;YACX,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,QAAuE,EACvE,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE;YACnE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,aAAa,EAAE,QAAQ;iBACxB;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,OAAwB;QACxC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE;YACnD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAChB,QAAyE,EACzE,KAAuD,EACvD,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sCAAsC,EAAE;YACzE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,aAAa,EAAE,QAAQ;iBACxB;gBACD,KAAK;aACN;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CACjB,QAA0E,EAC1E,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,gCAAgC,EAAE;YACtE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,aAAa,EAAE,QAAQ;iBACxB;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF"}

package/dist/src/client/notifications.d.ts

@@ -0,0 +1,219 @@
+import type { RequestOptions } from './common.js';
+import type { NotificationChannel, NotificationRuleCreateRequest, operations, paths } from './schemas.js';
+import type { Client } from 'openapi-fetch';
+/**
+ * Notifications
+ * @description Notifications provide automated triggers when specific entitlement balances and usage thresholds are reached, ensuring that your customers and sales teams are always informed. Notify customers and internal teams when specific conditions are met, like reaching 75%, 100%, and 150% of their monthly usage allowance.
+ */
+export declare class Notifications {
+    private client;
+    channels: NotificationChannels;
+    rules: NotificationRules;
+    events: NotificationEvents;
+    constructor(client: Client<paths, `${string}/${string}`>);
+}
+/**
+ * Notification Channels
+ * @description Notification channels are the destinations for notifications.
+ */
+export declare class NotificationChannels {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Create a notification channel
+     * @param notification - The notification to create
+     * @param signal - An optional abort signal
+     * @returns The created notification
+     */
+    create(notification: NotificationChannel, options?: RequestOptions): Promise<{
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        readonly id: string;
+        type: "WEBHOOK";
+        name: string;
+        disabled?: boolean;
+        url: string;
+        customHeaders?: {
+            [key: string]: string;
+        };
+        signingSecret?: string;
+    }>;
+    /**
+     * Get a notification channel by ID
+     * @param id - The ID of the notification channel
+     * @param signal - An optional abort signal
+     * @returns The notification channel
+     */
+    get(id: operations['getNotificationChannel']['parameters']['path']['channelId'], options?: RequestOptions): Promise<{
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        readonly id: string;
+        type: "WEBHOOK";
+        name: string;
+        disabled?: boolean;
+        url: string;
+        customHeaders?: {
+            [key: string]: string;
+        };
+        signingSecret?: string;
+    }>;
+    /**
+     * Update a notification channel
+     * @param id - The ID of the notification channel
+     * @param notification - The notification to update
+     * @param signal - An optional abort signal
+     * @returns The updated notification
+     */
+    update(id: operations['updateNotificationChannel']['parameters']['path']['channelId'], notification: NotificationChannel, options?: RequestOptions): Promise<{
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        readonly id: string;
+        type: "WEBHOOK";
+        name: string;
+        disabled?: boolean;
+        url: string;
+        customHeaders?: {
+            [key: string]: string;
+        };
+        signingSecret?: string;
+    }>;
+    /**
+     * List notification channels
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of notification channels
+     */
+    list(query?: operations['listNotificationChannels']['parameters']['query'], options?: RequestOptions): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.js").components["schemas"]["NotificationChannel"][];
+    }>;
+    /**
+     * Delete a notification channel
+     * @param id - The ID of the notification channel
+     * @param signal - An optional abort signal
+     * @returns The deleted notification
+     */
+    delete(id: operations['deleteNotificationChannel']['parameters']['path']['channelId'], options?: RequestOptions): Promise<undefined>;
+}
+/**
+ * Notification Rules
+ * @description Notification rules are the conditions that trigger notifications.
+ */
+export declare class NotificationRules {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Create a notification rule
+     * @param rule - The rule to create
+     * @param signal - An optional abort signal
+     * @returns The created rule
+     */
+    create(rule: NotificationRuleCreateRequest, options?: RequestOptions): Promise<{
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        readonly id: string;
+        type: "entitlements.balance.threshold";
+        name: string;
+        disabled?: boolean;
+        channels: import("./schemas.js").components["schemas"]["NotificationChannelMeta"][];
+        thresholds: import("./schemas.js").components["schemas"]["NotificationRuleBalanceThresholdValue"][];
+        features?: import("./schemas.js").components["schemas"]["FeatureMeta"][];
+    }>;
+    /**
+     * Get a notification rule by ID
+     * @param id - The ID of the notification rule
+     * @param signal - An optional abort signal
+     * @returns The notification rule
+     */
+    get(id: operations['getNotificationRule']['parameters']['path']['ruleId'], options?: RequestOptions): Promise<{
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        readonly id: string;
+        type: "entitlements.balance.threshold";
+        name: string;
+        disabled?: boolean;
+        channels: import("./schemas.js").components["schemas"]["NotificationChannelMeta"][];
+        thresholds: import("./schemas.js").components["schemas"]["NotificationRuleBalanceThresholdValue"][];
+        features?: import("./schemas.js").components["schemas"]["FeatureMeta"][];
+    }>;
+    /**
+     * Update a notification rule
+     * @param id - The ID of the notification rule
+     * @param rule - The rule to update
+     * @param signal - An optional abort signal
+     * @returns The updated rule
+     */
+    update(id: operations['updateNotificationRule']['parameters']['path']['ruleId'], rule: NotificationRuleCreateRequest, options?: RequestOptions): Promise<{
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        readonly id: string;
+        type: "entitlements.balance.threshold";
+        name: string;
+        disabled?: boolean;
+        channels: import("./schemas.js").components["schemas"]["NotificationChannelMeta"][];
+        thresholds: import("./schemas.js").components["schemas"]["NotificationRuleBalanceThresholdValue"][];
+        features?: import("./schemas.js").components["schemas"]["FeatureMeta"][];
+    }>;
+    /**
+     * List notification rules
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of notification rules
+     */
+    list(query?: operations['listNotificationRules']['parameters']['query'], options?: RequestOptions): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.js").components["schemas"]["NotificationRule"][];
+    }>;
+    /**
+     * Delete a notification rule
+     * @param id - The ID of the notification rule
+     * @param signal - An optional abort signal
+     * @returns The deleted notification
+     */
+    delete(id: operations['deleteNotificationRule']['parameters']['path']['ruleId'], options?: RequestOptions): Promise<undefined>;
+}
+/**
+ * Notification Events
+ * @description Notification events are the events that trigger notifications.
+ */
+export declare class NotificationEvents {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Get a notification event by ID
+     * @param id - The ID of the notification event
+     * @param signal - An optional abort signal
+     * @returns The notification event
+     */
+    get(id: operations['getNotificationEvent']['parameters']['path']['eventId'], options?: RequestOptions): Promise<{
+        readonly id: string;
+        readonly type: import("./schemas.js").components["schemas"]["NotificationEventType"];
+        readonly createdAt: Date;
+        readonly rule: import("./schemas.js").components["schemas"]["NotificationRule"];
+        readonly deliveryStatus: import("./schemas.js").components["schemas"]["NotificationEventDeliveryStatus"][];
+        readonly payload: import("./schemas.js").components["schemas"]["NotificationEventPayload"];
+        readonly annotations?: import("./schemas.js").components["schemas"]["Annotations"];
+    }>;
+    /**
+     * List notification events
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of notification events
+     */
+    list(query?: operations['listNotificationEvents']['parameters']['query'], options?: RequestOptions): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.js").components["schemas"]["NotificationEvent"][];
+    }>;
+}