@openmeter/client 1.0.0-beta.230 → 1.0.0-beta.231

package/dist/sdk/meters.js

@@ -1,30 +1,96 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
+import { paginatePages } from '../lib/paginate.js';
 import { createMeter, getMeter, listMeters, updateMeter, deleteMeter, queryMeter, queryMeterCsv, } from '../funcs/meters.js';
 export class Meters {
     _client;
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * Create meter
+     *
+     * Create a meter.
+     *
+     * POST /openmeter/meters
+     */
     async create(request, options) {
         return unwrap(await createMeter(this._client, request, options));
     }
+    /**
+     * Get meter
+     *
+     * Get a meter by ID.
+     *
+     * GET /openmeter/meters/{meterId}
+     */
     async get(request, options) {
         return unwrap(await getMeter(this._client, request, options));
     }
+    /**
+     * List meters
+     *
+     * List meters.
+     *
+     * GET /openmeter/meters
+     */
     async list(request, options) {
         return unwrap(await listMeters(this._client, request, options));
     }
+    /**
+     * List meters
+     *
+     * List meters.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/meters
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listMeters(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Update meter
+     *
+     * Update a meter.
+     *
+     * PUT /openmeter/meters/{meterId}
+     */
     async update(request, options) {
         return unwrap(await updateMeter(this._client, request, options));
     }
+    /**
+     * Delete meter
+     *
+     * Delete a meter.
+     *
+     * DELETE /openmeter/meters/{meterId}
+     */
     async delete(request, options) {
         return unwrap(await deleteMeter(this._client, request, options));
     }
+    /**
+     * Query meter
+     *
+     * Query a meter for usage.
+     *
+     * Set `Accept: application/json` (the default) to get a structured JSON response.
+     * Set `Accept: text/csv` to download the same data as a CSV file suitable for
+     * spreadsheets. The CSV columns, in order, are:
+     *
+     * `from, to, [subject,] [customer_id, customer_key, customer_name,] <dimensions...>, value`
+     *
+     * The `subject` column is emitted only when `subject` is in the query's
+     * `group_by_dimensions`. The three `customer_*` columns are emitted together only
+     * when `customer_id` is in the query's `group_by_dimensions`.
+     *
+     * POST /openmeter/meters/{meterId}/query
+     */
     async query(request, options) {
         return unwrap(await queryMeter(this._client, request, options));
     }
+    /** POST /openmeter/meters/{meterId}/query */
     async queryCsv(request, options) {
         return unwrap(await queryMeterCsv(this._client, request, options));
     }
 }
-//# sourceMappingURL=meters.js.map

package/dist/sdk/planAddons.d.ts

@@ -1,13 +1,58 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
 import type { ListPlanAddonsRequest, ListPlanAddonsResponse, CreatePlanAddonRequest, CreatePlanAddonResponse, GetPlanAddonRequest, GetPlanAddonResponse, UpdatePlanAddonRequest, UpdatePlanAddonResponse, DeletePlanAddonRequest, DeletePlanAddonResponse } from '../models/operations/planAddons.js';
+import type { PlanAddon } from '../models/types.js';
 export declare class PlanAddons {
     private readonly _client;
     constructor(_client: Client);
+    /**
+     * List add-ons for plan
+     *
+     * List add-ons associated with a plan.
+     *
+     * GET /openmeter/plans/{planId}/addons
+     */
     list(request: ListPlanAddonsRequest, options?: RequestOptions): Promise<ListPlanAddonsResponse>;
+    /**
+     * List add-ons for plan
+     *
+     * List add-ons associated with a plan.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/plans/{planId}/addons
+     */
+    listAll(request: ListPlanAddonsRequest, options?: RequestOptions): AsyncIterable<PlanAddon>;
+    /**
+     * Add add-on to plan
+     *
+     * Add an add-on to a plan.
+     *
+     * POST /openmeter/plans/{planId}/addons
+     */
     create(request: CreatePlanAddonRequest, options?: RequestOptions): Promise<CreatePlanAddonResponse>;
+    /**
+     * Get add-on association for plan
+     *
+     * Get an add-on association for a plan.
+     *
+     * GET /openmeter/plans/{planId}/addons/{planAddonId}
+     */
     get(request: GetPlanAddonRequest, options?: RequestOptions): Promise<GetPlanAddonResponse>;
+    /**
+     * Update add-on association for plan
+     *
+     * Update an add-on association for a plan.
+     *
+     * PUT /openmeter/plans/{planId}/addons/{planAddonId}
+     */
     update(request: UpdatePlanAddonRequest, options?: RequestOptions): Promise<UpdatePlanAddonResponse>;
+    /**
+     * Remove add-on from plan
+     *
+     * Remove an add-on from a plan.
+     *
+     * DELETE /openmeter/plans/{planId}/addons/{planAddonId}
+     */
     delete(request: DeletePlanAddonRequest, options?: RequestOptions): Promise<DeletePlanAddonResponse>;
 }
-//# sourceMappingURL=planAddons.d.ts.map

package/dist/sdk/planAddons.js

@@ -1,24 +1,72 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
+import { paginatePages } from '../lib/paginate.js';
 import { listPlanAddons, createPlanAddon, getPlanAddon, updatePlanAddon, deletePlanAddon, } from '../funcs/planAddons.js';
 export class PlanAddons {
     _client;
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * List add-ons for plan
+     *
+     * List add-ons associated with a plan.
+     *
+     * GET /openmeter/plans/{planId}/addons
+     */
     async list(request, options) {
         return unwrap(await listPlanAddons(this._client, request, options));
     }
+    /**
+     * List add-ons for plan
+     *
+     * List add-ons associated with a plan.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/plans/{planId}/addons
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listPlanAddons(this._client, req, opts), request, options);
+    }
+    /**
+     * Add add-on to plan
+     *
+     * Add an add-on to a plan.
+     *
+     * POST /openmeter/plans/{planId}/addons
+     */
     async create(request, options) {
         return unwrap(await createPlanAddon(this._client, request, options));
     }
+    /**
+     * Get add-on association for plan
+     *
+     * Get an add-on association for a plan.
+     *
+     * GET /openmeter/plans/{planId}/addons/{planAddonId}
+     */
     async get(request, options) {
         return unwrap(await getPlanAddon(this._client, request, options));
     }
+    /**
+     * Update add-on association for plan
+     *
+     * Update an add-on association for a plan.
+     *
+     * PUT /openmeter/plans/{planId}/addons/{planAddonId}
+     */
     async update(request, options) {
         return unwrap(await updatePlanAddon(this._client, request, options));
     }
+    /**
+     * Remove add-on from plan
+     *
+     * Remove an add-on from a plan.
+     *
+     * DELETE /openmeter/plans/{planId}/addons/{planAddonId}
+     */
     async delete(request, options) {
         return unwrap(await deletePlanAddon(this._client, request, options));
     }
 }
-//# sourceMappingURL=planAddons.js.map

package/dist/sdk/plans.d.ts

@@ -1,15 +1,74 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
 import type { ListPlansRequest, ListPlansResponse, CreatePlanRequest, CreatePlanResponse, UpdatePlanRequest, UpdatePlanResponse, GetPlanRequest, GetPlanResponse, DeletePlanRequest, DeletePlanResponse, ArchivePlanRequest, ArchivePlanResponse, PublishPlanRequest, PublishPlanResponse } from '../models/operations/plans.js';
+import type { Plan } from '../models/types.js';
 export declare class Plans {
     private readonly _client;
     constructor(_client: Client);
+    /**
+     * List plans
+     *
+     * List all plans.
+     *
+     * GET /openmeter/plans
+     */
     list(request?: ListPlansRequest, options?: RequestOptions): Promise<ListPlansResponse>;
+    /**
+     * List plans
+     *
+     * List all plans.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/plans
+     */
+    listAll(request?: ListPlansRequest, options?: RequestOptions): AsyncIterable<Plan>;
+    /**
+     * Create plan
+     *
+     * Create a new plan.
+     *
+     * POST /openmeter/plans
+     */
     create(request: CreatePlanRequest, options?: RequestOptions): Promise<CreatePlanResponse>;
+    /**
+     * Update plan
+     *
+     * Update a plan by id.
+     *
+     * PUT /openmeter/plans/{planId}
+     */
     update(request: UpdatePlanRequest, options?: RequestOptions): Promise<UpdatePlanResponse>;
+    /**
+     * Get plan
+     *
+     * Get a plan by id.
+     *
+     * GET /openmeter/plans/{planId}
+     */
     get(request: GetPlanRequest, options?: RequestOptions): Promise<GetPlanResponse>;
+    /**
+     * Delete plan
+     *
+     * Delete a plan by id.
+     *
+     * DELETE /openmeter/plans/{planId}
+     */
     delete(request: DeletePlanRequest, options?: RequestOptions): Promise<DeletePlanResponse>;
+    /**
+     * Archive plan version
+     *
+     * Archive a plan version.
+     *
+     * POST /openmeter/plans/{planId}/archive
+     */
     archive(request: ArchivePlanRequest, options?: RequestOptions): Promise<ArchivePlanResponse>;
+    /**
+     * Publish plan version
+     *
+     * Publish a plan version.
+     *
+     * POST /openmeter/plans/{planId}/publish
+     */
     publish(request: PublishPlanRequest, options?: RequestOptions): Promise<PublishPlanResponse>;
 }
-//# sourceMappingURL=plans.d.ts.map

package/dist/sdk/plans.js

@@ -1,30 +1,92 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
+import { paginatePages } from '../lib/paginate.js';
 import { listPlans, createPlan, updatePlan, getPlan, deletePlan, archivePlan, publishPlan, } from '../funcs/plans.js';
 export class Plans {
     _client;
     constructor(_client) {
         this._client = _client;
     }
+    /**
+     * List plans
+     *
+     * List all plans.
+     *
+     * GET /openmeter/plans
+     */
     async list(request, options) {
         return unwrap(await listPlans(this._client, request, options));
     }
+    /**
+     * List plans
+     *
+     * List all plans.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/plans
+     */
+    listAll(request, options) {
+        return paginatePages((req, opts) => listPlans(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Create plan
+     *
+     * Create a new plan.
+     *
+     * POST /openmeter/plans
+     */
     async create(request, options) {
         return unwrap(await createPlan(this._client, request, options));
     }
+    /**
+     * Update plan
+     *
+     * Update a plan by id.
+     *
+     * PUT /openmeter/plans/{planId}
+     */
     async update(request, options) {
         return unwrap(await updatePlan(this._client, request, options));
     }
+    /**
+     * Get plan
+     *
+     * Get a plan by id.
+     *
+     * GET /openmeter/plans/{planId}
+     */
     async get(request, options) {
         return unwrap(await getPlan(this._client, request, options));
     }
+    /**
+     * Delete plan
+     *
+     * Delete a plan by id.
+     *
+     * DELETE /openmeter/plans/{planId}
+     */
     async delete(request, options) {
         return unwrap(await deletePlan(this._client, request, options));
     }
+    /**
+     * Archive plan version
+     *
+     * Archive a plan version.
+     *
+     * POST /openmeter/plans/{planId}/archive
+     */
     async archive(request, options) {
         return unwrap(await archivePlan(this._client, request, options));
     }
+    /**
+     * Publish plan version
+     *
+     * Publish a plan version.
+     *
+     * POST /openmeter/plans/{planId}/publish
+     */
     async publish(request, options) {
         return unwrap(await publishPlan(this._client, request, options));
     }
 }
-//# sourceMappingURL=plans.js.map

package/dist/sdk/sdk.d.ts

@@ -6,16 +6,14 @@ import { Entitlements } from './entitlements.js';
 import { Subscriptions } from './subscriptions.js';
 import { Apps } from './apps.js';
 import { Billing } from './billing.js';
-import { Invoices } from './invoices.js';
 import { Tax } from './tax.js';
-import { Currencies } from './currencies.js';
 import { Features } from './features.js';
 import { LLMCost } from './llmCost.js';
 import { Plans } from './plans.js';
 import { Addons } from './addons.js';
 import { PlanAddons } from './planAddons.js';
 import { Defaults } from './defaults.js';
-import { Governance } from './governance.js';
+import { Internal } from './internal.js';
 export declare class OpenMeter extends Client {
     private _events?;
     get events(): Events;
@@ -31,12 +29,8 @@ export declare class OpenMeter extends Client {
     get apps(): Apps;
     private _billing?;
     get billing(): Billing;
-    private _invoices?;
-    get invoices(): Invoices;
     private _tax?;
     get tax(): Tax;
-    private _currencies?;
-    get currencies(): Currencies;
     private _features?;
     get features(): Features;
     private _llmCost?;
@@ -49,7 +43,12 @@ export declare class OpenMeter extends Client {
     get planAddons(): PlanAddons;
     private _defaults?;
     get defaults(): Defaults;
-    private _governance?;
-    get governance(): Governance;
+    private _internal?;
+    /**
+     * 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.
+     */
+    get internal(): Internal;
 }
-//# sourceMappingURL=sdk.d.ts.map

package/dist/sdk/sdk.js

@@ -1,3 +1,4 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { Client } from '../core.js';
 import { Events } from './events.js';
 import { Meters } from './meters.js';
@@ -6,16 +7,14 @@ import { Entitlements } from './entitlements.js';
 import { Subscriptions } from './subscriptions.js';
 import { Apps } from './apps.js';
 import { Billing } from './billing.js';
-import { Invoices } from './invoices.js';
 import { Tax } from './tax.js';
-import { Currencies } from './currencies.js';
 import { Features } from './features.js';
 import { LLMCost } from './llmCost.js';
 import { Plans } from './plans.js';
 import { Addons } from './addons.js';
 import { PlanAddons } from './planAddons.js';
 import { Defaults } from './defaults.js';
-import { Governance } from './governance.js';
+import { Internal } from './internal.js';
 export class OpenMeter extends Client {
     _events;
     get events() {
@@ -45,18 +44,10 @@ export class OpenMeter extends Client {
     get billing() {
         return (this._billing ??= new Billing(this));
     }
-    _invoices;
-    get invoices() {
-        return (this._invoices ??= new Invoices(this));
-    }
     _tax;
     get tax() {
         return (this._tax ??= new Tax(this));
     }
-    _currencies;
-    get currencies() {
-        return (this._currencies ??= new Currencies(this));
-    }
     _features;
     get features() {
         return (this._features ??= new Features(this));
@@ -81,9 +72,14 @@ export class OpenMeter extends Client {
     get defaults() {
         return (this._defaults ??= new Defaults(this));
     }
-    _governance;
-    get governance() {
-        return (this._governance ??= new Governance(this));
+    _internal;
+    /**
+     * 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.
+     */
+    get internal() {
+        return (this._internal ??= new Internal(this));
     }
 }
-//# sourceMappingURL=sdk.js.map

package/dist/sdk/subscriptions.d.ts

@@ -1,17 +1,86 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
-import type { CreateSubscriptionRequest, CreateSubscriptionResponse, ListSubscriptionsRequest, ListSubscriptionsResponse, GetSubscriptionRequest, GetSubscriptionResponse, CancelSubscriptionRequest, CancelSubscriptionResponse, UnscheduleCancelationRequest, UnscheduleCancelationResponse, ChangeSubscriptionRequest, ChangeSubscriptionResponse, CreateSubscriptionAddonRequest, CreateSubscriptionAddonResponse, ListSubscriptionAddonsRequest, ListSubscriptionAddonsResponse, GetSubscriptionAddonRequest, GetSubscriptionAddonResponse } from '../models/operations/subscriptions.js';
+import type { CreateSubscriptionRequest, CreateSubscriptionResponse, ListSubscriptionsRequest, ListSubscriptionsResponse, GetSubscriptionRequest, GetSubscriptionResponse, CancelSubscriptionRequest, CancelSubscriptionResponse, UnscheduleCancelationRequest, UnscheduleCancelationResponse, ChangeSubscriptionRequest, ChangeSubscriptionResponse, ListSubscriptionAddonsRequest, ListSubscriptionAddonsResponse, GetSubscriptionAddonRequest, GetSubscriptionAddonResponse } from '../models/operations/subscriptions.js';
+import type { Subscription, SubscriptionAddon } from '../models/types.js';
 export declare class Subscriptions {
     private readonly _client;
     constructor(_client: Client);
+    /**
+     * Create subscription
+     *
+     * POST /openmeter/subscriptions
+     */
     create(request: CreateSubscriptionRequest, options?: RequestOptions): Promise<CreateSubscriptionResponse>;
+    /**
+     * List subscriptions
+     *
+     * GET /openmeter/subscriptions
+     */
     list(request?: ListSubscriptionsRequest, options?: RequestOptions): Promise<ListSubscriptionsResponse>;
+    /**
+     * List subscriptions
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/subscriptions
+     */
+    listAll(request?: ListSubscriptionsRequest, options?: RequestOptions): AsyncIterable<Subscription>;
+    /**
+     * Get subscription
+     *
+     * GET /openmeter/subscriptions/{subscriptionId}
+     */
     get(request: GetSubscriptionRequest, options?: RequestOptions): Promise<GetSubscriptionResponse>;
+    /**
+     * Cancel subscription
+     *
+     * Cancels the subscription. Will result in a scheduling conflict if there are
+     * other subscriptions scheduled to start after the cancelation time.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/cancel
+     */
     cancel(request: CancelSubscriptionRequest, options?: RequestOptions): Promise<CancelSubscriptionResponse>;
+    /**
+     * Unschedule subscription cancelation
+     *
+     * Unschedules the subscription cancelation.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/unschedule-cancelation
+     */
     unscheduleCancelation(request: UnscheduleCancelationRequest, options?: RequestOptions): Promise<UnscheduleCancelationResponse>;
+    /**
+     * Change subscription
+     *
+     * Closes a running subscription and starts a new one according to the
+     * specification. Can be used for upgrades, downgrades, and plan changes.
+     *
+     * POST /openmeter/subscriptions/{subscriptionId}/change
+     */
     change(request: ChangeSubscriptionRequest, options?: RequestOptions): Promise<ChangeSubscriptionResponse>;
-    createAddon(request: CreateSubscriptionAddonRequest, options?: RequestOptions): Promise<CreateSubscriptionAddonResponse>;
+    /**
+     * List subscription addons
+     *
+     * List the add-ons of a subscription.
+     *
+     * GET /openmeter/subscriptions/{subscriptionId}/addons
+     */
     listAddons(request: ListSubscriptionAddonsRequest, options?: RequestOptions): Promise<ListSubscriptionAddonsResponse>;
+    /**
+     * List subscription addons
+     *
+     * List the add-ons of a subscription.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/subscriptions/{subscriptionId}/addons
+     */
+    listAddonsAll(request: ListSubscriptionAddonsRequest, options?: RequestOptions): AsyncIterable<SubscriptionAddon>;
+    /**
+     * Get add-on association for subscription
+     *
+     * Get an add-on association for a subscription.
+     *
+     * GET /openmeter/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}
+     */
     getAddon(request: GetSubscriptionAddonRequest, options?: RequestOptions): Promise<GetSubscriptionAddonResponse>;
 }
-//# sourceMappingURL=subscriptions.d.ts.map