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

package/dist/src/customers.d.ts

@@ -0,0 +1,231 @@
+import type { CustomerAppData, CustomerCreate, CustomerReplaceUpdate, operations, paths } from './schemas.js';
+import type { Client } from 'openapi-fetch';
+/**
+ * Customers
+ * Manage customer subscription lifecycles and plan assignments.
+ */
+export declare class Customers {
+    private client;
+    apps: CustomerApps;
+    entitlements: CustomerEntitlements;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Create a customer
+     * @param customer - The customer to create
+     * @param signal - An optional abort signal
+     * @returns The created customer
+     */
+    create(customer: CustomerCreate, 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;
+            usageAttribution: import("./schemas.js").components["schemas"]["CustomerUsageAttribution"];
+            primaryEmail?: string;
+            currency?: import("./schemas.js").components["schemas"]["CurrencyCode"];
+            billingAddress?: import("./schemas.js").components["schemas"]["Address"];
+            readonly currentSubscriptionId?: string;
+        };
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * Get a customer by ID
+     * @param id - The ID of the customer
+     * @param signal - An optional abort signal
+     * @returns The customer
+     */
+    get(id: operations['getCustomer']['parameters']['path']['id'], 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;
+            usageAttribution: import("./schemas.js").components["schemas"]["CustomerUsageAttribution"];
+            primaryEmail?: string;
+            currency?: import("./schemas.js").components["schemas"]["CurrencyCode"];
+            billingAddress?: import("./schemas.js").components["schemas"]["Address"];
+            readonly currentSubscriptionId?: string;
+        };
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * Update a customer
+     * @param id - The ID of the customer
+     * @param customer - The customer to update
+     * @param signal - An optional abort signal
+     * @returns The updated customer
+     */
+    update(id: operations['updateCustomer']['parameters']['path']['id'], customer: CustomerReplaceUpdate, 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;
+            usageAttribution: import("./schemas.js").components["schemas"]["CustomerUsageAttribution"];
+            primaryEmail?: string;
+            currency?: import("./schemas.js").components["schemas"]["CurrencyCode"];
+            billingAddress?: import("./schemas.js").components["schemas"]["Address"];
+            readonly currentSubscriptionId?: string;
+        };
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * Delete a customer
+     * @param id - The ID of the customer
+     * @param signal - An optional abort signal
+     * @returns The deleted customer
+     */
+    delete(id: operations['deleteCustomer']['parameters']['path']['id'], signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: undefined;
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * List customers
+     * @param signal - An optional abort signal
+     * @returns The list of customers
+     */
+    list(query?: operations['listCustomers']['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"]["Customer"][];
+        };
+        error?: never;
+        response: Response;
+    }>;
+}
+/**
+ * Customer Apps
+ * Manage customer apps.
+ */
+export declare class CustomerApps {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Upsert customer app data
+     * @param customerId - The ID of the customer
+     * @param appData - The app data to upsert
+     * @param signal - An optional abort signal
+     * @returns The upserted app data
+     */
+    upsert(customerId: operations['upsertCustomerAppData']['parameters']['path']['customerId'], appData: CustomerAppData[], signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: ({
+            id?: string;
+            type: "stripe";
+            readonly app?: import("./schemas.js").components["schemas"]["StripeApp"];
+            stripeCustomerId: string;
+            stripeDefaultPaymentMethodId?: string;
+        } | {
+            readonly app?: import("./schemas.js").components["schemas"]["SandboxApp"];
+            id?: string;
+            type: "sandbox";
+        })[];
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * List customer app data
+     * @param customerId - The ID of the customer
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of customer app data
+     */
+    list(customerId: operations['listCustomerAppData']['parameters']['path']['customerId'], query?: operations['listCustomerAppData']['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"]["CustomerAppData"][];
+        };
+        error?: never;
+        response: Response;
+    }>;
+    /**
+     * Delete customer app data
+     * @param customerId - The ID of the customer
+     * @param appId - The ID of the app
+     * @param signal - An optional abort signal
+     * @returns The deleted customer app data
+     */
+    delete(customerId: operations['deleteCustomerAppData']['parameters']['path']['customerId'], appId: operations['deleteCustomerAppData']['parameters']['path']['appId'], signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: undefined;
+        error?: never;
+        response: Response;
+    }>;
+}
+/**
+ * Customer Entitlements
+ */
+export declare class CustomerEntitlements {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Get the value of an entitlement for a customer
+     * @param customerId - The ID of the customer
+     * @param featureKey - The key of the feature
+     * @param signal - An optional abort signal
+     * @returns The value of the entitlement
+     */
+    value(customerId: operations['getCustomerEntitlementValue']['parameters']['path']['customerId'], featureKey: operations['getCustomerEntitlementValue']['parameters']['path']['featureKey'], signal?: AbortSignal): Promise<{
+        data?: never;
+        error: import("./utils.js").Problem;
+        response: Response;
+    } | {
+        data: {
+            readonly hasAccess: boolean;
+            readonly balance?: number;
+            readonly usage?: number;
+            readonly overage?: number;
+            readonly config?: string;
+        };
+        error?: never;
+        response: Response;
+    }>;
+}

package/dist/src/customers.js

@@ -0,0 +1,179 @@
+import { transformResponse } from './utils.js';
+/**
+ * Customers
+ * Manage customer subscription lifecycles and plan assignments.
+ */
+export class Customers {
+    client;
+    apps;
+    entitlements;
+    constructor(client) {
+        this.client = client;
+        this.apps = new CustomerApps(client);
+        this.entitlements = new CustomerEntitlements(client);
+    }
+    /**
+     * Create a customer
+     * @param customer - The customer to create
+     * @param signal - An optional abort signal
+     * @returns The created customer
+     */
+    async create(customer, signal) {
+        const resp = await this.client.POST('/api/v1/customers', {
+            signal,
+            body: customer,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Get a customer by ID
+     * @param id - The ID of the customer
+     * @param signal - An optional abort signal
+     * @returns The customer
+     */
+    async get(id, signal) {
+        const resp = await this.client.GET('/api/v1/customers/{id}', {
+            signal,
+            params: {
+                path: {
+                    id,
+                },
+            },
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Update a customer
+     * @param id - The ID of the customer
+     * @param customer - The customer to update
+     * @param signal - An optional abort signal
+     * @returns The updated customer
+     */
+    async update(id, customer, signal) {
+        const resp = await this.client.PUT('/api/v1/customers/{id}', {
+            signal,
+            params: {
+                path: {
+                    id,
+                },
+            },
+            body: customer,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Delete a customer
+     * @param id - The ID of the customer
+     * @param signal - An optional abort signal
+     * @returns The deleted customer
+     */
+    async delete(id, signal) {
+        const resp = await this.client.DELETE('/api/v1/customers/{id}', {
+            signal,
+            params: {
+                path: {
+                    id,
+                },
+            },
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * List customers
+     * @param signal - An optional abort signal
+     * @returns The list of customers
+     */
+    async list(query, signal) {
+        const resp = await this.client.GET('/api/v1/customers', {
+            signal,
+            params: {
+                query,
+            },
+        });
+        return transformResponse(resp);
+    }
+}
+/**
+ * Customer Apps
+ * Manage customer apps.
+ */
+export class CustomerApps {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Upsert customer app data
+     * @param customerId - The ID of the customer
+     * @param appData - The app data to upsert
+     * @param signal - An optional abort signal
+     * @returns The upserted app data
+     */
+    async upsert(customerId, appData, signal) {
+        const resp = await this.client.PUT('/api/v1/customers/{customerId}/apps', {
+            signal,
+            params: {
+                path: {
+                    customerId,
+                },
+            },
+            body: appData,
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * List customer app data
+     * @param customerId - The ID of the customer
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of customer app data
+     */
+    async list(customerId, query, signal) {
+        const resp = await this.client.GET('/api/v1/customers/{customerId}/apps', {
+            signal,
+            params: {
+                path: { customerId },
+                query,
+            },
+        });
+        return transformResponse(resp);
+    }
+    /**
+     * Delete customer app data
+     * @param customerId - The ID of the customer
+     * @param appId - The ID of the app
+     * @param signal - An optional abort signal
+     * @returns The deleted customer app data
+     */
+    async delete(customerId, appId, signal) {
+        const resp = await this.client.DELETE('/api/v1/customers/{customerId}/apps/{appId}', {
+            signal,
+            params: { path: { customerId, appId } },
+        });
+        return transformResponse(resp);
+    }
+}
+/**
+ * Customer Entitlements
+ */
+export class CustomerEntitlements {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get the value of an entitlement for a customer
+     * @param customerId - The ID of the customer
+     * @param featureKey - The key of the feature
+     * @param signal - An optional abort signal
+     * @returns The value of the entitlement
+     */
+    async value(customerId, featureKey, signal) {
+        const resp = await this.client.GET('/api/v1/customers/{customerId}/entitlements/{featureKey}/value', {
+            signal,
+            params: { path: { customerId, featureKey } },
+        });
+        return transformResponse(resp);
+    }
+}
+//# sourceMappingURL=customers.js.map

package/dist/src/customers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../src/customers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAU9C;;;GAGG;AACH,MAAM,OAAO,SAAS;IAIA;IAHb,IAAI,CAAc;IAClB,YAAY,CAAsB;IAEzC,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;QAC9D,IAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAA;QACpC,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAA;IACtD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,QAAwB,EAAE,MAAoB;QAChE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE;YACvD,MAAM;YACN,IAAI,EAAE,QAAQ;SACf,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,EAAE;iBACH;aACF;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,EAA4D,EAC5D,QAA+B,EAC/B,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;YAC3D,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,EAAE;iBACH;aACF;YACD,IAAI,EAAE,QAAQ;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,EAAE;iBACH;aACF;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CACf,KAA0D,EAC1D,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;YACtD,MAAM;YACN,MAAM,EAAE;gBACN,KAAK;aACN;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,YAAY;IACH;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,UAAmF,EACnF,OAA0B,EAC1B,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACxE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,UAAU;iBACX;aACF;YACD,IAAI,EAAE,OAAO;SACd,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI,CACf,UAAiF,EACjF,KAAgE,EAChE,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACxE,MAAM;YACN,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;gBACpB,KAAK;aACN;SACF,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,UAAmF,EACnF,KAAyE,EACzE,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACnC,6CAA6C,EAC7C;YACE,MAAM;YACN,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE;SACxC,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,oBAAoB;IACX;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAChB,UAAyF,EACzF,UAAyF,EACzF,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,gEAAgE,EAChE;YACE,MAAM;YACN,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE;SAC7C,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF"}