@openmeter/sdk 1.0.0-beta.99 → 1.0.0-beta-9958c9245841

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

@@ -0,0 +1,617 @@
+import type { Client } from 'openapi-fetch';
+import type { RequestOptions } from './common.cjs';
+import type { CreateStripeCustomerPortalSessionParams, CustomerAppData, CustomerCreate, CustomerReplaceUpdate, operations, paths, StripeCustomerAppDataBase } from './schemas.cjs';
+/**
+ * Customers
+ * Manage customer subscription lifecycles and plan assignments.
+ */
+export declare class Customers {
+    private client;
+    apps: CustomerApps;
+    entitlementsV1: CustomerEntitlements;
+    entitlements: CustomerEntitlementsV2;
+    stripe: CustomerStripe;
+    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, 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;
+        usageAttribution?: import("./schemas.cjs").components["schemas"]["CustomerUsageAttribution"];
+        primaryEmail?: string;
+        currency?: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        billingAddress?: import("./schemas.cjs").components["schemas"]["Address"];
+        readonly currentSubscriptionId?: string;
+        readonly subscriptions?: import("./schemas.cjs").components["schemas"]["Subscription"][];
+        readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
+    } | undefined>;
+    /**
+     * Get a customer by ID
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param signal - An optional abort signal
+     * @returns The customer
+     */
+    get(customerIdOrKey: operations['getCustomer']['parameters']['path']['customerIdOrKey'], 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;
+        usageAttribution?: import("./schemas.cjs").components["schemas"]["CustomerUsageAttribution"];
+        primaryEmail?: string;
+        currency?: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        billingAddress?: import("./schemas.cjs").components["schemas"]["Address"];
+        readonly currentSubscriptionId?: string;
+        readonly subscriptions?: import("./schemas.cjs").components["schemas"]["Subscription"][];
+        readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
+    } | undefined>;
+    /**
+     * Update a customer
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param customer - The customer to update
+     * @param signal - An optional abort signal
+     * @returns The updated customer
+     */
+    update(customerIdOrKey: operations['updateCustomer']['parameters']['path']['customerIdOrKey'], customer: CustomerReplaceUpdate, 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;
+        usageAttribution?: import("./schemas.cjs").components["schemas"]["CustomerUsageAttribution"];
+        primaryEmail?: string;
+        currency?: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        billingAddress?: import("./schemas.cjs").components["schemas"]["Address"];
+        readonly currentSubscriptionId?: string;
+        readonly subscriptions?: import("./schemas.cjs").components["schemas"]["Subscription"][];
+        readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
+    } | undefined>;
+    /**
+     * Delete a customer
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param signal - An optional abort signal
+     * @returns The deleted customer
+     */
+    delete(customerIdOrKey: operations['deleteCustomer']['parameters']['path']['customerIdOrKey'], options?: RequestOptions): Promise<undefined>;
+    /**
+     * List customers
+     * @param signal - An optional abort signal
+     * @returns The list of customers
+     */
+    list(query?: operations['listCustomers']['parameters']['query'], options?: RequestOptions): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.cjs").components["schemas"]["Customer"][];
+    } | undefined>;
+    /**
+     * Get customer access
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param options - Optional request options
+     * @returns The customer access information
+     */
+    getAccess(customerIdOrKey: operations['getCustomerAccess']['parameters']['path']['customerIdOrKey'], options?: RequestOptions): Promise<{
+        readonly entitlements: {
+            [key: string]: import("./schemas.cjs").components["schemas"]["EntitlementValue"];
+        };
+    } | undefined>;
+    /**
+     * List customer subscriptions
+     * @param customerIdOrKey - The ID or key of the customer
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of customer subscriptions
+     */
+    listSubscriptions(customerIdOrKey: operations['listCustomerSubscriptions']['parameters']['path']['customerIdOrKey'], query?: operations['listCustomerSubscriptions']['parameters']['query'], options?: RequestOptions): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.cjs").components["schemas"]["Subscription"][];
+    } | undefined>;
+}
+/**
+ * Customer Apps
+ * Manage customer apps.
+ */
+export declare class CustomerApps {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Upsert customer app data
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param appData - The app data to upsert
+     * @param signal - An optional abort signal
+     * @returns The upserted app data
+     */
+    upsert(customerIdOrKey: operations['upsertCustomerAppData']['parameters']['path']['customerIdOrKey'], appData: CustomerAppData[], options?: RequestOptions): Promise<({
+        readonly app?: import("./schemas.cjs").components["schemas"]["CustomInvoicingApp"];
+        id?: string;
+        type: "custom_invoicing";
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"];
+    } | {
+        id?: string;
+        type: "stripe";
+        stripeCustomerId: string;
+        stripeDefaultPaymentMethodId?: string;
+        readonly app?: import("./schemas.cjs").components["schemas"]["StripeApp"];
+    } | {
+        readonly app?: import("./schemas.cjs").components["schemas"]["SandboxApp"];
+        id?: string;
+        type: "sandbox";
+    })[] | undefined>;
+    /**
+     * List customer app data
+     * @param customerIdOrKey - The ID or key of the customer
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The list of customer app data
+     */
+    list(customerIdOrKey: operations['listCustomerAppData']['parameters']['path']['customerIdOrKey'], query?: operations['listCustomerAppData']['parameters']['query'], options?: RequestOptions): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.cjs").components["schemas"]["CustomerAppData"][];
+    } | undefined>;
+    /**
+     * Delete customer app data
+     * @param customerIdOrKey - The ID or key of the customer
+     * @param appId - The ID of the app
+     * @param signal - An optional abort signal
+     * @returns The deleted customer app data
+     */
+    delete(customerIdOrKey: operations['deleteCustomerAppData']['parameters']['path']['customerIdOrKey'], appId: operations['deleteCustomerAppData']['parameters']['path']['appId'], options?: RequestOptions): Promise<undefined>;
+}
+/**
+ * Customer Stripe
+ * Manage customer Stripe data.
+ */
+export declare class CustomerStripe {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Upsert customer stripe app data
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param appData - The app data to upsert
+     * @param signal - An optional abort signal
+     * @returns The upserted customer stripe app data
+     */
+    upsert(customerIdOrKey: operations['upsertCustomerStripeAppData']['parameters']['path']['customerIdOrKey'], stripeAppData: StripeCustomerAppDataBase, options?: RequestOptions): Promise<{
+        id?: string;
+        type: "stripe";
+        stripeCustomerId: string;
+        stripeDefaultPaymentMethodId?: string;
+        readonly app?: import("./schemas.cjs").components["schemas"]["StripeApp"];
+    } | undefined>;
+    /**
+     * Get customer stripe app data
+     * @param customerIdOrKey - The ID or key of the customer
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The customer stripe app data
+     */
+    get(customerIdOrKey: operations['getCustomerStripeAppData']['parameters']['path']['customerIdOrKey'], options?: RequestOptions): Promise<{
+        id?: string;
+        type: "stripe";
+        stripeCustomerId: string;
+        stripeDefaultPaymentMethodId?: string;
+        readonly app?: import("./schemas.cjs").components["schemas"]["StripeApp"];
+    } | undefined>;
+    /**
+     * Create a Stripe customer portal session
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param params - The parameters for creating a Stripe customer portal session
+     * @param signal - An optional abort signal
+     * @returns The Stripe customer portal session
+     */
+    createPortalSession(customerIdOrKey: operations['createCustomerStripePortalSession']['parameters']['path']['customerIdOrKey'], params: CreateStripeCustomerPortalSessionParams, options?: RequestOptions): Promise<{
+        id: string;
+        stripeCustomerId: string;
+        configurationId: string;
+        livemode: boolean;
+        createdAt: Date;
+        returnUrl: string;
+        locale: string;
+        url: string;
+    } | undefined>;
+}
+/**
+ * Customer Entitlements
+ */
+export declare class CustomerEntitlements {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Get the value of an entitlement for a customer
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param featureKey - The key of the feature
+     * @param signal - An optional abort signal
+     * @returns The value of the entitlement
+     */
+    value(customerIdOrKey: operations['getCustomerEntitlementValue']['parameters']['path']['customerIdOrKey'], featureKey: operations['getCustomerEntitlementValue']['parameters']['path']['featureKey'], options?: RequestOptions): Promise<{
+        readonly hasAccess: boolean;
+        readonly balance?: number;
+        readonly usage?: number;
+        readonly overage?: number;
+        readonly totalAvailableGrantAmount?: number;
+        readonly config?: string;
+    } | undefined>;
+}
+/**
+ * Customer Entitlements V2
+ */
+export declare class CustomerEntitlementsV2 {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * List all entitlements for a customer
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param options - Request options including query parameters
+     * @returns List of customer entitlements
+     */
+    list(customerIdOrKey: operations['listCustomerEntitlementsV2']['parameters']['path']['customerIdOrKey'], options?: RequestOptions & {
+        query?: operations['listCustomerEntitlementsV2']['parameters']['query'];
+    }): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.cjs").components["schemas"]["EntitlementV2"][];
+    } | undefined>;
+    /**
+     * Create a customer entitlement
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param entitlement - The entitlement data to create
+     * @param options - Request options
+     * @returns The created entitlement
+     */
+    create(customerIdOrKey: operations['createCustomerEntitlementV2']['parameters']['path']['customerIdOrKey'], entitlement: operations['createCustomerEntitlementV2']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<import("openapi-typescript-helpers").SuccessResponse<{
+        201: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./schemas.cjs").components["schemas"]["EntitlementV2"];
+            };
+        };
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["BadRequestProblemResponse"];
+            };
+        };
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["UnauthorizedProblemResponse"];
+            };
+        };
+        403: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ForbiddenProblemResponse"];
+            };
+        };
+        409: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ConflictProblemResponse"];
+            };
+        };
+        412: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["PreconditionFailedProblemResponse"];
+            };
+        };
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["InternalServerErrorProblemResponse"];
+            };
+        };
+        503: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ServiceUnavailableProblemResponse"];
+            };
+        };
+        default: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["UnexpectedProblemResponse"];
+            };
+        };
+    }, `${string}/${string}`> | undefined>;
+    /**
+     * Get a specific customer entitlement
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param options - Request options
+     * @returns The entitlement
+     */
+    get(customerIdOrKey: operations['getCustomerEntitlementV2']['parameters']['path']['customerIdOrKey'], entitlementIdOrFeatureKey: operations['getCustomerEntitlementV2']['parameters']['path']['entitlementIdOrFeatureKey'], options?: RequestOptions): Promise<import("openapi-typescript-helpers").SuccessResponse<{
+        200: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./schemas.cjs").components["schemas"]["EntitlementV2"];
+            };
+        };
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["BadRequestProblemResponse"];
+            };
+        };
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["UnauthorizedProblemResponse"];
+            };
+        };
+        403: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ForbiddenProblemResponse"];
+            };
+        };
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["NotFoundProblemResponse"];
+            };
+        };
+        412: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["PreconditionFailedProblemResponse"];
+            };
+        };
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["InternalServerErrorProblemResponse"];
+            };
+        };
+        503: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ServiceUnavailableProblemResponse"];
+            };
+        };
+        default: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["UnexpectedProblemResponse"];
+            };
+        };
+    }, `${string}/${string}`> | undefined>;
+    /**
+     * Delete a customer entitlement
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param options - Request options
+     * @returns The deletion response
+     */
+    delete(customerIdOrKey: operations['deleteCustomerEntitlementV2']['parameters']['path']['customerIdOrKey'], entitlementIdOrFeatureKey: operations['deleteCustomerEntitlementV2']['parameters']['path']['entitlementIdOrFeatureKey'], options?: RequestOptions): Promise<undefined>;
+    /**
+     * Override a customer entitlement
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param entitlement - The new entitlement data
+     * @param options - Request options
+     * @returns The overridden entitlement
+     */
+    override(customerIdOrKey: operations['overrideCustomerEntitlementV2']['parameters']['path']['customerIdOrKey'], entitlementIdOrFeatureKey: operations['overrideCustomerEntitlementV2']['parameters']['path']['entitlementIdOrFeatureKey'], entitlement: operations['overrideCustomerEntitlementV2']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<import("openapi-typescript-helpers").SuccessResponse<{
+        201: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./schemas.cjs").components["schemas"]["EntitlementV2"];
+            };
+        };
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["BadRequestProblemResponse"];
+            };
+        };
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["UnauthorizedProblemResponse"];
+            };
+        };
+        403: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ForbiddenProblemResponse"];
+            };
+        };
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["NotFoundProblemResponse"];
+            };
+        };
+        409: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ConflictProblemResponse"];
+            };
+        };
+        412: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["PreconditionFailedProblemResponse"];
+            };
+        };
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["InternalServerErrorProblemResponse"];
+            };
+        };
+        503: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ServiceUnavailableProblemResponse"];
+            };
+        };
+        default: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["UnexpectedProblemResponse"];
+            };
+        };
+    }, `${string}/${string}`> | undefined>;
+    /**
+     * List grants for a customer entitlement
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param options - Request options including query parameters
+     * @returns List of entitlement grants
+     */
+    listGrants(customerIdOrKey: operations['listCustomerEntitlementGrantsV2']['parameters']['path']['customerIdOrKey'], entitlementIdOrFeatureKey: operations['listCustomerEntitlementGrantsV2']['parameters']['path']['entitlementIdOrFeatureKey'], options?: RequestOptions & {
+        query?: operations['listCustomerEntitlementGrantsV2']['parameters']['query'];
+    }): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.cjs").components["schemas"]["EntitlementGrantV2"][];
+    } | undefined>;
+    /**
+     * Create a grant for a customer entitlement
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param grant - The grant data to create
+     * @param options - Request options
+     * @returns The created grant
+     */
+    createGrant(customerIdOrKey: operations['createCustomerEntitlementGrantV2']['parameters']['path']['customerIdOrKey'], entitlementIdOrFeatureKey: operations['createCustomerEntitlementGrantV2']['parameters']['path']['entitlementIdOrFeatureKey'], grant: operations['createCustomerEntitlementGrantV2']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<{
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        amount: number;
+        priority?: number;
+        effectiveAt: Date;
+        minRolloverAmount?: number;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"];
+        maxRolloverAmount?: number;
+        expiration?: import("./schemas.cjs").components["schemas"]["ExpirationPeriod"];
+        annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
+        readonly id: string;
+        readonly entitlementId: string;
+        nextRecurrence?: Date;
+        readonly expiresAt?: Date;
+        voidedAt?: Date;
+        recurrence?: import("./schemas.cjs").components["schemas"]["RecurringPeriod"];
+    } | undefined>;
+    /**
+     * Get the value of a customer entitlement
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param options - Request options including query parameters
+     * @returns The entitlement value
+     */
+    value(customerIdOrKey: operations['getCustomerEntitlementValueV2']['parameters']['path']['customerIdOrKey'], entitlementIdOrFeatureKey: operations['getCustomerEntitlementValueV2']['parameters']['path']['entitlementIdOrFeatureKey'], options?: RequestOptions & {
+        query?: operations['getCustomerEntitlementValueV2']['parameters']['query'];
+    }): Promise<{
+        readonly hasAccess: boolean;
+        readonly balance?: number;
+        readonly usage?: number;
+        readonly overage?: number;
+        readonly totalAvailableGrantAmount?: number;
+        readonly config?: string;
+    } | undefined>;
+    /**
+     * Get the history of a customer entitlement
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param windowSize - The window size for the history
+     * @param options - Request options including query parameters
+     * @returns The entitlement history
+     */
+    history(customerIdOrKey: operations['getCustomerEntitlementHistoryV2']['parameters']['path']['customerIdOrKey'], entitlementIdOrFeatureKey: operations['getCustomerEntitlementHistoryV2']['parameters']['path']['entitlementIdOrFeatureKey'], windowSize: operations['getCustomerEntitlementHistoryV2']['parameters']['query']['windowSize'], options?: RequestOptions & {
+        query?: Omit<operations['getCustomerEntitlementHistoryV2']['parameters']['query'], 'windowSize'>;
+    }): Promise<{
+        windowedHistory: import("./schemas.cjs").components["schemas"]["BalanceHistoryWindow"][];
+        burndownHistory: import("./schemas.cjs").components["schemas"]["GrantBurnDownHistorySegment"][];
+    } | undefined>;
+    /**
+     * Reset the usage of a customer entitlement
+     * @param customerIdOrKey - The ID or Key of the customer
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param reset - The reset data
+     * @param options - Request options
+     * @returns The reset response
+     */
+    resetUsage(customerIdOrKey: operations['resetCustomerEntitlementUsageV2']['parameters']['path']['customerIdOrKey'], entitlementIdOrFeatureKey: operations['resetCustomerEntitlementUsageV2']['parameters']['path']['entitlementIdOrFeatureKey'], reset: operations['resetCustomerEntitlementUsageV2']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<undefined>;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../../../src/client/customers.ts"],"names":[],"mappings":";;;AAWA,yCAA8C;AAE9C;;;GAGG;AACH,MAAa,SAAS;IAMA;IALb,IAAI,CAAc;IAClB,cAAc,CAAsB;IACpC,YAAY,CAAwB;IACpC,MAAM,CAAgB;IAE7B,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;QAC9D,IAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAA;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAA;QACtD,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAsB,CAAC,MAAM,CAAC,CAAA;QACtD,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,CAAA;IAC1C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,QAAwB,EAAE,OAAwB;QACpE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE;YACvD,IAAI,EAAE,QAAQ;YACd,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,eAAmF,EACnF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACxE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAAsF,EACtF,QAA+B,EAC/B,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACxE,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CACjB,eAAsF,EACtF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACnC,qCAAqC,EACrC;YACE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CACf,KAA0D,EAC1D,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;YACtD,MAAM,EAAE;gBACN,KAAK;aACN;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACpB,eAAyF,EACzF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,4CAA4C,EAC5C;YACE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAC5B,eAAiG,EACjG,KAAsE,EACtE,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,mDAAmD,EACnD;YACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE;YAC5C,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAtKD,8BAsKC;AAED;;;GAGG;AACH,MAAa,YAAY;IACH;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAA6F,EAC7F,OAA0B,EAC1B,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,0CAA0C,EAC1C;YACE,IAAI,EAAE,OAAO;YACb,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI,CACf,eAA2F,EAC3F,KAAgE,EAChE,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,0CAA0C,EAC1C;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE;gBACzB,KAAK;aACN;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAA6F,EAC7F,KAAyE,EACzE,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACnC,kDAAkD,EAClD;YACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,EAAE;YAC5C,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AA/ED,oCA+EC;AAED;;;GAGG;AACH,MAAa,cAAc;IACL;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAAmG,EACnG,aAAwC,EACxC,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,4CAA4C,EAC5C;YACE,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,eAAgG,EAChG,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,4CAA4C,EAC5C;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE;aAC1B;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,mBAAmB,CAC9B,eAAyG,EACzG,MAA+C,EAC/C,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,mDAAmD,EACnD;YACE,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAlFD,wCAkFC;AAED;;GAEG;AACH,MAAa,oBAAoB;IACX;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAChB,eAAmG,EACnG,UAAyF,EACzF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,qEAAqE,EACrE;YACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE;YACjD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAzBD,oDAyBC;AAED;;GAEG;AACH,MAAa,sBAAsB;IACb;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,eAAkG,EAClG,OAEC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,kDAAkD,EAClD;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE;gBACzB,KAAK,EAAE,OAAO,EAAE,KAAK;aACtB;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAAmG,EACnG,WAAoG,EACpG,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,kDAAkD,EAClD;YACE,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE;aAC1B;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,eAAgG,EAChG,yBAAoH,EACpH,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,8EAA8E,EAC9E;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;aACrD;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAAmG,EACnG,yBAAuH,EACvH,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACnC,8EAA8E,EAC9E;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;aACrD;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,QAAQ,CACnB,eAAqG,EACrG,yBAAyH,EACzH,WAAsG,EACtG,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,uFAAuF,EACvF;YACE,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;aACrD;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACrB,eAAuG,EACvG,yBAA2H,EAC3H,OAEC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,qFAAqF,EACrF;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;gBACpD,KAAK,EAAE,OAAO,EAAE,KAAK;aACtB;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,WAAW,CACtB,eAAwG,EACxG,yBAA4H,EAC5H,KAAmG,EACnG,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,qFAAqF,EACrF;YACE,IAAI,EAAE,KAAK;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;aACrD;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAChB,eAAqG,EACrG,yBAAyH,EACzH,OAEC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,oFAAoF,EACpF;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;gBACpD,KAAK,EAAE,OAAO,EAAE,KAAK;aACtB;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CAClB,eAAuG,EACvG,yBAA2H,EAC3H,UAA8F,EAC9F,OAKC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,sFAAsF,EACtF;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;gBACpD,KAAK,EAAE;oBACL,UAAU;oBACV,GAAG,OAAO,EAAE,KAAK;iBAClB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,UAAU,CACrB,eAAuG,EACvG,yBAA2H,EAC3H,KAAkG,EAClG,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,oFAAoF,EACpF;YACE,IAAI,EAAE,KAAK;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;aACrD;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAxRD,wDAwRC"}

package/dist/cjs/src/client/debug.cjs

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Debug = void 0;
+const utils_js_1 = require("./utils.cjs");
+/**
+ * Debug utilities for OpenMeter
+ */
+class Debug {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get event metrics
+     * @description Returns debug metrics (in OpenMetrics format) like the number of ingested events since mindnight UTC.
+     * @param options - The request options
+     * @returns The debug metrics
+     */
+    async getMetrics(options) {
+        const resp = await this.client.GET('/api/v1/debug/metrics', {
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.Debug = Debug;
+//# sourceMappingURL=debug.js.map