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

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

@@ -0,0 +1,142 @@
+import type { RequestOptions } from './common.cjs';
+import type { operations, paths, PlanCreate, PlanReplaceUpdate } from './schemas.cjs';
+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, options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        key: string;
+        alignment?: import("./schemas.cjs").components["schemas"]["Alignment"];
+        readonly version: number;
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly effectiveFrom?: Date;
+        readonly effectiveTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["PlanStatus"];
+        phases: import("./schemas.cjs").components["schemas"]["PlanPhase"][];
+    }>;
+    /**
+     * 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'], options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        key: string;
+        alignment?: import("./schemas.cjs").components["schemas"]["Alignment"];
+        readonly version: number;
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly effectiveFrom?: Date;
+        readonly effectiveTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["PlanStatus"];
+        phases: import("./schemas.cjs").components["schemas"]["PlanPhase"][];
+    }>;
+    /**
+     * List plans
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of plans
+     */
+    list(query?: operations['listPlans']['parameters']['query'], options?: RequestOptions): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.cjs").components["schemas"]["Plan"][];
+    }>;
+    /**
+     * 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, options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        key: string;
+        alignment?: import("./schemas.cjs").components["schemas"]["Alignment"];
+        readonly version: number;
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly effectiveFrom?: Date;
+        readonly effectiveTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["PlanStatus"];
+        phases: import("./schemas.cjs").components["schemas"]["PlanPhase"][];
+    }>;
+    /**
+     * 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'], options?: RequestOptions): Promise<undefined>;
+    /**
+     * 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'], options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        key: string;
+        alignment?: import("./schemas.cjs").components["schemas"]["Alignment"];
+        readonly version: number;
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly effectiveFrom?: Date;
+        readonly effectiveTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["PlanStatus"];
+        phases: import("./schemas.cjs").components["schemas"]["PlanPhase"][];
+    }>;
+    /**
+     * 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'], options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        key: string;
+        alignment?: import("./schemas.cjs").components["schemas"]["Alignment"];
+        readonly version: number;
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly effectiveFrom?: Date;
+        readonly effectiveTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["PlanStatus"];
+        phases: import("./schemas.cjs").components["schemas"]["PlanPhase"][];
+    }>;
+}

package/dist/cjs/src/client/plans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plans.js","sourceRoot":"","sources":["../../../../src/client/plans.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAU9C,MAAa,KAAK;IACI;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,IAAgB,EAAE,OAAwB;QAC5D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE;YACnD,IAAI,EAAE,IAAI;YACV,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,EAAyD,EACzD,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;YAC3D,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,KAAsD,EACtD,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,EAAE;YAClD,MAAM,EAAE;gBACN,KAAK;aACN;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,EAA4D,EAC5D,IAAuB,EACvB,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;YAC3D,IAAI,EAAE,IAAI;YACV,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CACjB,EAA4D,EAC5D,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,wBAAwB,EAAE;YAC9D,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAClB,EAA6D,EAC7D,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACpE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAClB,EAA6D,EAC7D,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACpE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,EAAE;iBACX;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAtJD,sBAsJC"}

package/dist/cjs/src/client/portal.cjs

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Portal = void 0;
+const utils_js_1 = require("./utils.cjs");
+/**
+ * Portal
+ * Manage portal tokens.
+ */
+class Portal {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a consumer portal token
+     * @param request - The request body
+     * @param options - The request options
+     * @returns The portal token
+     */
+    async create(body, options) {
+        const resp = await this.client.POST('/api/v1/portal/tokens', {
+            body,
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * List consumer portal tokens
+     * @param query - The query parameters
+     * @param options - The request options
+     * @returns The portal tokens
+     */
+    async list(query, options) {
+        const resp = await this.client.GET('/api/v1/portal/tokens', {
+            params: { query },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Invalidate consumer portal tokens
+     * @param body - The id or subject to invalidate
+     * @param options - The request options
+     * @returns The portal token
+     */
+    async invalidate(body, options) {
+        const resp = await this.client.POST('/api/v1/portal/tokens/invalidate', {
+            body,
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.Portal = Portal;
+//# sourceMappingURL=portal.js.map

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

@@ -0,0 +1,48 @@
+import type { RequestOptions } from './common.cjs';
+import type { operations, paths, PortalToken } from './schemas.cjs';
+import type { Client } from 'openapi-fetch';
+/**
+ * Portal
+ * Manage portal tokens.
+ */
+export declare class Portal {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Create a consumer portal token
+     * @param request - The request body
+     * @param options - The request options
+     * @returns The portal token
+     */
+    create(body: PortalToken, options?: RequestOptions): Promise<{
+        readonly id?: string;
+        subject: string;
+        readonly expiresAt?: Date;
+        readonly expired?: boolean;
+        readonly createdAt?: Date;
+        readonly token?: string;
+        allowedMeterSlugs?: string[];
+    }>;
+    /**
+     * List consumer portal tokens
+     * @param query - The query parameters
+     * @param options - The request options
+     * @returns The portal tokens
+     */
+    list(query?: operations['listPortalTokens']['parameters']['query'], options?: RequestOptions): Promise<{
+        readonly id?: string;
+        subject: string;
+        readonly expiresAt?: Date;
+        readonly expired?: boolean;
+        readonly createdAt?: Date;
+        readonly token?: string;
+        allowedMeterSlugs?: string[];
+    }[]>;
+    /**
+     * Invalidate consumer portal tokens
+     * @param body - The id or subject to invalidate
+     * @param options - The request options
+     * @returns The portal token
+     */
+    invalidate(body: operations['invalidatePortalTokens']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<undefined>;
+}

package/dist/cjs/src/client/portal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"portal.js","sourceRoot":"","sources":["../../../../src/client/portal.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAK9C;;;GAGG;AACH,MAAa,MAAM;IACG;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAI,CAAC;IAErE;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,IAAiB,EAAE,OAAwB;QAC7D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE;YAC3D,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,KAA6D,EAC7D,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE;YAC1D,MAAM,EAAE,EAAE,KAAK,EAAE;YACjB,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CACrB,IAAwF,EACxF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kCAAkC,EAAE;YACtE,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AArDD,wBAqDC"}

package/dist/cjs/src/client/schemas.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schemas.js.map