@openmeter/client 1.0.0-beta-d30d21dce71a → 1.0.0-beta-c725b4d6b371

package/dist/models/operations/addons.d.ts

@@ -5,7 +5,18 @@ export interface ListAddonsQuery {
         size?: number;
         number?: number;
     };
-    /** Sort add-ons returned in the response. Supported sort attributes are: - `id` - `key` - `name` - `created_at` (default) - `updated_at` The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. */
+    /**
+     * Sort add-ons returned in the response. Supported sort attributes are:
+     *
+     * - `id`
+     * - `key`
+     * - `name`
+     * - `created_at` (default)
+     * - `updated_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
     sort?: SortQueryInput;
     /** Filter add-ons returned in the response. */
     filter?: ListAddonsParamsFilter;

package/dist/models/operations/currencies.d.ts

@@ -5,9 +5,21 @@ export interface ListCurrenciesQuery {
         size?: number;
         number?: number;
     };
-    /** Sort currencies returned in the response. Supported sort attributes are: - `code` (default) - `name` The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. */
+    /**
+     * Sort currencies returned in the response. Supported sort attributes are:
+     *
+     * - `code` (default)
+     * - `name`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
     sort?: SortQueryInput;
-    /** Filter currencies returned in the response. To filter currencies by type add the following query param: filter[type]=custom */
+    /**
+     * Filter currencies returned in the response.
+     *
+     * To filter currencies by type add the following query param: filter[type]=custom
+     */
     filter?: ListCurrenciesParamsFilter;
 }
 export type ListCurrenciesRequest = ListCurrenciesQuery;
@@ -15,7 +27,12 @@ export type ListCurrenciesResponse = CurrencyPagePaginatedResponse;
 export type CreateCustomCurrencyRequest = CreateCurrencyCustomRequest;
 export type CreateCustomCurrencyResponse = CurrencyCustom;
 export interface ListCostBasesQuery {
-    /** Filter cost bases returned in the response. To filter cost bases by fiat currency code add the following query param: filter[fiat_code]=USD */
+    /**
+     * Filter cost bases returned in the response.
+     *
+     * To filter cost bases by fiat currency code add the following query param:
+     * filter[fiat_code]=USD
+     */
     filter?: ListCostBasesParamsFilter;
     /** Determines which page of the collection to retrieve. */
     page?: {

package/dist/models/operations/customers.d.ts

@@ -13,9 +13,22 @@ export interface ListCustomersQuery {
         size?: number;
         number?: number;
     };
-    /** Sort customers returned in the response. Supported sort attributes are: - `id` - `name` (default) - `created_at` The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. */
+    /**
+     * Sort customers returned in the response. Supported sort attributes are:
+     *
+     * - `id`
+     * - `name` (default)
+     * - `created_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
     sort?: SortQueryInput;
-    /** Filter customers returned in the response. To filter customers by key add the following query param: filter[key]=my-db-id */
+    /**
+     * Filter customers returned in the response.
+     *
+     * To filter customers by key add the following query param: filter[key]=my-db-id
+     */
     filter?: ListCustomersParamsFilter;
 }
 export type ListCustomersRequest = ListCustomersQuery;
@@ -77,7 +90,11 @@ export type ListCreditGrantsRequest = ListCreditGrantsQuery & {
 };
 export type ListCreditGrantsResponse = CreditGrantPagePaginatedResponse;
 export interface GetCustomerCreditBalanceQuery {
-    /** Return the credit balance as of this timestamp. Defaults to the current time. */
+    /**
+     * Return the credit balance as of this timestamp.
+     *
+     * Defaults to the current time.
+     */
     timestamp?: string;
     filter?: GetCreditBalanceParamsFilter;
 }
@@ -111,11 +128,31 @@ export interface ListCustomerChargesQuery {
         size?: number;
         number?: number;
     };
-    /** Sort charges returned in the response. Supported sort attributes are: - `id` - `created_at` - `service_period.from` - `billing_period.from` */
+    /**
+     * Sort charges returned in the response.
+     *
+     * Supported sort attributes are:
+     *
+     * - `id`
+     * - `created_at`
+     * - `service_period.from`
+     * - `billing_period.from`
+     */
     sort?: SortQueryInput;
-    /** Filter charges. To filter charges by status add the following query param: `filter[status][oeq]=created,active` */
+    /**
+     * Filter charges.
+     *
+     * To filter charges by status add the following query param:
+     * `filter[status][oeq]=created,active`
+     */
     filter?: ListChargesParamsFilter;
-    /** Expand full objects for referenced entities. Supported values are: - `real_time_usage`: Expand the charge's real-time usage. */
+    /**
+     * Expand full objects for referenced entities.
+     *
+     * Supported values are:
+     *
+     * - `real_time_usage`: Expand the charge's real-time usage.
+     */
     expand?: 'real_time_usage'[];
 }
 export type ListCustomerChargesRequest = ListCustomerChargesQuery & {

package/dist/models/operations/events.d.ts

@@ -1,9 +1,24 @@
 import type { CursorPaginationQueryPage, EventInput, IngestedEventPaginatedResponse, ListEventsParamsFilter, SortQueryInput } from '../types.js';
 export interface ListMeteringEventsQuery {
     page?: CursorPaginationQueryPage;
-    /** Filter events returned in the response. To filter events by subject add the following query param: filter[subject][eq]=customer-1 */
+    /**
+     * Filter events returned in the response.
+     *
+     * To filter events by subject add the following query param:
+     * filter[subject][eq]=customer-1
+     */
     filter?: ListEventsParamsFilter;
-    /** Sort events returned in the response. Supported sort attributes are: - `time` (default) - `ingested_at` - `stored_at` When omitted, events are sorted by `time desc` (most recent first). When a sort field is provided without a suffix, it sorts descending. Append the `asc` suffix to sort ascending, or the `desc` suffix to sort descending. */
+    /**
+     * Sort events returned in the response. Supported sort attributes are:
+     *
+     * - `time` (default)
+     * - `ingested_at`
+     * - `stored_at`
+     *
+     * When omitted, events are sorted by `time desc` (most recent first). When a sort
+     * field is provided without a suffix, it sorts descending. Append the `asc` suffix
+     * to sort ascending, or the `desc` suffix to sort descending.
+     */
     sort?: SortQueryInput;
 }
 export type ListMeteringEventsRequest = ListMeteringEventsQuery;

package/dist/models/operations/features.d.ts

@@ -5,9 +5,24 @@ export interface ListFeaturesQuery {
         size?: number;
         number?: number;
     };
-    /** Sort features returned in the response. Supported sort attributes are: - `key` - `name` - `created_at` (default) - `updated_at` The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. */
+    /**
+     * Sort features returned in the response. Supported sort attributes are:
+     *
+     * - `key`
+     * - `name`
+     * - `created_at` (default)
+     * - `updated_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
     sort?: SortQueryInput;
-    /** Filter features returned in the response. To filter features by meter_id add the following query param: filter[meter_id][oeq]=<id> */
+    /**
+     * Filter features returned in the response.
+     *
+     * To filter features by meter_id add the following query param:
+     * filter[meter_id][oeq]=<id>
+     */
     filter?: ListFeatureParamsFilter;
 }
 export type ListFeaturesRequest = ListFeaturesQuery;

package/dist/models/operations/llmCost.d.ts

@@ -2,7 +2,18 @@ import type { ListLlmCostPricesParamsFilter, LlmCostOverrideCreate, LlmCostPrice
 export interface ListLlmCostPricesQuery {
     /** Filter prices. */
     filter?: ListLlmCostPricesParamsFilter;
-    /** Sort prices returned in the response. Supported sort attributes are: - `id` - `provider.id` - `model.id` (default) - `effective_from` - `effective_to` The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. */
+    /**
+     * Sort prices returned in the response. Supported sort attributes are:
+     *
+     * - `id`
+     * - `provider.id`
+     * - `model.id` (default)
+     * - `effective_from`
+     * - `effective_to`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
     sort?: SortQueryInput;
     /** Determines which page of the collection to retrieve. */
     page?: {

package/dist/models/operations/meters.d.ts

@@ -11,9 +11,24 @@ export interface ListMetersQuery {
         size?: number;
         number?: number;
     };
-    /** Sort meters returned in the response. Supported sort attributes are: - `key` - `name` - `aggregation` - `createdAt` (default) - `updatedAt` The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. */
+    /**
+     * Sort meters returned in the response. Supported sort attributes are:
+     *
+     * - `key`
+     * - `name`
+     * - `aggregation`
+     * - `created_at` (default)
+     * - `updated_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
     sort?: SortQueryInput;
-    /** Filter meters returned in the response. To filter meters by key add the following query param: filter[key]=my-meter-key */
+    /**
+     * Filter meters returned in the response.
+     *
+     * To filter meters by key add the following query param: filter[key]=my-meter-key
+     */
     filter?: ListMetersParamsFilter;
 }
 export type ListMetersRequest = ListMetersQuery;

package/dist/models/operations/plans.d.ts

@@ -5,7 +5,15 @@ export interface ListPlansQuery {
         size?: number;
         number?: number;
     };
-    /** Sort plans returned in the response. Supported sort attributes are: - `id` - `key` - `version` - `created_at` (default) - `updated_at` */
+    /**
+     * Sort plans returned in the response. Supported sort attributes are:
+     *
+     * - `id`
+     * - `key`
+     * - `version`
+     * - `created_at` (default)
+     * - `updated_at`
+     */
     sort?: SortQueryInput;
     /** Filter plans returned in the response. */
     filter?: ListPlansParamsFilter;

package/dist/models/operations/subscriptions.d.ts

@@ -7,7 +7,16 @@ export interface ListSubscriptionsQuery {
         size?: number;
         number?: number;
     };
-    /** Sort subscriptions returned in the response. Supported sort attributes are: - `id` - `active_from` (default) - `active_to` The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. */
+    /**
+     * Sort subscriptions returned in the response. Supported sort attributes are:
+     *
+     * - `id`
+     * - `active_from` (default)
+     * - `active_to`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
     sort?: SortQueryInput;
     /** Filter subscriptions. */
     filter?: ListSubscriptionsParamsFilter;
@@ -38,6 +47,17 @@ export interface ListSubscriptionAddonsQuery {
         size?: number;
         number?: number;
     };
+    /**
+     * Sort subscription addons returned in the response. Supported sort attributes
+     * are:
+     *
+     * - `id`
+     * - `created_at` (default)
+     * - `updated_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
     sort?: SortQueryInput;
 }
 export type ListSubscriptionAddonsRequest = ListSubscriptionAddonsQuery & {