@openmeter/client 1.0.0-beta-4d26c6d3c7fe → 1.0.0-beta-e7a04be10ed8

package/dist/sdk/customers.js

@@ -1,22 +1,59 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
+import { paginateCursor, paginatePages } from '../lib/paginate.js';
 import { createCustomer, getCustomer, listCustomers, upsertCustomer, deleteCustomer, getCustomerBilling, updateCustomerBilling, updateCustomerBillingAppData, createCustomerStripeCheckoutSession, createCustomerStripePortalSession, createCreditGrant, getCreditGrant, listCreditGrants, getCustomerCreditBalance, createCreditAdjustment, updateCreditGrantExternalSettlement, listCreditTransactions, listCustomerCharges, createCustomerCharges, } from '../funcs/customers.js';
 export class Customers {
     _client;
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * Create customer
+     *
+     * POST /openmeter/customers
+     */
     async create(request, options) {
         return unwrap(await createCustomer(this._client, request, options));
     }
+    /**
+     * Get customer
+     *
+     * GET /openmeter/customers/{customerId}
+     */
     async get(request, options) {
         return unwrap(await getCustomer(this._client, request, options));
     }
+    /**
+     * List customers
+     *
+     * GET /openmeter/customers
+     */
     async list(request, options) {
         return unwrap(await listCustomers(this._client, request, options));
     }
+    /**
+     * List customers
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/customers
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listCustomers(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Upsert customer
+     *
+     * PUT /openmeter/customers/{customerId}
+     */
     async upsert(request, options) {
         return unwrap(await upsertCustomer(this._client, request, options));
     }
+    /**
+     * Delete customer
+     *
+     * DELETE /openmeter/customers/{customerId}
+     */
     async delete(request, options) {
         return unwrap(await deleteCustomer(this._client, request, options));
     }
@@ -38,18 +75,62 @@ export class CustomersBilling {
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * Get customer billing data
+     *
+     * GET /openmeter/customers/{customerId}/billing
+     */
     async get(request, options) {
         return unwrap(await getCustomerBilling(this._client, request, options));
     }
+    /**
+     * Update customer billing data
+     *
+     * PUT /openmeter/customers/{customerId}/billing
+     */
     async update(request, options) {
         return unwrap(await updateCustomerBilling(this._client, request, options));
     }
+    /**
+     * Update customer billing app data
+     *
+     * PUT /openmeter/customers/{customerId}/billing/app-data
+     */
     async updateAppData(request, options) {
         return unwrap(await updateCustomerBillingAppData(this._client, request, options));
     }
+    /**
+     * Create Stripe Checkout Session
+     *
+     * Create a [Stripe Checkout Session](https://docs.stripe.com/payments/checkout)
+     * for the customer.
+     *
+     * Creates a Checkout Session for collecting payment method information from
+     * customers. The session operates in "setup" mode, which collects payment details
+     * without charging the customer immediately. The collected payment method can be
+     * used for future subscription billing.
+     *
+     * For hosted checkout sessions, redirect customers to the returned URL. For
+     * embedded sessions, use the client_secret to initialize Stripe.js in your
+     * application.
+     *
+     * POST /openmeter/customers/{customerId}/billing/stripe/checkout-sessions
+     */
     async createStripeCheckoutSession(request, options) {
         return unwrap(await createCustomerStripeCheckoutSession(this._client, request, options));
     }
+    /**
+     * Create Stripe customer portal session
+     *
+     * Create Stripe Customer Portal Session.
+     *
+     * Useful to redirect the customer to the Stripe Customer Portal to manage their
+     * payment methods, change their billing address and access their invoice history.
+     * Only returns URL if the customer billing profile is linked to a stripe app and
+     * customer.
+     *
+     * POST /openmeter/customers/{customerId}/billing/stripe/portal-sessions
+     */
     async createStripePortalSession(request, options) {
         return unwrap(await createCustomerStripePortalSession(this._client, request, options));
     }
@@ -81,15 +162,59 @@ export class CustomersCreditsGrants {
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * Create a new credit grant
+     *
+     * Create a new credit grant. A credit grant represents an allocation of prepaid
+     * credits to a customer.
+     *
+     * POST /openmeter/customers/{customerId}/credits/grants
+     */
     async create(request, options) {
         return unwrap(await createCreditGrant(this._client, request, options));
     }
+    /**
+     * Get a credit grant
+     *
+     * Get a credit grant.
+     *
+     * GET /openmeter/customers/{customerId}/credits/grants/{creditGrantId}
+     */
     async get(request, options) {
         return unwrap(await getCreditGrant(this._client, request, options));
     }
+    /**
+     * List credit grants
+     *
+     * List credit grants.
+     *
+     * GET /openmeter/customers/{customerId}/credits/grants
+     */
     async list(request, options) {
         return unwrap(await listCreditGrants(this._client, request, options));
     }
+    /**
+     * List credit grants
+     *
+     * List credit grants.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/customers/{customerId}/credits/grants
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listCreditGrants(this._client, req, opts), request, options);
+    }
+    /**
+     * Update credit grant external settlement status
+     *
+     * Update the payment settlement status of an externally funded credit grant.
+     *
+     * Use this endpoint to synchronize the payment state of an external payment with
+     * the system so that revenue recognition and credit availability work as expected.
+     *
+     * POST /openmeter/customers/{customerId}/credits/grants/{creditGrantId}/settlement/external
+     */
     async updateExternalSettlement(request, options) {
         return unwrap(await updateCreditGrantExternalSettlement(this._client, request, options));
     }
@@ -99,6 +224,13 @@ export class CustomersCreditsBalance {
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * Get a customer's credit balance
+     *
+     * Get a credit balance.
+     *
+     * GET /openmeter/customers/{customerId}/credits/balance
+     */
     async get(request, options) {
         return unwrap(await getCustomerCreditBalance(this._client, request, options));
     }
@@ -108,6 +240,18 @@ export class CustomersCreditsAdjustments {
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * Create a credit adjustment
+     *
+     * A credit adjustment can be used to make manual adjustments to a customer's
+     * credit balance.
+     *
+     * Supported use-cases:
+     *
+     * - Usage correction
+     *
+     * POST /openmeter/customers/{customerId}/credits/adjustments
+     */
     async create(request, options) {
         return unwrap(await createCreditAdjustment(this._client, request, options));
     }
@@ -117,20 +261,78 @@ export class CustomersCreditsTransactions {
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * List credit transactions
+     *
+     * List credit transactions for a customer.
+     *
+     * Returns an immutable, chronological record of credit movements: funded credits
+     * and consumed credits. Transactions are returned in reverse chronological order
+     * by default.
+     *
+     * GET /openmeter/customers/{customerId}/credits/transactions
+     */
     async list(request, options) {
         return unwrap(await listCreditTransactions(this._client, request, options));
     }
+    /**
+     * List credit transactions
+     *
+     * List credit transactions for a customer.
+     *
+     * Returns an immutable, chronological record of credit movements: funded credits
+     * and consumed credits. Transactions are returned in reverse chronological order
+     * by default.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/customers/{customerId}/credits/transactions
+     */
+    listAll(request, options) {
+        return paginateCursor((req, opts) => listCreditTransactions(this._client, req, opts), request, options);
+    }
 }
 export class CustomersCharges {
     _client;
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * List customer charges
+     *
+     * List customer charges.
+     *
+     * Returns the customer's charges that are represented as either flat fee or
+     * usage-based charges.
+     *
+     * GET /openmeter/customers/{customerId}/charges
+     */
     async list(request, options) {
         return unwrap(await listCustomerCharges(this._client, request, options));
     }
+    /**
+     * List customer charges
+     *
+     * List customer charges.
+     *
+     * Returns the customer's charges that are represented as either flat fee or
+     * usage-based charges.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/customers/{customerId}/charges
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listCustomerCharges(this._client, req, opts), request, options);
+    }
+    /**
+     * Create customer charge
+     *
+     * Create customer charge.
+     *
+     * POST /openmeter/customers/{customerId}/charges
+     */
     async create(request, options) {
         return unwrap(await createCustomerCharges(this._client, request, options));
     }
 }
-//# sourceMappingURL=customers.js.map

package/dist/sdk/defaults.d.ts

@@ -4,7 +4,16 @@ import type { GetOrganizationDefaultTaxCodesRequest, GetOrganizationDefaultTaxCo
 export declare class Defaults {
     private readonly _client;
     constructor(_client: Client);
+    /**
+     * Get organization default tax codes
+     *
+     * GET /openmeter/defaults/tax-codes
+     */
     getOrganizationTaxCodes(request: GetOrganizationDefaultTaxCodesRequest, options?: RequestOptions): Promise<GetOrganizationDefaultTaxCodesResponse>;
+    /**
+     * Update organization default tax codes
+     *
+     * PUT /openmeter/defaults/tax-codes
+     */
     updateOrganizationTaxCodes(request: UpdateOrganizationDefaultTaxCodesRequest, options?: RequestOptions): Promise<UpdateOrganizationDefaultTaxCodesResponse>;
 }
-//# sourceMappingURL=defaults.d.ts.map

package/dist/sdk/defaults.js

@@ -1,3 +1,4 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
 import { getOrganizationDefaultTaxCodes, updateOrganizationDefaultTaxCodes, } from '../funcs/defaults.js';
 export class Defaults {
@@ -5,11 +6,20 @@ export class Defaults {
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * Get organization default tax codes
+     *
+     * GET /openmeter/defaults/tax-codes
+     */
     async getOrganizationTaxCodes(request, options) {
         return unwrap(await getOrganizationDefaultTaxCodes(this._client, request, options));
     }
+    /**
+     * Update organization default tax codes
+     *
+     * PUT /openmeter/defaults/tax-codes
+     */
     async updateOrganizationTaxCodes(request, options) {
         return unwrap(await updateOrganizationDefaultTaxCodes(this._client, request, options));
     }
 }
-//# sourceMappingURL=defaults.js.map

package/dist/sdk/entitlements.d.ts

@@ -4,6 +4,10 @@ import type { ListCustomerEntitlementAccessRequest, ListCustomerEntitlementAcces
 export declare class Entitlements {
     private readonly _client;
     constructor(_client: Client);
+    /**
+     * List customer entitlement access
+     *
+     * GET /openmeter/customers/{customerId}/entitlement-access
+     */
     listCustomerAccess(request: ListCustomerEntitlementAccessRequest, options?: RequestOptions): Promise<ListCustomerEntitlementAccessResponse>;
 }
-//# sourceMappingURL=entitlements.d.ts.map

package/dist/sdk/entitlements.js

@@ -1,3 +1,4 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
 import { listCustomerEntitlementAccess } from '../funcs/entitlements.js';
 export class Entitlements {
@@ -5,8 +6,12 @@ export class Entitlements {
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * List customer entitlement access
+     *
+     * GET /openmeter/customers/{customerId}/entitlement-access
+     */
     async listCustomerAccess(request, options) {
         return unwrap(await listCustomerEntitlementAccess(this._client, request, options));
     }
 }
-//# sourceMappingURL=entitlements.js.map

package/dist/sdk/events.d.ts

@@ -1,10 +1,34 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
 import type { ListMeteringEventsRequest, ListMeteringEventsResponse, IngestMeteringEventsRequest, IngestMeteringEventsResponse } from '../models/operations/events.js';
+import type { IngestedEvent } from '../models/types.js';
 export declare class Events {
     private readonly _client;
     constructor(_client: Client);
+    /**
+     * List metering events
+     *
+     * List ingested events.
+     *
+     * GET /openmeter/events
+     */
     list(request?: ListMeteringEventsRequest, options?: RequestOptions): Promise<ListMeteringEventsResponse>;
+    /**
+     * List metering events
+     *
+     * List ingested events.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/events
+     */
+    listAll(request?: ListMeteringEventsRequest, options?: RequestOptions): AsyncIterable<IngestedEvent>;
+    /**
+     * Ingest metering events
+     *
+     * Ingests an event or batch of events following the CloudEvents specification.
+     *
+     * POST /openmeter/events
+     */
     ingest(request: IngestMeteringEventsRequest, options?: RequestOptions): Promise<IngestMeteringEventsResponse>;
 }
-//# sourceMappingURL=events.d.ts.map

package/dist/sdk/events.js

@@ -1,15 +1,42 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
+import { paginateCursor } from '../lib/paginate.js';
 import { listMeteringEvents, ingestMeteringEvents } from '../funcs/events.js';
 export class Events {
     _client;
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * List metering events
+     *
+     * List ingested events.
+     *
+     * GET /openmeter/events
+     */
     async list(request, options) {
         return unwrap(await listMeteringEvents(this._client, request, options));
     }
+    /**
+     * List metering events
+     *
+     * List ingested events.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/events
+     */
+    listAll(request, options) {
+        return paginateCursor((req, opts) => listMeteringEvents(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Ingest metering events
+     *
+     * Ingests an event or batch of events following the CloudEvents specification.
+     *
+     * POST /openmeter/events
+     */
     async ingest(request, options) {
         return unwrap(await ingestMeteringEvents(this._client, request, options));
     }
 }
-//# sourceMappingURL=events.js.map

package/dist/sdk/features.d.ts

@@ -1,14 +1,66 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
 import type { ListFeaturesRequest, ListFeaturesResponse, CreateFeatureRequest, CreateFeatureResponse, GetFeatureRequest, GetFeatureResponse, UpdateFeatureRequest, UpdateFeatureResponse, DeleteFeatureRequest, DeleteFeatureResponse, QueryFeatureCostRequest, QueryFeatureCostResponse } from '../models/operations/features.js';
+import type { Feature } from '../models/types.js';
 export declare class Features {
     private readonly _client;
     constructor(_client: Client);
+    /**
+     * List features
+     *
+     * List all features.
+     *
+     * GET /openmeter/features
+     */
     list(request?: ListFeaturesRequest, options?: RequestOptions): Promise<ListFeaturesResponse>;
+    /**
+     * List features
+     *
+     * List all features.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/features
+     */
+    listAll(request?: ListFeaturesRequest, options?: RequestOptions): AsyncIterable<Feature>;
+    /**
+     * Create feature
+     *
+     * Create a feature.
+     *
+     * POST /openmeter/features
+     */
     create(request: CreateFeatureRequest, options?: RequestOptions): Promise<CreateFeatureResponse>;
+    /**
+     * Get feature
+     *
+     * Get a feature by id.
+     *
+     * GET /openmeter/features/{featureId}
+     */
     get(request: GetFeatureRequest, options?: RequestOptions): Promise<GetFeatureResponse>;
+    /**
+     * Update feature
+     *
+     * Update a feature by id. Currently only the unit_cost field can be updated.
+     *
+     * PATCH /openmeter/features/{featureId}
+     */
     update(request: UpdateFeatureRequest, options?: RequestOptions): Promise<UpdateFeatureResponse>;
+    /**
+     * Delete feature
+     *
+     * Delete a feature by id.
+     *
+     * DELETE /openmeter/features/{featureId}
+     */
     delete(request: DeleteFeatureRequest, options?: RequestOptions): Promise<DeleteFeatureResponse>;
+    /**
+     * Query feature cost
+     *
+     * Query the cost of a feature.
+     *
+     * POST /openmeter/features/{featureId}/cost/query
+     */
     queryCost(request: QueryFeatureCostRequest, options?: RequestOptions): Promise<QueryFeatureCostResponse>;
 }
-//# sourceMappingURL=features.d.ts.map

package/dist/sdk/features.js

@@ -1,27 +1,82 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
+import { paginatePages } from '../lib/paginate.js';
 import { listFeatures, createFeature, getFeature, updateFeature, deleteFeature, queryFeatureCost, } from '../funcs/features.js';
 export class Features {
     _client;
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * List features
+     *
+     * List all features.
+     *
+     * GET /openmeter/features
+     */
     async list(request, options) {
         return unwrap(await listFeatures(this._client, request, options));
     }
+    /**
+     * List features
+     *
+     * List all features.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/features
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listFeatures(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Create feature
+     *
+     * Create a feature.
+     *
+     * POST /openmeter/features
+     */
     async create(request, options) {
         return unwrap(await createFeature(this._client, request, options));
     }
+    /**
+     * Get feature
+     *
+     * Get a feature by id.
+     *
+     * GET /openmeter/features/{featureId}
+     */
     async get(request, options) {
         return unwrap(await getFeature(this._client, request, options));
     }
+    /**
+     * Update feature
+     *
+     * Update a feature by id. Currently only the unit_cost field can be updated.
+     *
+     * PATCH /openmeter/features/{featureId}
+     */
     async update(request, options) {
         return unwrap(await updateFeature(this._client, request, options));
     }
+    /**
+     * Delete feature
+     *
+     * Delete a feature by id.
+     *
+     * DELETE /openmeter/features/{featureId}
+     */
     async delete(request, options) {
         return unwrap(await deleteFeature(this._client, request, options));
     }
+    /**
+     * Query feature cost
+     *
+     * Query the cost of a feature.
+     *
+     * POST /openmeter/features/{featureId}/cost/query
+     */
     async queryCost(request, options) {
         return unwrap(await queryFeatureCost(this._client, request, options));
     }
 }
-//# sourceMappingURL=features.js.map

package/dist/sdk/internal.d.ts

@@ -0,0 +1,89 @@
+import { type Client } from '../core.js';
+import { type RequestOptions } from '../lib/types.js';
+import type { CreateSubscriptionAddonRequest, CreateSubscriptionAddonResponse } from '../models/operations/subscriptions.js';
+import type { ListCurrenciesRequest, ListCurrenciesResponse, CreateCustomCurrencyRequest, CreateCustomCurrencyResponse, ListCostBasesRequest, ListCostBasesResponse, CreateCostBasisRequest, CreateCostBasisResponse } from '../models/operations/currencies.js';
+import type { CostBasis, Currency } from '../models/types.js';
+/**
+ * Operations marked internal in the API definition. They are not part of
+ * the customer surface: they may require additional permissions, and they
+ * can change or be removed without notice or semver consideration.
+ */
+export declare class Internal {
+    private readonly _client;
+    constructor(_client: Client);
+    private _subscriptions?;
+    get subscriptions(): InternalSubscriptions;
+    private _currencies?;
+    get currencies(): InternalCurrencies;
+}
+export declare class InternalSubscriptions {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * Create a new subscription add-on
+     *
+     * Add add-on to a subscription.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/addons
+     */
+    createAddon(request: CreateSubscriptionAddonRequest, options?: RequestOptions): Promise<CreateSubscriptionAddonResponse>;
+}
+export declare class InternalCurrencies {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * List currencies
+     *
+     * List currencies supported by the billing system.
+     *
+     * GET /openmeter/currencies
+     */
+    list(request?: ListCurrenciesRequest, options?: RequestOptions): Promise<ListCurrenciesResponse>;
+    /**
+     * List currencies
+     *
+     * List currencies supported by the billing system.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/currencies
+     */
+    listAll(request?: ListCurrenciesRequest, options?: RequestOptions): AsyncIterable<Currency>;
+    /**
+     * Create custom currency
+     *
+     * Create a custom currency. This operation allows defining your own custom
+     * currency for billing purposes.
+     *
+     * POST /openmeter/currencies/custom
+     */
+    createCustomCurrency(request: CreateCustomCurrencyRequest, options?: RequestOptions): Promise<CreateCustomCurrencyResponse>;
+    /**
+     * List cost bases
+     *
+     * List cost bases for a currency. For custom currencies, there can be multiple
+     * cost bases with different `effective_from` dates.
+     *
+     * GET /openmeter/currencies/custom/{currencyId}/cost-bases
+     */
+    listCostBases(request: ListCostBasesRequest, options?: RequestOptions): Promise<ListCostBasesResponse>;
+    /**
+     * List cost bases
+     *
+     * List cost bases for a currency. For custom currencies, there can be multiple
+     * cost bases with different `effective_from` dates.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/currencies/custom/{currencyId}/cost-bases
+     */
+    listCostBasesAll(request: ListCostBasesRequest, options?: RequestOptions): AsyncIterable<CostBasis>;
+    /**
+     * Create cost basis
+     *
+     * Create a cost basis for a currency.
+     *
+     * POST /openmeter/currencies/custom/{currencyId}/cost-bases
+     */
+    createCostBasis(request: CreateCostBasisRequest, options?: RequestOptions): Promise<CreateCostBasisResponse>;
+}