@openmeter/sdk 1.0.0-beta.224 → 1.0.0-beta.225

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/README.md +200 -0
  2. package/dist/cjs/src/client/features.d.cts +9 -0
  3. package/dist/cjs/src/client/notifications.d.cts +6 -0
  4. package/dist/cjs/src/client/schemas.d.cts +719 -98
  5. package/dist/cjs/src/client/subscriptions.d.cts +5 -0
  6. package/dist/cjs/src/zod/index.cjs +372 -37
  7. package/dist/cjs/src/zod/index.d.cts +398 -16
  8. package/dist/cjs/src/zod/index.js.map +1 -1
  9. package/dist/cjs/{tsconfig.041f8f6a.tsbuildinfo → tsconfig.7db92107.tsbuildinfo} +1 -1
  10. package/dist/cjs/{tsconfig.c55e75d7.tsbuildinfo → tsconfig.94dd8c51.tsbuildinfo} +1 -1
  11. package/dist/src/client/features.d.ts +9 -0
  12. package/dist/src/client/notifications.d.ts +6 -0
  13. package/dist/src/client/schemas.d.ts +719 -98
  14. package/dist/src/client/subscriptions.d.ts +5 -0
  15. package/dist/src/zod/index.d.ts +398 -16
  16. package/dist/src/zod/index.js +352 -18
  17. package/dist/src/zod/index.js.map +1 -1
  18. package/dist/tsconfig.tsbuildinfo +1 -1
  19. package/package.json +1 -1
package/README.md CHANGED
@@ -65,3 +65,203 @@ function UsageComponent() {
65
65
  // ...
66
66
  }
67
67
  ```
68
+
69
+ ## Ingest usage events
70
+
71
+ ```ts
72
+ // Ingest a single AI token usage event
73
+ await openmeter.events.ingest({
74
+ type: 'ai-tokens',
75
+ subject: 'customer-acme-corp',
76
+ id: 'evt_01234567', // optional: auto-generated if not provided
77
+ source: 'llm-api-gateway', // optional: defaults to '@openmeter/sdk'
78
+ time: new Date(), // optional: defaults to current time
79
+ data: {
80
+ model: 'gpt-4',
81
+ type: 'input',
82
+ tokens: 1250,
83
+ },
84
+ })
85
+
86
+ // Ingest multiple events in a batch for better performance
87
+ await openmeter.events.ingest([
88
+ {
89
+ type: 'ai-tokens',
90
+ subject: 'customer-acme-corp',
91
+ data: { model: 'gpt-4', type: 'input', tokens: 850 },
92
+ },
93
+ {
94
+ type: 'ai-tokens',
95
+ subject: 'customer-acme-corp',
96
+ data: { model: 'gpt-4', type: 'output', tokens: 850 },
97
+ },
98
+ ])
99
+ ```
100
+
101
+ ## Client API Reference
102
+
103
+ The OpenMeter SDK provides a comprehensive client interface organized into logical groups. Below is a complete reference of all available methods.
104
+
105
+ ### Overview
106
+
107
+ | Namespace | Resource | Operation | Method | Description |
108
+ |-----------|----------|-----------|--------|-------------|
109
+ | **[Events](#events)** | | | | Track usage by ingesting events |
110
+ | | Events | Create | [`openmeter.events.ingest(events)`](./src/client/events.ts#L19) | Ingest a single event or batch of events |
111
+ | | Events | Read | [`openmeter.events.list(params?)`](./src/client/events.ts#L41) | List ingested events with advanced filtering |
112
+ | | Events | Read | [`openmeter.events.listV2(params?)`](./src/client/events.ts#L60) | List ingested events with advanced filtering (V2) |
113
+ | **[Meters](#meters)** | | | | Track and aggregate usage data from events |
114
+ | | Meters | Create | [`openmeter.meters.create(meter)`](./src/client/meters.ts#L19) | Create a new meter |
115
+ | | Meters | Read | [`openmeter.meters.get(idOrSlug)`](./src/client/meters.ts#L34) | Get a meter by ID or slug |
116
+ | | Meters | Read | [`openmeter.meters.list()`](./src/client/meters.ts#L55) | List all meters |
117
+ | | Meters | Read | [`openmeter.meters.query(idOrSlug, query?)`](./src/client/meters.ts#L70) | Query usage data |
118
+ | | Meters | Update | [`openmeter.meters.update(idOrSlug, meter)`](./src/client/meters.ts#L100) | Update a meter by ID or slug |
119
+ | | Meters | Delete | [`openmeter.meters.delete(idOrSlug)`](./src/client/meters.ts#L124) | Delete a meter by ID or slug |
120
+ | **[Subjects](#subjects)** | | | | Manage entities that consume resources |
121
+ | | Subjects | Create | [`openmeter.subjects.upsert(subjects)`](./src/client/subjects.ts#L21) | Create or update one or multiple subjects |
122
+ | | Subjects | Read | [`openmeter.subjects.get(idOrKey)`](./src/client/subjects.ts#L39) | Get a subject by ID or key |
123
+ | | Subjects | Read | [`openmeter.subjects.list()`](./src/client/subjects.ts#L60) | List all subjects |
124
+ | | Subjects | Delete | [`openmeter.subjects.delete(idOrKey)`](./src/client/subjects.ts#L74) | Delete a subject by ID or key |
125
+ | **[Customers](#customers)** | | | | Manage customer subscription lifecycles and plan assignments |
126
+ | | Customers | Create | [`openmeter.customers.create(customer)`](./src/client/customers.ts#L37) | Create a new customer |
127
+ | | Customers | Read | [`openmeter.customers.get(customerIdOrKey)`](./src/client/customers.ts#L52) | Get a customer by ID or key |
128
+ | | Customers | Read | [`openmeter.customers.list(query?)`](./src/client/customers.ts#L123) | List all customers |
129
+ | | Customers | Read | [`openmeter.customers.getAccess(customerIdOrKey)`](./src/client/customers.ts#L143) | Get customer access information |
130
+ | | Customers | Read | [`openmeter.customers.listSubscriptions(customerIdOrKey, query?)`](./src/client/customers.ts#L169) | List customer subscriptions |
131
+ | | Customers | Update | [`openmeter.customers.update(customerIdOrKey, customer)`](./src/client/customers.ts#L75) | Update a customer |
132
+ | | Customers | Delete | [`openmeter.customers.delete(customerIdOrKey)`](./src/client/customers.ts#L99) | Delete a customer |
133
+ | | Apps | Update | [`openmeter.customers.apps.upsert(customerIdOrKey, appData)`](./src/client/customers.ts#L200) | Upsert app data |
134
+ | | Apps | Read | [`openmeter.customers.apps.list(customerIdOrKey)`](./src/client/customers.ts#L228) | List app data |
135
+ | | Apps | Delete | [`openmeter.customers.apps.delete(customerIdOrKey, appId)`](./src/client/customers.ts#L254) | Delete app data |
136
+ | | Stripe | Update | [`openmeter.customers.stripe.upsert(customerIdOrKey, appDataBase)`](./src/client/customers.ts#L285) | Upsert Stripe app data |
137
+ | | Stripe | Read | [`openmeter.customers.stripe.get(customerIdOrKey)`](./src/client/customers.ts#L313) | Get Stripe app data |
138
+ | | Stripe | Create | [`openmeter.customers.stripe.createPortalSession(customerIdOrKey, params)`](./src/client/customers.ts#L337) | Create a Stripe customer portal session |
139
+ | | Entitlements V1 | Read | [`openmeter.customers.entitlementsV1.value(customerIdOrKey, featureKey)`](./src/client/customers.ts#L372) | Get entitlement value (V1 API) |
140
+ | | Entitlements | Read | [`openmeter.customers.entitlements.list(customerIdOrKey)`](./src/client/customers.ts#L401) | List entitlements |
141
+ | | Entitlements | Create | [`openmeter.customers.entitlements.create(customerIdOrKey, entitlement)`](./src/client/customers.ts#L428) | Create an entitlement |
142
+ | | Entitlements | Read | [`openmeter.customers.entitlements.get(customerIdOrKey, featureKeyOrId)`](./src/client/customers.ts#L454) | Get an entitlement |
143
+ | | Entitlements | Delete | [`openmeter.customers.entitlements.delete(customerIdOrKey, entitlementId)`](./src/client/customers.ts#L479) | Delete an entitlement |
144
+ | | Entitlements | Update | [`openmeter.customers.entitlements.override(customerIdOrKey, featureKeyOrId, entitlement)`](./src/client/customers.ts#L505) | Override an entitlement |
145
+ | | Entitlements | Read | [`openmeter.customers.entitlements.value(customerIdOrKey, featureKeyOrId, query?)`](./src/client/customers.ts#L588) | Get entitlement value |
146
+ | | Entitlements | Read | [`openmeter.customers.entitlements.history(customerIdOrKey, featureKeyOrId, query?)`](./src/client/customers.ts#L617) | Get entitlement history |
147
+ | | Entitlements | Update | [`openmeter.customers.entitlements.resetUsage(customerIdOrKey, entitlementId, body?)`](./src/client/customers.ts#L653) | Reset usage |
148
+ | | Entitlements | Read | [`openmeter.customers.entitlements.listGrants(customerIdOrKey, featureKeyOrId, query?)`](./src/client/customers.ts#L532) | List grants |
149
+ | | Entitlements | Create | [`openmeter.customers.entitlements.createGrant(customerIdOrKey, featureKeyOrId, grant)`](./src/client/customers.ts#L561) | Create a grant |
150
+ | **[Features](#features)** | | | | Define application capabilities and services |
151
+ | | Features | Create | [`openmeter.features.create(feature)`](./src/client/features.ts#L24) | Create a new feature |
152
+ | | Features | Read | [`openmeter.features.get(featureIdOrKey)`](./src/client/features.ts#L39) | Get a feature by ID |
153
+ | | Features | Read | [`openmeter.features.list(params?)`](./src/client/features.ts#L61) | List all features |
154
+ | | Features | Delete | [`openmeter.features.delete(featureIdOrKey)`](./src/client/features.ts#L84) | Delete a feature by ID |
155
+ | **[Entitlements (V1)](#entitlements-v1)** | | | | Subject-based usage limits and access controls |
156
+ | | Entitlements | Create | [`openmeter.entitlementsV1.create(subjectIdOrKey, entitlement)`](./src/client/entitlements.ts#L40) | Create an entitlement for a subject |
157
+ | | Entitlements | Read | [`openmeter.entitlementsV1.get(entitlementId)`](./src/client/entitlements.ts#L68) | Get an entitlement by ID |
158
+ | | Entitlements | Read | [`openmeter.entitlementsV1.list(query?)`](./src/client/entitlements.ts#L91) | List all entitlements |
159
+ | | Entitlements | Read | [`openmeter.entitlementsV1.value(subjectIdOrKey, featureIdOrKey, query?)`](./src/client/entitlements.ts#L147) | Get the value of an entitlement |
160
+ | | Entitlements | Read | [`openmeter.entitlementsV1.history(subjectIdOrKey, entitlementIdOrFeatureKey, query?)`](./src/client/entitlements.ts#L180) | Get the history of an entitlement |
161
+ | | Entitlements | Update | [`openmeter.entitlementsV1.override(subjectIdOrKey, entitlementIdOrFeatureKey, override)`](./src/client/entitlements.ts#L213) | Override an entitlement |
162
+ | | Entitlements | Update | [`openmeter.entitlementsV1.reset(subjectIdOrKey, entitlementIdOrFeatureKey, reset?)`](./src/client/entitlements.ts#L247) | Reset entitlement usage |
163
+ | | Entitlements | Delete | [`openmeter.entitlementsV1.delete(subjectIdOrKey, entitlementId)`](./src/client/entitlements.ts#L116) | Delete an entitlement |
164
+ | | Grants | Create | [`openmeter.entitlementsV1.grants.create(subjectIdOrKey, entitlementIdOrFeatureKey, grant)`](./src/client/entitlements.ts#L283) | Create a grant for an entitlement |
165
+ | | Grants | Read | [`openmeter.entitlementsV1.grants.list(subjectIdOrKey, entitlementIdOrFeatureKey, query?)`](./src/client/entitlements.ts#L314) | List grants for an entitlement |
166
+ | | Grants | Read | [`openmeter.entitlementsV1.grants.listAll(query?)`](./src/client/entitlements.ts#L345) | List all grants |
167
+ | | Grants | Delete | [`openmeter.entitlementsV1.grants.void(entitlementId, grantId)`](./src/client/entitlements.ts#L369) | Void a grant |
168
+ | **[Entitlements](#entitlements)** | | | | Customer-based entitlements and access controls |
169
+ | | Entitlements | Read | [`openmeter.entitlements.list(query?)`](./src/client/entitlements.ts#L404) | List all entitlements (admin purposes) |
170
+ | | Entitlements | Read | [`openmeter.entitlements.get(entitlementId)`](./src/client/entitlements.ts#L425) | Get an entitlement by ID |
171
+ | | Grants | Read | [`openmeter.entitlements.grants.list(query?)`](./src/client/entitlements.ts#L453) | List all grants (admin purposes) |
172
+ | | Grants | Delete | [`openmeter.entitlements.grants.void(grantId)`](./src/client/entitlements.ts#L478) | Void a grant |
173
+ | **[Plans](#plans)** | | | | Manage subscription plans and pricing|
174
+ | | Plans | Create | [`openmeter.plans.create(plan)`](./src/client/plans.ts#L28) | Create a new plan|
175
+ | | Plans | Read | [`openmeter.plans.get(planId)`](./src/client/plans.ts#L44) | Get a plan by ID|
176
+ | | Plans | Read | [`openmeter.plans.list(query?)`](./src/client/plans.ts#L66) | List all plans|
177
+ | | Plans | Update | [`openmeter.plans.update(planId, plan)`](./src/client/plans.ts#L85) | Update a plan|
178
+ | | Plans | Delete | [`openmeter.plans.delete(planId)`](./src/client/plans.ts#L105) | Delete a plan by ID|
179
+ | | Plans | Other | [`openmeter.plans.archive(planId)`](./src/client/plans.ts#L123) | Archive a plan|
180
+ | | Plans | Other | [`openmeter.plans.publish(planId)`](./src/client/plans.ts#L141) | Publish a plan|
181
+ | | Addons | Read | [`openmeter.plans.addons.list(planId)`](./src/client/plans.ts#L168) | List addons|
182
+ | | Addons | Create | [`openmeter.plans.addons.create(planId, addon)`](./src/client/plans.ts#L191) | Create an addon|
183
+ | | Addons | Read | [`openmeter.plans.addons.get(planId, planAddonId)`](./src/client/plans.ts#L212) | Get an addon by ID|
184
+ | | Addons | Update | [`openmeter.plans.addons.update(planId, planAddonId, addon)`](./src/client/plans.ts#L238) | Update an addon|
185
+ | | Addons | Delete | [`openmeter.plans.addons.delete(planId, planAddonId)`](./src/client/plans.ts#L263) | Delete an addon by ID|
186
+ | **[Addons](#addons)** | | | | Manage standalone addons available across plans|
187
+ | | Addons | Create | [`openmeter.addons.create(addon)`](./src/client/addons.ts#L15) | Create a new addon|
188
+ | | Addons | Read | [`openmeter.addons.get(addonId)`](./src/client/addons.ts#L48) | Get an addon by ID|
189
+ | | Addons | Read | [`openmeter.addons.list(query?)`](./src/client/addons.ts#L30) | List all addons|
190
+ | | Addons | Update | [`openmeter.addons.update(addonId, addon)`](./src/client/addons.ts#L64) | Update an addon|
191
+ | | Addons | Delete | [`openmeter.addons.delete(addonId)`](./src/client/addons.ts#L84) | Delete an addon by ID|
192
+ | | Addons | Other | [`openmeter.addons.publish(addonId)`](./src/client/addons.ts#L99) | Publish an addon|
193
+ | | Addons | Other | [`openmeter.addons.archive(addonId)`](./src/client/addons.ts#L114) | Archive an addon|
194
+ | **[Subscriptions](#subscriptions)** | | | | Manage customer subscriptions|
195
+ | | Subscriptions | Create | [`openmeter.subscriptions.create(body)`](./src/client/subscriptions.ts#L24) | Create a new subscription|
196
+ | | Subscriptions | Read | [`openmeter.subscriptions.get(subscriptionId)`](./src/client/subscriptions.ts#L39) | Get a subscription by ID|
197
+ | | Subscriptions | Update | [`openmeter.subscriptions.edit(subscriptionId, body)`](./src/client/subscriptions.ts#L61) | Edit a subscription|
198
+ | | Subscriptions | Delete | [`openmeter.subscriptions.delete(subscriptionId)`](./src/client/subscriptions.ts#L180) | Delete a subscription (only scheduled)|
199
+ | | Subscriptions | Other | [`openmeter.subscriptions.cancel(subscriptionId, body?)`](./src/client/subscriptions.ts#L85) | Cancel a subscription|
200
+ | | Subscriptions | Other | [`openmeter.subscriptions.change(subscriptionId, body)`](./src/client/subscriptions.ts#L110) | Change a subscription (upgrade/downgrade)|
201
+ | | Subscriptions | Other | [`openmeter.subscriptions.migrate(subscriptionId, body)`](./src/client/subscriptions.ts#L135) | Migrate to a new plan version|
202
+ | | Subscriptions | Other | [`openmeter.subscriptions.unscheduleCancelation(subscriptionId)`](./src/client/subscriptions.ts#L158) | Unschedule a subscription cancelation|
203
+ | **[Subscription Addons](#subscription-addons)** | | | | Manage addons attached to specific subscriptions|
204
+ | | Subscription Addons | Create | [`openmeter.subscriptionAddons.create(subscriptionId, body)`](./src/client/subscription-addons.ts#L16) | Create a new subscription addon|
205
+ | | Subscription Addons | Read | [`openmeter.subscriptionAddons.get(subscriptionId, subscriptionAddonId)`](./src/client/subscription-addons.ts#L58) | Get a subscription addon by ID|
206
+ | | Subscription Addons | Read | [`openmeter.subscriptionAddons.list(subscriptionId)`](./src/client/subscription-addons.ts#L39) | List all addons of a subscription|
207
+ | | Subscription Addons | Update | [`openmeter.subscriptionAddons.update(subscriptionId, subscriptionAddonId, body)`](./src/client/subscription-addons.ts#L82) | Update a subscription addon|
208
+ | **[Billing](#billing)** | | | | Comprehensive billing management (profiles, invoices, overrides)|
209
+ | | Profiles | Create | [`openmeter.billing.profiles.create(profile)`](./src/client/billing.ts#L42) | Create a billing profile|
210
+ | | Profiles | Read | [`openmeter.billing.profiles.get(id)`](./src/client/billing.ts#L60) | Get a billing profile by ID|
211
+ | | Profiles | Read | [`openmeter.billing.profiles.list(query?)`](./src/client/billing.ts#L80) | List billing profiles|
212
+ | | Profiles | Update | [`openmeter.billing.profiles.update(id, profile)`](./src/client/billing.ts#L101) | Update a billing profile|
213
+ | | Profiles | Delete | [`openmeter.billing.profiles.delete(id)`](./src/client/billing.ts#L123) | Delete a billing profile|
214
+ | | Invoices | Read | [`openmeter.billing.invoices.list(query?)`](./src/client/billing.ts#L150) | List invoices|
215
+ | | Invoices | Read | [`openmeter.billing.invoices.get(id, query?)`](./src/client/billing.ts#L170) | Get an invoice by ID|
216
+ | | Invoices | Update | [`openmeter.billing.invoices.update(id, invoice)`](./src/client/billing.ts#L192) | Update an invoice (draft or earlier)|
217
+ | | Invoices | Delete | [`openmeter.billing.invoices.delete(id)`](./src/client/billing.ts#L213) | Delete an invoice (draft or earlier)|
218
+ | | Invoices | Other | [`openmeter.billing.invoices.advance(id)`](./src/client/billing.ts#L235) | Advance invoice to next status|
219
+ | | Invoices | Other | [`openmeter.billing.invoices.approve(id)`](./src/client/billing.ts#L257) | Approve an invoice (sends to customer)|
220
+ | | Invoices | Other | [`openmeter.billing.invoices.retry(id, body?)`](./src/client/billing.ts#L278) | Retry advancing after failure|
221
+ | | Invoices | Other | [`openmeter.billing.invoices.void(id)`](./src/client/billing.ts#L302) | Void an invoice|
222
+ | | Invoices | Other | [`openmeter.billing.invoices.recalculateTax(id)`](./src/client/billing.ts#L325) | Recalculate invoice tax amounts|
223
+ | | Invoices | Other | [`openmeter.billing.invoices.simulate(customerId, query?)`](./src/client/billing.ts#L346) | Simulate an invoice for a customer|
224
+ | | Invoices | Create | [`openmeter.billing.invoices.createLineItems(customerId, body)`](./src/client/billing.ts#L377) | Create pending line items|
225
+ | | Invoices | Create | [`openmeter.billing.invoices.invoicePendingLines(customerId)`](./src/client/billing.ts#L401) | Invoice pending lines|
226
+ | | Customers | Create | [`openmeter.billing.customers.createOverride(customerId, body)`](./src/client/billing.ts#L427) | Create or update a customer override|
227
+ | | Customers | Read | [`openmeter.billing.customers.getOverride(customerId, id)`](./src/client/billing.ts#L450) | Get a customer override|
228
+ | | Customers | Read | [`openmeter.billing.customers.listOverrides(customerId)`](./src/client/billing.ts#L471) | List customer overrides|
229
+ | | Customers | Delete | [`openmeter.billing.customers.deleteOverride(customerId, id)`](./src/client/billing.ts#L489) | Delete a customer override|
230
+ | **[Apps](#apps)** | | | | Manage integrations and app marketplace|
231
+ | | Apps | Read | [`openmeter.apps.list(query?)`](./src/client/apps.ts#L32) | List installed apps|
232
+ | | Apps | Read | [`openmeter.apps.get(id)`](./src/client/apps.ts#L50) | Get an app by ID|
233
+ | | Apps | Update | [`openmeter.apps.update(id, body)`](./src/client/apps.ts#L69) | Update an app|
234
+ | | Apps | Delete | [`openmeter.apps.uninstall(id)`](./src/client/apps.ts#L89) | Uninstall an app|
235
+ | | Marketplace | Read | [`openmeter.apps.marketplace.list(query?)`](./src/client/apps.ts#L115) | List available marketplace apps|
236
+ | | Marketplace | Read | [`openmeter.apps.marketplace.get(id)`](./src/client/apps.ts#L133) | Get marketplace listing details|
237
+ | | Marketplace | Read | [`openmeter.apps.marketplace.getOauth2InstallUrl(id, redirectUrl)`](./src/client/apps.ts#L151) | Get OAuth2 install URL|
238
+ | | Marketplace | Other | [`openmeter.apps.marketplace.authorizeOauth2(id, body)`](./src/client/apps.ts#L172) | Authorize OAuth2 code|
239
+ | | Marketplace | Create | [`openmeter.apps.marketplace.installWithAPIKey(id, body)`](./src/client/apps.ts#L193) | Install app with API key|
240
+ | | Stripe | Create | [`openmeter.apps.stripe.createCheckoutSession(body)`](./src/client/apps.ts#L223) | Create a Stripe checkout session|
241
+ | | Stripe | Update | [`openmeter.apps.stripe.updateApiKey(body)`](./src/client/apps.ts#L243) | Update Stripe API key|
242
+ | | Custom Invoicing | Other | [`openmeter.apps.customInvoicing.draftSynchronized(body)`](./src/client/apps.ts#L271) | Submit draft synchronization results|
243
+ | | Custom Invoicing | Other | [`openmeter.apps.customInvoicing.issuingSynchronized(body)`](./src/client/apps.ts#L295) | Submit issuing synchronization results|
244
+ | | Custom Invoicing | Update | [`openmeter.apps.customInvoicing.updatePaymentStatus(invoiceId, body)`](./src/client/apps.ts#L319) | Update payment status|
245
+ | **[Notifications](#notifications)** | | | | Set up automated notifications for usage thresholds|
246
+ | | Channels | Create | [`openmeter.notifications.channels.create(channel)`](./src/client/notifications.ts#L40) | Create a notification channel|
247
+ | | Channels | Read | [`openmeter.notifications.channels.get(channelId)`](./src/client/notifications.ts#L58) | Get a notification channel by ID|
248
+ | | Channels | Update | [`openmeter.notifications.channels.update(channelId, channel)`](./src/client/notifications.ts#L84) | Update a notification channel|
249
+ | | Channels | Read | [`openmeter.notifications.channels.list(query?)`](./src/client/notifications.ts#L111) | List notification channels|
250
+ | | Channels | Delete | [`openmeter.notifications.channels.delete(channelId)`](./src/client/notifications.ts#L131) | Delete a notification channel|
251
+ | | Rules | Create | [`openmeter.notifications.rules.create(rule)`](./src/client/notifications.ts#L164) | Create a notification rule|
252
+ | | Rules | Read | [`openmeter.notifications.rules.get(ruleId)`](./src/client/notifications.ts#L182) | Get a notification rule by ID|
253
+ | | Rules | Update | [`openmeter.notifications.rules.update(ruleId, rule)`](./src/client/notifications.ts#L205) | Update a notification rule|
254
+ | | Rules | Read | [`openmeter.notifications.rules.list(query?)`](./src/client/notifications.ts#L229) | List notification rules|
255
+ | | Rules | Delete | [`openmeter.notifications.rules.delete(ruleId)`](./src/client/notifications.ts#L249) | Delete a notification rule|
256
+ | | Events | Read | [`openmeter.notifications.events.get(eventId)`](./src/client/notifications.ts#L282) | Get a notification event by ID|
257
+ | | Events | Read | [`openmeter.notifications.events.list(query?)`](./src/client/notifications.ts#L307) | List notification events|
258
+ | **[Portal](#portal)** | | | | Manage consumer portal tokens for customer-facing interfaces|
259
+ | | Portal | Create | [`openmeter.portal.create(body)`](./src/client/portal.ts#L19) | Create a consumer portal token|
260
+ | | Portal | Read | [`openmeter.portal.list(query?)`](./src/client/portal.ts#L34) | List consumer portal tokens|
261
+ | | Portal | Other | [`openmeter.portal.invalidate(query?)`](./src/client/portal.ts#L52) | Invalidate consumer portal tokens|
262
+ | **[Info](#info)** | | | | Utility endpoints for system information|
263
+ | | Info | Read | [`openmeter.info.listCurrencies()`](./src/client/info.ts#L18) | List all supported currencies|
264
+ | | Info | Read | [`openmeter.info.getProgress(id)`](./src/client/info.ts#L32) | Get progress of a long-running operation|
265
+ | **[Debug](#debug)** | | | | Debug utilities for monitoring and troubleshooting|
266
+ | | Debug | Read | [`openmeter.debug.getMetrics()`](./src/client/debug.ts#L18) | Get event ingestion metrics (OpenMetrics format)|
267
+
package/dist/cjs/src/client/features.d.cts CHANGED
@@ -26,6 +26,9 @@ export declare class Features {
26
26
  meterGroupByFilters?: {
27
27
  [key: string]: string;
28
28
  };
29
+ advancedMeterGroupByFilters?: {
30
+ [key: string]: import("./schemas.cjs").components["schemas"]["FilterString"];
31
+ };
29
32
  readonly id: string;
30
33
  } | undefined>;
31
34
  /**
@@ -46,6 +49,9 @@ export declare class Features {
46
49
  meterGroupByFilters?: {
47
50
  [key: string]: string;
48
51
  };
52
+ advancedMeterGroupByFilters?: {
53
+ [key: string]: import("./schemas.cjs").components["schemas"]["FilterString"];
54
+ };
49
55
  readonly id: string;
50
56
  } | undefined>;
51
57
  /**
@@ -66,6 +72,9 @@ export declare class Features {
66
72
  meterGroupByFilters?: {
67
73
  [key: string]: string;
68
74
  };
75
+ advancedMeterGroupByFilters?: {
76
+ [key: string]: import("./schemas.cjs").components["schemas"]["FilterString"];
77
+ };
69
78
  readonly id: string;
70
79
  }[]>;
71
80
  /**
package/dist/cjs/src/client/notifications.d.cts CHANGED
@@ -33,6 +33,8 @@ export declare class NotificationChannels {
33
33
  type: "WEBHOOK";
34
34
  name: string;
35
35
  disabled?: boolean;
36
+ readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
37
+ metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
36
38
  url: string;
37
39
  customHeaders?: {
38
40
  [key: string]: string;
@@ -53,6 +55,8 @@ export declare class NotificationChannels {
53
55
  type: "WEBHOOK";
54
56
  name: string;
55
57
  disabled?: boolean;
58
+ readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
59
+ metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
56
60
  url: string;
57
61
  customHeaders?: {
58
62
  [key: string]: string;
@@ -74,6 +78,8 @@ export declare class NotificationChannels {
74
78
  type: "WEBHOOK";
75
79
  name: string;
76
80
  disabled?: boolean;
81
+ readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
82
+ metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
77
83
  url: string;
78
84
  customHeaders?: {
79
85
  [key: string]: string;