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

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

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

package/dist/cjs/src/client/subjects.cjs

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subjects = void 0;
+const utils_js_1 = require("./utils.cjs");
+/**
+ * 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..
+ */
+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 (0, utils_js_1.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 (0, utils_js_1.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 (0, utils_js_1.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 (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.Subjects = Subjects;
+//# sourceMappingURL=subjects.js.map

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

@@ -0,0 +1,70 @@
+import type { RequestOptions } from './common.cjs';
+import type { operations, paths, SubjectUpsert } from './schemas.cjs';
+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/cjs/src/client/subjects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subjects.js","sourceRoot":"","sources":["../../../../src/client/subjects.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAK9C;;;GAGG;AACH,MAAa,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,IAAA,4BAAiB,EAAC,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,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,kBAAkB,EAAE;YACrD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AA/ED,4BA+EC"}

package/dist/cjs/src/client/subscription-addons.cjs

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionAddons = void 0;
+const utils_js_1 = require("./utils.cjs");
+class SubscriptionAddons {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a new subscription addon
+     * @param subscriptionId - The ID of the subscription
+     * @param addon - The subscription addon to create
+     * @param options - Optional request options
+     * @returns The created subscription addon
+     */
+    async create(subscriptionId, addon, options) {
+        const resp = await this.client.POST('/api/v1/subscriptions/{subscriptionId}/addons', {
+            body: addon,
+            params: { path: { subscriptionId } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * List all addons of a subscription
+     * @param subscriptionId - The ID of the subscription
+     * @param options - Optional request options
+     * @returns A list of subscription addons
+     */
+    async list(subscriptionId, options) {
+        const resp = await this.client.GET('/api/v1/subscriptions/{subscriptionId}/addons', {
+            params: { path: { subscriptionId } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Get a subscription addon by id
+     * @param subscriptionId - The ID of the subscription
+     * @param subscriptionAddonId - The ID of the subscription addon
+     * @param options - Optional request options
+     * @returns The subscription addon
+     */
+    async get(subscriptionId, subscriptionAddonId, options) {
+        const resp = await this.client.GET('/api/v1/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}', {
+            params: { path: { subscriptionAddonId, subscriptionId } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Updates a subscription addon
+     * @param subscriptionId - The ID of the subscription
+     * @param subscriptionAddonId - The ID of the subscription addon to update
+     * @param addon - The subscription addon data to update
+     * @param options - Optional request options
+     * @returns The updated subscription addon
+     */
+    async update(subscriptionId, subscriptionAddonId, addon, options) {
+        const resp = await this.client.PATCH('/api/v1/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}', {
+            body: addon,
+            params: { path: { subscriptionAddonId, subscriptionId } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.SubscriptionAddons = SubscriptionAddons;
+//# sourceMappingURL=subscription-addons.js.map

package/dist/cjs/src/client/subscription-addons.d.cts

@@ -0,0 +1,123 @@
+import type { RequestOptions } from './common.cjs';
+import type { operations, paths } from './schemas.cjs';
+import type { Client } from 'openapi-fetch';
+export declare class SubscriptionAddons {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Create a new subscription addon
+     * @param subscriptionId - The ID of the subscription
+     * @param addon - The subscription addon to create
+     * @param options - Optional request options
+     * @returns The created subscription addon
+     */
+    create(subscriptionId: string, addon: operations['createSubscriptionAddon']['requestBody']['content']['application/json'], 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;
+        readonly activeFrom: Date;
+        readonly activeTo?: Date;
+        addon: {
+            id: string;
+            readonly key: string;
+            readonly version: number;
+            readonly instanceType: import("./schemas.cjs").components["schemas"]["AddonInstanceType"];
+        };
+        readonly quantityAt: Date;
+        quantity: number;
+        readonly timeline: import("./schemas.cjs").components["schemas"]["SubscriptionAddonTimelineSegment"][];
+        readonly subscriptionId: string;
+        readonly rateCards: import("./schemas.cjs").components["schemas"]["SubscriptionAddonRateCard"][];
+    }>;
+    /**
+     * List all addons of a subscription
+     * @param subscriptionId - The ID of the subscription
+     * @param options - Optional request options
+     * @returns A list of subscription addons
+     */
+    list(subscriptionId: string, 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;
+        readonly activeFrom: Date;
+        readonly activeTo?: Date;
+        addon: {
+            id: string;
+            readonly key: string;
+            readonly version: number;
+            readonly instanceType: import("./schemas.cjs").components["schemas"]["AddonInstanceType"];
+        };
+        readonly quantityAt: Date;
+        quantity: number;
+        readonly timeline: import("./schemas.cjs").components["schemas"]["SubscriptionAddonTimelineSegment"][];
+        readonly subscriptionId: string;
+        readonly rateCards: import("./schemas.cjs").components["schemas"]["SubscriptionAddonRateCard"][];
+    }[]>;
+    /**
+     * Get a subscription addon by id
+     * @param subscriptionId - The ID of the subscription
+     * @param subscriptionAddonId - The ID of the subscription addon
+     * @param options - Optional request options
+     * @returns The subscription addon
+     */
+    get(subscriptionId: string, subscriptionAddonId: string, 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;
+        readonly activeFrom: Date;
+        readonly activeTo?: Date;
+        addon: {
+            id: string;
+            readonly key: string;
+            readonly version: number;
+            readonly instanceType: import("./schemas.cjs").components["schemas"]["AddonInstanceType"];
+        };
+        readonly quantityAt: Date;
+        quantity: number;
+        readonly timeline: import("./schemas.cjs").components["schemas"]["SubscriptionAddonTimelineSegment"][];
+        readonly subscriptionId: string;
+        readonly rateCards: import("./schemas.cjs").components["schemas"]["SubscriptionAddonRateCard"][];
+    }>;
+    /**
+     * Updates a subscription addon
+     * @param subscriptionId - The ID of the subscription
+     * @param subscriptionAddonId - The ID of the subscription addon to update
+     * @param addon - The subscription addon data to update
+     * @param options - Optional request options
+     * @returns The updated subscription addon
+     */
+    update(subscriptionId: string, subscriptionAddonId: string, addon: operations['updateSubscriptionAddon']['requestBody']['content']['application/json'], 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;
+        readonly activeFrom: Date;
+        readonly activeTo?: Date;
+        addon: {
+            id: string;
+            readonly key: string;
+            readonly version: number;
+            readonly instanceType: import("./schemas.cjs").components["schemas"]["AddonInstanceType"];
+        };
+        readonly quantityAt: Date;
+        quantity: number;
+        readonly timeline: import("./schemas.cjs").components["schemas"]["SubscriptionAddonTimelineSegment"][];
+        readonly subscriptionId: string;
+        readonly rateCards: import("./schemas.cjs").components["schemas"]["SubscriptionAddonRateCard"][];
+    }>;
+}

package/dist/cjs/src/client/subscription-addons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription-addons.js","sourceRoot":"","sources":["../../../../src/client/subscription-addons.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAK9C,MAAa,kBAAkB;IACT;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,cAAsB,EACtB,KAA0F,EAC1F,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,+CAA+C,EAC/C;YACE,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,EAAE;YACpC,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CAAC,cAAsB,EAAE,OAAwB;QAChE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,+CAA+C,EAC/C;YACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,EAAE;YACpC,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,cAAsB,EACtB,mBAA2B,EAC3B,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,qEAAqE,EACrE;YACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,mBAAmB,EAAE,cAAc,EAAE,EAAE;YACzD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CACjB,cAAsB,EACtB,mBAA2B,EAC3B,KAA0F,EAC1F,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAClC,qEAAqE,EACrE;YACE,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,mBAAmB,EAAE,cAAc,EAAE,EAAE;YACzD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AA7FD,gDA6FC"}

package/dist/cjs/src/client/subscriptions.cjs

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscriptions = void 0;
+const utils_js_1 = require("./utils.cjs");
+/**
+ * Subscriptions
+ */
+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 (0, utils_js_1.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 (0, utils_js_1.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 (0, utils_js_1.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 (0, utils_js_1.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 (0, utils_js_1.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 (0, utils_js_1.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 (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Delete subscription
+     * @description Deletes a subscription. Only scheduled subscriptions can be deleted.
+     * @param subscriptionId - The ID of the subscription to delete
+     * @param options - Optional request options
+     * @returns void or standard error response structure
+     */
+    async delete(subscriptionId, options) {
+        const resp = await this.client.DELETE('/api/v1/subscriptions/{subscriptionId}', {
+            params: {
+                path: { subscriptionId },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.Subscriptions = Subscriptions;
+//# sourceMappingURL=subscriptions.js.map

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

@@ -0,0 +1,170 @@
+import type { RequestOptions } from './common.cjs';
+import type { operations, paths, SubscriptionChange, SubscriptionCreate, SubscriptionEdit } from './schemas.cjs';
+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.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        activeFrom: Date;
+        activeTo?: Date;
+        alignment?: import("./schemas.cjs").components["schemas"]["Alignment"];
+        readonly status: import("./schemas.cjs").components["schemas"]["SubscriptionStatus"];
+        customerId: string;
+        plan?: import("./schemas.cjs").components["schemas"]["PlanReference"];
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly billingCadence: string;
+        readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
+        readonly billingAnchor: Date;
+    }>;
+    /**
+     * 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.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        activeFrom: Date;
+        activeTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["SubscriptionStatus"];
+        customerId: string;
+        plan?: import("./schemas.cjs").components["schemas"]["PlanReference"];
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly billingCadence: string;
+        readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
+        readonly billingAnchor: Date;
+        alignment?: import("./schemas.cjs").components["schemas"]["SubscriptionAlignment"];
+        phases: import("./schemas.cjs").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.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        activeFrom: Date;
+        activeTo?: Date;
+        alignment?: import("./schemas.cjs").components["schemas"]["Alignment"];
+        readonly status: import("./schemas.cjs").components["schemas"]["SubscriptionStatus"];
+        customerId: string;
+        plan?: import("./schemas.cjs").components["schemas"]["PlanReference"];
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly billingCadence: string;
+        readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
+        readonly billingAnchor: Date;
+    }>;
+    /**
+     * 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.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        activeFrom: Date;
+        activeTo?: Date;
+        alignment?: import("./schemas.cjs").components["schemas"]["Alignment"];
+        readonly status: import("./schemas.cjs").components["schemas"]["SubscriptionStatus"];
+        customerId: string;
+        plan?: import("./schemas.cjs").components["schemas"]["PlanReference"];
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly billingCadence: string;
+        readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
+        readonly billingAnchor: Date;
+    }>;
+    /**
+     * 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.cjs").components["schemas"]["Subscription"];
+        next: import("./schemas.cjs").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.cjs").components["schemas"]["Subscription"];
+        next: import("./schemas.cjs").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.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        activeFrom: Date;
+        activeTo?: Date;
+        alignment?: import("./schemas.cjs").components["schemas"]["Alignment"];
+        readonly status: import("./schemas.cjs").components["schemas"]["SubscriptionStatus"];
+        customerId: string;
+        plan?: import("./schemas.cjs").components["schemas"]["PlanReference"];
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly billingCadence: string;
+        readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
+        readonly billingAnchor: Date;
+    }>;
+    /**
+     * Delete subscription
+     * @description Deletes a subscription. Only scheduled subscriptions can be deleted.
+     * @param subscriptionId - The ID of the subscription to delete
+     * @param options - Optional request options
+     * @returns void or standard error response structure
+     */
+    delete(subscriptionId: operations['deleteSubscription']['parameters']['path']['subscriptionId'], options?: RequestOptions): Promise<undefined>;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../../../src/client/subscriptions.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAW9C;;GAEG;AACH,MAAa,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,cAAwF,EACxF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACnC,wCAAwC,EACxC;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,cAAc,EAAE;aACzB;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AArLD,sCAqLC"}