@openmeter/sdk 1.0.0-beta.22 → 1.0.0-beta.221

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

@@ -0,0 +1,123 @@
+import type { RequestOptions } from './common.cjs';
+import type { MeterCreate, operations, paths } from './schemas.cjs';
+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.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"];
+        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.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"];
+        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.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"];
+        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<{
+        from?: Date;
+        to?: Date;
+        windowSize?: import("./schemas.cjs").components["schemas"]["WindowSize"];
+        data: import("./schemas.cjs").components["schemas"]["MeterQueryRow"][];
+    }>;
+    /**
+     * Update a meter by ID or slug
+     * @param idOrSlug - The ID or slug of the meter
+     * @param meter - The meter update data
+     * @param options - Optional request options
+     * @returns The updated meter
+     */
+    update(idOrSlug: operations['updateMeter']['parameters']['path']['meterIdOrSlug'], meter: operations['updateMeter']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<{
+        readonly id: 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"];
+        eventType: string;
+        eventFrom?: Date;
+        valueProperty?: string;
+        groupBy?: {
+            [key: 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/cjs/src/client/meters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meters.js","sourceRoot":"","sources":["../../../../src/client/meters.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAK9C;;;GAGG;AACH,MAAa,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;aAC3B;YACD,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,aAAa,EAAE,QAAQ;iBACxB;gBACD,KAAK;aACN;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EACtB,IAAI,CAC0E,CAAA;IAClF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,QAA0E,EAC1E,KAA8E,EAC9E,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE;YACnE,IAAI,EAAE,KAAK;YACX,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,aAAa,EAAE,QAAQ;iBACxB;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAjID,wBAiIC"}

package/dist/cjs/src/client/notifications.cjs

@@ -0,0 +1,249 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationEvents = exports.NotificationRules = exports.NotificationChannels = exports.Notifications = void 0;
+const utils_js_1 = require("./utils.cjs");
+/**
+ * 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.
+ */
+class Notifications {
+    client;
+    channels;
+    rules;
+    events;
+    constructor(client) {
+        this.client = client;
+        this.channels = new NotificationChannels(this.client);
+        this.rules = new NotificationRules(this.client);
+        this.events = new NotificationEvents(this.client);
+    }
+}
+exports.Notifications = Notifications;
+/**
+ * Notification Channels
+ * @description Notification channels are the destinations for notifications.
+ */
+class NotificationChannels {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a notification channel
+     * @param notification - The notification to create
+     * @param signal - An optional abort signal
+     * @returns The created notification
+     */
+    async create(notification, options) {
+        const resp = await this.client.POST('/api/v1/notification/channels', {
+            body: notification,
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Get a notification channel by ID
+     * @param id - The ID of the notification channel
+     * @param signal - An optional abort signal
+     * @returns The notification channel
+     */
+    async get(id, options) {
+        const resp = await this.client.GET('/api/v1/notification/channels/{channelId}', {
+            params: {
+                path: {
+                    channelId: id,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * 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
+     */
+    async update(id, notification, options) {
+        const resp = await this.client.PUT('/api/v1/notification/channels/{channelId}', {
+            body: notification,
+            params: {
+                path: {
+                    channelId: id,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * List notification channels
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of notification channels
+     */
+    async list(query, options) {
+        const resp = await this.client.GET('/api/v1/notification/channels', {
+            params: {
+                query,
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Delete a notification channel
+     * @param id - The ID of the notification channel
+     * @param signal - An optional abort signal
+     * @returns The deleted notification
+     */
+    async delete(id, options) {
+        const resp = await this.client.DELETE('/api/v1/notification/channels/{channelId}', {
+            params: {
+                path: {
+                    channelId: id,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.NotificationChannels = NotificationChannels;
+/**
+ * Notification Rules
+ * @description Notification rules are the conditions that trigger notifications.
+ */
+class NotificationRules {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a notification rule
+     * @param rule - The rule to create
+     * @param signal - An optional abort signal
+     * @returns The created rule
+     */
+    async create(rule, options) {
+        const resp = await this.client.POST('/api/v1/notification/rules', {
+            body: rule,
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Get a notification rule by ID
+     * @param id - The ID of the notification rule
+     * @param signal - An optional abort signal
+     * @returns The notification rule
+     */
+    async get(id, options) {
+        const resp = await this.client.GET('/api/v1/notification/rules/{ruleId}', {
+            params: {
+                path: {
+                    ruleId: id,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * 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
+     */
+    async update(id, rule, options) {
+        const resp = await this.client.PUT('/api/v1/notification/rules/{ruleId}', {
+            body: rule,
+            params: {
+                path: {
+                    ruleId: id,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * List notification rules
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of notification rules
+     */
+    async list(query, options) {
+        const resp = await this.client.GET('/api/v1/notification/rules', {
+            params: {
+                query,
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Delete a notification rule
+     * @param id - The ID of the notification rule
+     * @param signal - An optional abort signal
+     * @returns The deleted notification
+     */
+    async delete(id, options) {
+        const resp = await this.client.DELETE('/api/v1/notification/rules/{ruleId}', {
+            params: {
+                path: {
+                    ruleId: id,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.NotificationRules = NotificationRules;
+/**
+ * Notification Events
+ * @description Notification events are the events that trigger notifications.
+ */
+class NotificationEvents {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get a notification event by ID
+     * @param id - The ID of the notification event
+     * @param signal - An optional abort signal
+     * @returns The notification event
+     */
+    async get(id, options) {
+        const resp = await this.client.GET('/api/v1/notification/events/{eventId}', {
+            params: {
+                path: {
+                    eventId: id,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * List notification events
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of notification events
+     */
+    async list(query, options) {
+        const resp = await this.client.GET('/api/v1/notification/events', {
+            params: {
+                query,
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.NotificationEvents = NotificationEvents;
+//# sourceMappingURL=notifications.js.map