@openmeter/sdk 1.0.0-alpha.3 → 1.0.0-beta-7b2d9ed372e3

package/dist/src/notifications.js

@@ -0,0 +1,242 @@
+import { transformResponse } from './utils.js';
+/**
+ * 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 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);
+    }
+}
+/**
+ * Notification Channels
+ * @description Notification channels are the destinations for notifications.
+ */
+export 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, signal) {
+        const resp = await this.client.POST('/api/v1/notification/channels', {
+            signal,
+            body: notification,
+        });
+        return 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, signal) {
+        const resp = await this.client.GET('/api/v1/notification/channels/{channelId}', {
+            signal,
+            params: {
+                path: {
+                    channelId: id,
+                },
+            },
+        });
+        return 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, signal) {
+        const resp = await this.client.PUT('/api/v1/notification/channels/{channelId}', {
+            signal,
+            params: {
+                path: {
+                    channelId: id,
+                },
+            },
+            body: notification,
+        });
+        return 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, signal) {
+        const resp = await this.client.GET('/api/v1/notification/channels', {
+            signal,
+            params: {
+                query,
+            },
+        });
+        return 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, signal) {
+        const resp = await this.client.DELETE('/api/v1/notification/channels/{channelId}', {
+            signal,
+            params: {
+                path: {
+                    channelId: id,
+                },
+            },
+        });
+        return transformResponse(resp);
+    }
+}
+/**
+ * Notification Rules
+ * @description Notification rules are the conditions that trigger notifications.
+ */
+export 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, signal) {
+        const resp = await this.client.POST('/api/v1/notification/rules', {
+            signal,
+            body: rule,
+        });
+        return 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, signal) {
+        const resp = await this.client.GET('/api/v1/notification/rules/{ruleId}', {
+            signal,
+            params: {
+                path: {
+                    ruleId: id,
+                },
+            },
+        });
+        return 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, signal) {
+        const resp = await this.client.PUT('/api/v1/notification/rules/{ruleId}', {
+            signal,
+            params: {
+                path: {
+                    ruleId: id,
+                },
+            },
+            body: rule,
+        });
+        return 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, signal) {
+        const resp = await this.client.GET('/api/v1/notification/rules', {
+            signal,
+            params: {
+                query,
+            },
+        });
+        return 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, signal) {
+        const resp = await this.client.DELETE('/api/v1/notification/rules/{ruleId}', {
+            signal,
+            params: {
+                path: {
+                    ruleId: id,
+                },
+            },
+        });
+        return transformResponse(resp);
+    }
+}
+/**
+ * Notification Events
+ * @description Notification events are the events that trigger notifications.
+ */
+export 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, signal) {
+        const resp = await this.client.GET('/api/v1/notification/events/{eventId}', {
+            signal,
+            params: {
+                path: {
+                    eventId: id,
+                },
+            },
+        });
+        return 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, signal) {
+        const resp = await this.client.GET('/api/v1/notification/events', {
+            signal,
+            params: {
+                query,
+            },
+        });
+        return transformResponse(resp);
+    }
+}
+//# sourceMappingURL=notifications.js.map

package/dist/src/notifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../../src/notifications.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAS9C;;;GAGG;AACH,MAAM,OAAO,aAAa;IAKJ;IAJb,QAAQ,CAAsB;IAC9B,KAAK,CAAmB;IACxB,MAAM,CAAoB;IAEjC,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;QAC9D,IAAI,CAAC,QAAQ,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACrD,IAAI,CAAC,KAAK,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACnD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IACX;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,YAAiC,EAAE,MAAoB;QACzE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,+BAA+B,EAAE;YACnE,MAAM;YACN,IAAI,EAAE,YAAY;SACnB,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,EAA2E,EAC3E,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,2CAA2C,EAC3C;YACE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,SAAS,EAAE,EAAE;iBACd;aACF;SACF,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,EAA8E,EAC9E,YAAiC,EACjC,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,2CAA2C,EAC3C;YACE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,SAAS,EAAE,EAAE;iBACd;aACF;YACD,IAAI,EAAE,YAAY;SACnB,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,KAAqE,EACrE,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,+BAA+B,EAAE;YAClE,MAAM;YACN,MAAM,EAAE;gBACN,KAAK;aACN;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CACjB,EAA8E,EAC9E,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACnC,2CAA2C,EAC3C;YACE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,SAAS,EAAE,EAAE;iBACd;aACF;SACF,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IACR;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CACjB,IAAmC,EACnC,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,4BAA4B,EAAE;YAChE,MAAM;YACN,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,EAAqE,EACrE,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACxE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,EAAwE,EACxE,IAAmC,EACnC,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACxE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;YACD,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,KAAkE,EAClE,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,4BAA4B,EAAE;YAC/D,MAAM;YACN,MAAM,EAAE;gBACN,KAAK;aACN;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CACjB,EAAwE,EACxE,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACnC,qCAAqC,EACrC;YACE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;SACF,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IACT;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,EAAuE,EACvE,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,uCAAuC,EACvC;YACE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,OAAO,EAAE,EAAE;iBACZ;aACF;SACF,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,KAAmE,EACnE,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,EAAE;YAChE,MAAM;YACN,MAAM,EAAE;gBACN,KAAK;aACN;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF"}

package/dist/src/plans.d.ts

@@ -0,0 +1,192 @@
+import type { operations, paths, PlanCreate, PlanReplaceUpdate } from './schemas.js';
+import type { Client } from 'openapi-fetch';
+export declare class Plans {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Create a plan
+     * @param plan - The plan to create
+     * @param signal - An optional abort signal
+     * @returns The created plan
+     */
+    create(plan: PlanCreate, signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: {
+            readonly id: string;
+            name: string;
+            description?: string;
+            metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+            readonly createdAt: Date;
+            readonly updatedAt: Date;
+            readonly deletedAt?: Date;
+            key: string;
+            readonly version: number;
+            currency: import("./schemas.js").components["schemas"]["CurrencyCode"];
+            readonly effectiveFrom?: Date;
+            readonly effectiveTo?: Date;
+            readonly status: import("./schemas.js").components["schemas"]["PlanStatus"];
+            phases: import("./schemas.js").components["schemas"]["PlanPhase"][];
+        };
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * Get a plan by ID or key
+     * @param idOrKey - The ID or key of the plan
+     * @param signal - An optional abort signal
+     * @returns The plan
+     */
+    get(id: operations['getPlan']['parameters']['path']['planId'], signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: {
+            readonly id: string;
+            name: string;
+            description?: string;
+            metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+            readonly createdAt: Date;
+            readonly updatedAt: Date;
+            readonly deletedAt?: Date;
+            key: string;
+            readonly version: number;
+            currency: import("./schemas.js").components["schemas"]["CurrencyCode"];
+            readonly effectiveFrom?: Date;
+            readonly effectiveTo?: Date;
+            readonly status: import("./schemas.js").components["schemas"]["PlanStatus"];
+            phases: import("./schemas.js").components["schemas"]["PlanPhase"][];
+        };
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * List plans
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of plans
+     */
+    list(query?: operations['listPlans']['parameters']['query'], signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: {
+            totalCount: number;
+            page: number;
+            pageSize: number;
+            items: import("./schemas.js").components["schemas"]["Plan"][];
+        };
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * Update a plan
+     * @param id - The ID of the plan
+     * @param plan - The plan to update
+     * @param signal - An optional abort signal
+     * @returns The updated plan
+     */
+    update(id: operations['updatePlan']['parameters']['path']['planId'], plan: PlanReplaceUpdate, signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: {
+            readonly id: string;
+            name: string;
+            description?: string;
+            metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+            readonly createdAt: Date;
+            readonly updatedAt: Date;
+            readonly deletedAt?: Date;
+            key: string;
+            readonly version: number;
+            currency: import("./schemas.js").components["schemas"]["CurrencyCode"];
+            readonly effectiveFrom?: Date;
+            readonly effectiveTo?: Date;
+            readonly status: import("./schemas.js").components["schemas"]["PlanStatus"];
+            phases: import("./schemas.js").components["schemas"]["PlanPhase"][];
+        };
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * Delete a plan
+     * @param id - The ID of the plan
+     * @param signal - An optional abort signal
+     * @returns The deleted plan
+     */
+    delete(id: operations['deletePlan']['parameters']['path']['planId'], signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: undefined;
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * Archive a plan
+     * @param id - The ID of the plan
+     * @param signal - An optional abort signal
+     * @returns The archived plan
+     */
+    archive(id: operations['archivePlan']['parameters']['path']['planId'], signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: {
+            readonly id: string;
+            name: string;
+            description?: string;
+            metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+            readonly createdAt: Date;
+            readonly updatedAt: Date;
+            readonly deletedAt?: Date;
+            key: string;
+            readonly version: number;
+            currency: import("./schemas.js").components["schemas"]["CurrencyCode"];
+            readonly effectiveFrom?: Date;
+            readonly effectiveTo?: Date;
+            readonly status: import("./schemas.js").components["schemas"]["PlanStatus"];
+            phases: import("./schemas.js").components["schemas"]["PlanPhase"][];
+        };
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * Publish a plan
+     * @param id - The ID of the plan
+     * @param signal - An optional abort signal
+     * @returns The published plan
+     */
+    publish(id: operations['publishPlan']['parameters']['path']['planId'], signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: {
+            readonly id: string;
+            name: string;
+            description?: string;
+            metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+            readonly createdAt: Date;
+            readonly updatedAt: Date;
+            readonly deletedAt?: Date;
+            key: string;
+            readonly version: number;
+            currency: import("./schemas.js").components["schemas"]["CurrencyCode"];
+            readonly effectiveFrom?: Date;
+            readonly effectiveTo?: Date;
+            readonly status: import("./schemas.js").components["schemas"]["PlanStatus"];
+            phases: import("./schemas.js").components["schemas"]["PlanPhase"][];
+        };
+        error?: never;
+        response: Response;
+    }>;
+}

package/dist/src/plans.js

@@ -0,0 +1,123 @@
+import { transformResponse } from './utils.js';
+export class Plans {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a plan
+     * @param plan - The plan to create
+     * @param signal - An optional abort signal
+     * @returns The created plan
+     */
+    async create(plan, signal) {
+        const resp = await this.client.POST('/api/v1/plans', {
+            signal,
+            body: plan,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Get a plan by ID or key
+     * @param idOrKey - The ID or key of the plan
+     * @param signal - An optional abort signal
+     * @returns The plan
+     */
+    async get(id, signal) {
+        const resp = await this.client.GET('/api/v1/plans/{planId}', {
+            signal,
+            params: {
+                path: {
+                    planId: id,
+                },
+            },
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * List plans
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of plans
+     */
+    async list(query, signal) {
+        const resp = await this.client.GET('/api/v1/plans', {
+            signal,
+            params: {
+                query,
+            },
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Update a plan
+     * @param id - The ID of the plan
+     * @param plan - The plan to update
+     * @param signal - An optional abort signal
+     * @returns The updated plan
+     */
+    async update(id, plan, signal) {
+        const resp = await this.client.PUT('/api/v1/plans/{planId}', {
+            signal,
+            body: plan,
+            params: {
+                path: {
+                    planId: id,
+                },
+            },
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Delete a plan
+     * @param id - The ID of the plan
+     * @param signal - An optional abort signal
+     * @returns The deleted plan
+     */
+    async delete(id, signal) {
+        const resp = await this.client.DELETE('/api/v1/plans/{planId}', {
+            signal,
+            params: {
+                path: {
+                    planId: id,
+                },
+            },
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Archive a plan
+     * @param id - The ID of the plan
+     * @param signal - An optional abort signal
+     * @returns The archived plan
+     */
+    async archive(id, signal) {
+        const resp = await this.client.POST('/api/v1/plans/{planId}/archive', {
+            signal,
+            params: {
+                path: {
+                    planId: id,
+                },
+            },
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Publish a plan
+     * @param id - The ID of the plan
+     * @param signal - An optional abort signal
+     * @returns The published plan
+     */
+    async publish(id, signal) {
+        const resp = await this.client.POST('/api/v1/plans/{planId}/publish', {
+            signal,
+            params: {
+                path: {
+                    planId: id,
+                },
+            },
+        });
+        return transformResponse(resp);
+    }
+}
+//# sourceMappingURL=plans.js.map

package/dist/src/plans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plans.js","sourceRoot":"","sources":["../../src/plans.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAS9C,MAAM,OAAO,KAAK;IACI;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,IAAgB,EAAE,MAAoB;QACxD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE;YACnD,MAAM;YACN,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,EAAyD,EACzD,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;YAC3D,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,KAAsD,EACtD,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,EAAE;YAClD,MAAM;YACN,MAAM,EAAE;gBACN,KAAK;aACN;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,EAA4D,EAC5D,IAAuB,EACvB,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;YAC3D,MAAM;YACN,IAAI,EAAE,IAAI;YACV,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CACjB,EAA4D,EAC5D,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,wBAAwB,EAAE;YAC9D,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAClB,EAA6D,EAC7D,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACpE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAClB,EAA6D,EAC7D,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACpE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF"}

package/dist/src/portal/index.d.ts

@@ -0,0 +1,113 @@
+import type { RequestOptions } from '../client/utils.js';
+import type { ClientOptions } from 'openapi-fetch';
+export type { RequestOptions } from '../client/utils.js';
+/**
+ * Portal Config
+ */
+export type Config = Pick<ClientOptions, 'baseUrl' | 'headers' | 'fetch' | 'Request' | 'requestInitExt'> & {
+    portalToken: string;
+};
+/**
+ * OpenMeter Portal Client
+ * Access to the customer portal.
+ */
+export declare class OpenMeter {
+    private client;
+    constructor(config: Config);
+    /**
+     * Query usage data for a meter by slug for customer portal.
+     * This endpoint is publicly exposable to consumers.
+     * @param meterSlug - The slug of the meter
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The meter data
+     */
+    query(meterSlug: string, query?: {
+        /** @description Start date-time in RFC 3339 format. Inclusive. */
+        from?: string | Date;
+        /** @description End date-time in RFC 3339 format. Inclusive. */
+        to?: string | Date;
+        /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
+        windowSize?: 'MINUTE' | 'HOUR' | 'DAY';
+        /** @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. */
+        windowTimeZone?: string;
+        /** @description Simple filter for group bys with exact match. */
+        filterGroupBy?: Record<string, string>;
+        /** @description If not specified a single aggregate will be returned for each subject and time window. `subject` is a reserved group by value. */
+        groupBy?: string[];
+    }, options?: RequestOptions): Promise<{
+        data?: never;
+        error: import("../client/utils.js").Problem;
+        response: Response;
+    } | {
+        data: import("openapi-typescript-helpers").SuccessResponse<{
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": import("../client/schemas.js").components["schemas"]["MeterQueryResult"];
+                    "text/csv": string;
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": import("../client/schemas.js").components["schemas"]["BadRequestProblemResponse"];
+                };
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": import("../client/schemas.js").components["schemas"]["UnauthorizedProblemResponse"];
+                };
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": import("../client/schemas.js").components["schemas"]["ForbiddenProblemResponse"];
+                };
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": import("../client/schemas.js").components["schemas"]["NotFoundProblemResponse"];
+                };
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": import("../client/schemas.js").components["schemas"]["InternalServerErrorProblemResponse"];
+                };
+            };
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": import("../client/schemas.js").components["schemas"]["ServiceUnavailableProblemResponse"];
+                };
+            };
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": import("../client/schemas.js").components["schemas"]["UnexpectedProblemResponse"];
+                };
+            };
+        }, `${string}/${string}`>;
+        error?: never;
+        response: Response;
+    }>;
+}