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

package/dist/src/client/schemas.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=schemas.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/client/schemas.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,70 @@
+import type { RequestOptions } from './common.js';
+import type { operations, paths, SubjectUpsert } from './schemas.js';
+import type { Client } from 'openapi-fetch';
+/**
+ * Subjects
+ * @description Subjects are entities that consume resources you wish to meter. These can range from users, servers, and services to devices. The design of subjects is intentionally generic, enabling flexible application across various metering scenarios. Meters are aggregating events for each subject..
+ */
+export declare class Subjects {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Upsert one or multiple subjects
+     * If the subject does not exist, it will be created, otherwise it will be updated.
+     *
+     * @param subjects - The subjects to upsert
+     * @param signal - An optional abort signal
+     * @returns The upserted subjects
+     */
+    upsert(subjects: SubjectUpsert | SubjectUpsert[], options?: RequestOptions): Promise<{
+        readonly id: string;
+        key: string;
+        displayName?: string | null;
+        metadata?: {
+            [key: string]: unknown;
+        } | null;
+        currentPeriodStart?: Date;
+        currentPeriodEnd?: Date;
+        stripeCustomerId?: string | null;
+    }[]>;
+    /**
+     * Get a subject by ID or key
+     * @param idOrKey - The ID or key of the subject
+     * @param signal - An optional abort signal
+     * @returns The subject
+     */
+    get(idOrKey: operations['getSubject']['parameters']['path']['subjectIdOrKey'], options?: RequestOptions): Promise<{
+        readonly id: string;
+        key: string;
+        displayName?: string | null;
+        metadata?: {
+            [key: string]: unknown;
+        } | null;
+        currentPeriodStart?: Date;
+        currentPeriodEnd?: Date;
+        stripeCustomerId?: string | null;
+    }>;
+    /**
+     * List subjects
+     * @param signal - An optional abort signal
+     * @returns The subjects
+     */
+    list(options?: RequestOptions): Promise<{
+        readonly id: string;
+        key: string;
+        displayName?: string | null;
+        metadata?: {
+            [key: string]: unknown;
+        } | null;
+        currentPeriodStart?: Date;
+        currentPeriodEnd?: Date;
+        stripeCustomerId?: string | null;
+    }[]>;
+    /**
+     * Delete a subject by ID or key
+     * @param idOrKey - The ID or key of the subject
+     * @param signal - An optional abort signal
+     * @returns The deleted subject
+     */
+    delete(idOrKey: operations['deleteSubject']['parameters']['path']['subjectIdOrKey'], options?: RequestOptions): Promise<undefined>;
+}

package/dist/src/client/subjects.js

@@ -0,0 +1,72 @@
+import { transformResponse } from './utils.js';
+/**
+ * Subjects
+ * @description Subjects are entities that consume resources you wish to meter. These can range from users, servers, and services to devices. The design of subjects is intentionally generic, enabling flexible application across various metering scenarios. Meters are aggregating events for each subject..
+ */
+export class Subjects {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Upsert one or multiple subjects
+     * If the subject does not exist, it will be created, otherwise it will be updated.
+     *
+     * @param subjects - The subjects to upsert
+     * @param signal - An optional abort signal
+     * @returns The upserted subjects
+     */
+    async upsert(subjects, options) {
+        const resp = await this.client.POST('/api/v1/subjects', {
+            body: Array.isArray(subjects) ? subjects : [subjects],
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Get a subject by ID or key
+     * @param idOrKey - The ID or key of the subject
+     * @param signal - An optional abort signal
+     * @returns The subject
+     */
+    async get(idOrKey, options) {
+        const resp = await this.client.GET('/api/v1/subjects/{subjectIdOrKey}', {
+            params: {
+                path: {
+                    subjectIdOrKey: idOrKey,
+                },
+            },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * List subjects
+     * @param signal - An optional abort signal
+     * @returns The subjects
+     */
+    async list(options) {
+        const resp = await this.client.GET('/api/v1/subjects', {
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Delete a subject by ID or key
+     * @param idOrKey - The ID or key of the subject
+     * @param signal - An optional abort signal
+     * @returns The deleted subject
+     */
+    async delete(idOrKey, options) {
+        const resp = await this.client.DELETE('/api/v1/subjects/{subjectIdOrKey}', {
+            params: {
+                path: {
+                    subjectIdOrKey: idOrKey,
+                },
+            },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+}
+//# sourceMappingURL=subjects.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"subjects.js","sourceRoot":"","sources":["../../../src/client/subjects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAK9C;;;GAGG;AACH,MAAM,OAAO,QAAQ;IACC;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CACjB,QAAyC,EACzC,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE;YACtD,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;YACrD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,OAAyE,EACzE,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mCAAmC,EAAE;YACtE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,cAAc,EAAE,OAAO;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,kBAAkB,EAAE;YACrD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CACjB,OAA4E,EAC5E,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,mCAAmC,EAAE;YACzE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,cAAc,EAAE,OAAO;iBACxB;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF"}

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

@@ -0,0 +1,147 @@
+import type { RequestOptions } from './common.js';
+import type { operations, paths, SubscriptionChange, SubscriptionCreate, SubscriptionEdit } from './schemas.js';
+import type { Client } from 'openapi-fetch';
+/**
+ * Subscriptions
+ */
+export declare class Subscriptions {
+    private readonly client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Create a subscription
+     * @param body - The subscription to create
+     * @param signal - An optional abort signal
+     * @returns The created subscription
+     */
+    create(body: SubscriptionCreate, options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        activeFrom: Date;
+        activeTo?: Date;
+        alignment?: import("./schemas.js").components["schemas"]["Alignment"];
+        readonly status: import("./schemas.js").components["schemas"]["SubscriptionStatus"];
+        customerId: string;
+        plan?: import("./schemas.js").components["schemas"]["PlanReference"];
+        currency: import("./schemas.js").components["schemas"]["CurrencyCode"];
+    }>;
+    /**
+     * Get a subscription
+     * @param id - The subscription ID
+     * @param signal - An optional abort signal
+     * @returns The subscription
+     */
+    get(id: operations['getSubscription']['parameters']['path']['subscriptionId'], options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        activeFrom: Date;
+        activeTo?: Date;
+        readonly status: import("./schemas.js").components["schemas"]["SubscriptionStatus"];
+        customerId: string;
+        plan?: import("./schemas.js").components["schemas"]["PlanReference"];
+        currency: import("./schemas.js").components["schemas"]["CurrencyCode"];
+        alignment?: import("./schemas.js").components["schemas"]["SubscriptionAlignment"];
+        phases: import("./schemas.js").components["schemas"]["SubscriptionPhaseExpanded"][];
+    }>;
+    /**
+     * Edit a subscription
+     * @param id - The subscription ID
+     * @param body - The subscription to edit
+     * @param signal - An optional abort signal
+     * @returns The edited subscription
+     */
+    edit(id: operations['editSubscription']['parameters']['path']['subscriptionId'], body: SubscriptionEdit, options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        activeFrom: Date;
+        activeTo?: Date;
+        alignment?: import("./schemas.js").components["schemas"]["Alignment"];
+        readonly status: import("./schemas.js").components["schemas"]["SubscriptionStatus"];
+        customerId: string;
+        plan?: import("./schemas.js").components["schemas"]["PlanReference"];
+        currency: import("./schemas.js").components["schemas"]["CurrencyCode"];
+    }>;
+    /**
+     * Cancel a subscription
+     * @param id - The subscription ID
+     * @param body - The subscription to cancel
+     * @param signal - An optional abort signal
+     * @returns The canceled subscription
+     */
+    cancel(id: operations['cancelSubscription']['parameters']['path']['subscriptionId'], body: operations['cancelSubscription']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        activeFrom: Date;
+        activeTo?: Date;
+        alignment?: import("./schemas.js").components["schemas"]["Alignment"];
+        readonly status: import("./schemas.js").components["schemas"]["SubscriptionStatus"];
+        customerId: string;
+        plan?: import("./schemas.js").components["schemas"]["PlanReference"];
+        currency: import("./schemas.js").components["schemas"]["CurrencyCode"];
+    }>;
+    /**
+     * Change a subscription
+     * @description Closes a running subscription and starts a new one according to the specification. Can be used for upgrades, downgrades, and plan changes.
+     * @param id - The subscription ID
+     * @param body - The subscription to change
+     * @param signal - An optional abort signal
+     * @returns The changed subscription
+     */
+    change(id: operations['changeSubscription']['parameters']['path']['subscriptionId'], body: SubscriptionChange, options?: RequestOptions): Promise<{
+        current: import("./schemas.js").components["schemas"]["Subscription"];
+        next: import("./schemas.js").components["schemas"]["SubscriptionExpanded"];
+    }>;
+    /**
+     * Migrate a subscription
+     * @description Migrates the subscripiton to the provided version of the current plan.
+     * @param id - The subscription ID
+     * @param body - The subscription to migrate
+     * @param signal - An optional abort signal
+     * @returns The migrated subscription
+     */
+    migrate(id: operations['migrateSubscription']['parameters']['path']['subscriptionId'], body: operations['migrateSubscription']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<{
+        current: import("./schemas.js").components["schemas"]["Subscription"];
+        next: import("./schemas.js").components["schemas"]["SubscriptionExpanded"];
+    }>;
+    /**
+     * Unschedule a cancelation
+     * @param id - The subscription ID
+     * @param signal - An optional abort signal
+     * @returns The unscheduled subscription
+     */
+    unscheduleCancelation(id: operations['unscheduleCancelation']['parameters']['path']['subscriptionId'], options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.js").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        activeFrom: Date;
+        activeTo?: Date;
+        alignment?: import("./schemas.js").components["schemas"]["Alignment"];
+        readonly status: import("./schemas.js").components["schemas"]["SubscriptionStatus"];
+        customerId: string;
+        plan?: import("./schemas.js").components["schemas"]["PlanReference"];
+        currency: import("./schemas.js").components["schemas"]["CurrencyCode"];
+    }>;
+}

package/dist/src/client/subscriptions.js

@@ -0,0 +1,112 @@
+import { transformResponse } from './utils.js';
+/**
+ * Subscriptions
+ */
+export class Subscriptions {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a subscription
+     * @param body - The subscription to create
+     * @param signal - An optional abort signal
+     * @returns The created subscription
+     */
+    async create(body, options) {
+        const resp = await this.client.POST('/api/v1/subscriptions', {
+            body,
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Get a subscription
+     * @param id - The subscription ID
+     * @param signal - An optional abort signal
+     * @returns The subscription
+     */
+    async get(id, options) {
+        const resp = await this.client.GET('/api/v1/subscriptions/{subscriptionId}', {
+            params: { path: { subscriptionId: id } },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Edit a subscription
+     * @param id - The subscription ID
+     * @param body - The subscription to edit
+     * @param signal - An optional abort signal
+     * @returns The edited subscription
+     */
+    async edit(id, body, options) {
+        const resp = await this.client.PATCH('/api/v1/subscriptions/{subscriptionId}', {
+            body,
+            params: { path: { subscriptionId: id } },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Cancel a subscription
+     * @param id - The subscription ID
+     * @param body - The subscription to cancel
+     * @param signal - An optional abort signal
+     * @returns The canceled subscription
+     */
+    async cancel(id, body, options) {
+        const resp = await this.client.POST('/api/v1/subscriptions/{subscriptionId}/cancel', {
+            body,
+            params: { path: { subscriptionId: id } },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Change a subscription
+     * @description Closes a running subscription and starts a new one according to the specification. Can be used for upgrades, downgrades, and plan changes.
+     * @param id - The subscription ID
+     * @param body - The subscription to change
+     * @param signal - An optional abort signal
+     * @returns The changed subscription
+     */
+    async change(id, body, options) {
+        const resp = await this.client.POST('/api/v1/subscriptions/{subscriptionId}/change', {
+            body,
+            params: { path: { subscriptionId: id } },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Migrate a subscription
+     * @description Migrates the subscripiton to the provided version of the current plan.
+     * @param id - The subscription ID
+     * @param body - The subscription to migrate
+     * @param signal - An optional abort signal
+     * @returns The migrated subscription
+     */
+    async migrate(id, body, options) {
+        const resp = await this.client.POST('/api/v1/subscriptions/{subscriptionId}/migrate', {
+            body,
+            params: { path: { subscriptionId: id } },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Unschedule a cancelation
+     * @param id - The subscription ID
+     * @param signal - An optional abort signal
+     * @returns The unscheduled subscription
+     */
+    async unscheduleCancelation(id, options) {
+        const resp = await this.client.POST('/api/v1/subscriptions/{subscriptionId}/unschedule-cancelation', {
+            params: { path: { subscriptionId: id } },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+}
+//# sourceMappingURL=subscriptions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../../src/client/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAW9C;;GAEG;AACH,MAAM,OAAO,aAAa;IACK;IAA7B,YAA6B,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAE7E;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACpE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE;YAC3D,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,EAAyE,EACzE,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,wCAAwC,EACxC;YACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,EAAE;YACxC,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI,CACf,EAA0E,EAC1E,IAAsB,EACtB,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAClC,wCAAwC,EACxC;YACE,IAAI;YACJ,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,EAAE;YACxC,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,EAA4E,EAC5E,IAAoF,EACpF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,+CAA+C,EAC/C;YACE,IAAI;YACJ,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,EAAE;YACxC,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CACjB,EAA4E,EAC5E,IAAwB,EACxB,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,+CAA+C,EAC/C;YACE,IAAI;YACJ,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,EAAE;YACxC,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CAClB,EAA6E,EAC7E,IAAqF,EACrF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,gDAAgD,EAChD;YACE,IAAI;YACJ,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,EAAE;YACxC,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,qBAAqB,CAChC,EAA+E,EAC/E,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,+DAA+D,EAC/D;YACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,EAAE;YACxC,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF"}

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

@@ -0,0 +1,12 @@
+import type { FetchResponse, ParseAsResponse } from 'openapi-fetch';
+import type { MediaType, ResponseObjectMap, SuccessResponse } from 'openapi-typescript-helpers';
+/**
+ * Transform a response from the API
+ * @param resp - The response to transform
+ * @throws HTTPError if the response is an error
+ * @returns The transformed response
+ */
+export declare function transformResponse<T extends Record<string | number, any>, Options, Media extends MediaType>(resp: FetchResponse<T, Options, Media>): ParseAsResponse<SuccessResponse<ResponseObjectMap<T>, Media>, Options> | never;
+export declare function isIsoDateString(value: unknown): value is string;
+export declare function decodeDates<T>(data: T): T;
+export declare function encodeDates<T>(data: T): T;

package/dist/src/client/utils.js

@@ -0,0 +1,63 @@
+import { HTTPError } from './common.js';
+/**
+ * Transform a response from the API
+ * @param resp - The response to transform
+ * @throws HTTPError if the response is an error
+ * @returns The transformed response
+ */
+export function transformResponse(resp) {
+    // Handle errors
+    if (resp.error || resp.response.status >= 400) {
+        throw HTTPError.fromResponse(resp);
+    }
+    // Decode dates
+    if (resp.data) {
+        resp.data = decodeDates(resp.data);
+    }
+    return resp.data;
+}
+const ISODateFormat = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d*)?(?:[-+]\d{2}:?\d{2}|Z)?$/;
+export function isIsoDateString(value) {
+    return typeof value === 'string' && ISODateFormat.test(value);
+}
+export function decodeDates(data) {
+    // if it's a date string, return a date
+    if (isIsoDateString(data)) {
+        return new Date(data);
+    }
+    // if it's not an object or array, return it
+    if (data === null || data === undefined || typeof data !== 'object') {
+        return data;
+    }
+    // if it's an array, decode each element
+    if (Array.isArray(data)) {
+        return data.map((val) => decodeDates(val));
+    }
+    // if it's an object, decode each key
+    for (const [key, val] of Object.entries(data)) {
+        // @ts-expect-error we know this will give back the same type
+        data[key] = decodeDates(val);
+    }
+    return data;
+}
+export function encodeDates(data) {
+    // if it's a date, return a date string
+    if (data instanceof Date) {
+        return data.toISOString();
+    }
+    // if it's not an object or array, return it
+    if (data === null || data === undefined || typeof data !== 'object') {
+        return data;
+    }
+    // if it's an array, encode each element
+    if (Array.isArray(data)) {
+        return data.map((val) => encodeDates(val));
+    }
+    // if it's an object, encode each key
+    for (const [key, val] of Object.entries(data)) {
+        // @ts-expect-error we know this will give back the same type
+        data[key] = encodeDates(val);
+    }
+    return data;
+}
+//# sourceMappingURL=utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/client/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAQvC;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAK/B,IAAsC;IAItC,gBAAgB;IAChB,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QAC9C,MAAM,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC;IAED,eAAe;IACf,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC;IAED,OAAO,IAAI,CAAC,IAAK,CAAA;AACnB,CAAC;AAED,MAAM,aAAa,GACjB,wEAAwE,CAAA;AAE1E,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAC/D,CAAC;AAED,MAAM,UAAU,WAAW,CAAI,IAAO;IACpC,uCAAuC;IACvC,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,IAAI,CAAC,IAAI,CAAM,CAAA;IAC5B,CAAC;IAED,4CAA4C;IAC5C,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,wCAAwC;IACxC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAM,CAAA;IACjD,CAAC;IAED,qCAAqC;IACrC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,6DAA6D;QAC7D,IAAI,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED,OAAO,IAAS,CAAA;AAClB,CAAC;AAED,MAAM,UAAU,WAAW,CAAI,IAAO;IACpC,uCAAuC;IACvC,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,WAAW,EAAO,CAAA;IAChC,CAAC;IAED,4CAA4C;IAC5C,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,wCAAwC;IACxC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAM,CAAA;IACjD,CAAC;IAED,qCAAqC;IACrC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,6DAA6D;QAC7D,IAAI,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED,OAAO,IAAS,CAAA;AAClB,CAAC"}

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

@@ -0,0 +1,104 @@
+import type { RequestOptions } from '../client/common.js';
+import type { ClientOptions } from 'openapi-fetch';
+/**
+ * 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<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}`>>;
+}

package/dist/src/portal/index.js

@@ -0,0 +1,50 @@
+import createClient from 'openapi-fetch';
+import { createQuerySerializer } from 'openapi-fetch/dist/cjs/index.cjs';
+import { encodeDates, transformResponse } from '../client/utils.js';
+/**
+ * OpenMeter Portal Client
+ * Access to the customer portal.
+ */
+export class OpenMeter {
+    client;
+    constructor(config) {
+        this.client = createClient({
+            ...config,
+            headers: {
+                ...config.headers,
+                Authorization: `Bearer ${config.portalToken}`,
+            },
+            querySerializer: (q) => createQuerySerializer({
+                array: {
+                    explode: true,
+                    style: 'form',
+                },
+                object: {
+                    explode: true,
+                    style: 'deepObject',
+                },
+            })(encodeDates(q)),
+        });
+    }
+    /**
+     * 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
+     */
+    async query(meterSlug, query, options) {
+        const resp = await this.client.GET('/api/v1/portal/meters/{meterSlug}/query', {
+            params: {
+                path: {
+                    meterSlug,
+                },
+                query,
+            },
+            ...options,
+        });
+        return transformResponse(resp);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/src/portal/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/portal/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAA;AACxE,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAenE;;;GAGG;AACH,MAAM,OAAO,SAAS;IACZ,MAAM,CAAsC;IAEpD,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,YAAY,CAAQ;YAChC,GAAG,MAAM;YACT,OAAO,EAAE;gBACP,GAAG,MAAM,CAAC,OAAO;gBACjB,aAAa,EAAE,UAAU,MAAM,CAAC,WAAW,EAAE;aAC9C;YACD,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,CACrB,qBAAqB,CAAC;gBACpB,KAAK,EAAE;oBACL,OAAO,EAAE,IAAI;oBACb,KAAK,EAAE,MAAM;iBACd;gBACD,MAAM,EAAE;oBACN,OAAO,EAAE,IAAI;oBACb,KAAK,EAAE,YAAY;iBACpB;aACF,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SACrB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,KAAK,CAChB,SAAiB,EACjB,KAaC,EACD,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,yCAAyC,EACzC;YACE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,SAAS;iBACV;gBACD,KAAK;aACN;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF"}