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

package/dist/core.js

@@ -1,5 +1,7 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import ky from 'ky';
 import { encodePath } from './lib/encodings.js';
+import { SDK_VERSION } from './lib/version.js';
 export class Client {
     _options;
     _http;
@@ -20,6 +22,12 @@ export class Client {
                 beforeRequest: [
                     ...(options.hooks?.beforeRequest ?? []),
                     async ({ request }) => {
+                        // Browsers treat User-Agent as a forbidden header and silently drop
+                        // it; that's fine here, this is only observable server-side (e.g.
+                        // request logs) and Node/server callers get it.
+                        if (!request.headers.has('User-Agent')) {
+                            request.headers.set('User-Agent', `openmeter-node/${SDK_VERSION}`);
+                        }
                         const token = typeof options.apiKey === 'function'
                             ? await options.apiKey()
                             : options.apiKey;
@@ -35,4 +43,3 @@ export class Client {
 export function http(client) {
     return client._http;
 }
-//# sourceMappingURL=core.js.map

package/dist/funcs/addons.d.ts

@@ -1,11 +1,59 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListAddonsRequest, ListAddonsResponse, CreateAddonRequest, CreateAddonResponse, UpdateAddonRequest, UpdateAddonResponse, GetAddonRequest, GetAddonResponse, DeleteAddonRequest, DeleteAddonResponse, ArchiveAddonRequest, ArchiveAddonResponse, PublishAddonRequest, PublishAddonResponse } from '../models/operations/addons.js';
+/**
+ * List add-ons
+ *
+ * List all add-ons.
+ *
+ * GET /openmeter/addons
+ */
 export declare function listAddons(client: Client, req?: ListAddonsRequest, options?: RequestOptions): Promise<Result<ListAddonsResponse>>;
+/**
+ * Create add-on
+ *
+ * Create a new add-on.
+ *
+ * POST /openmeter/addons
+ */
 export declare function createAddon(client: Client, req: CreateAddonRequest, options?: RequestOptions): Promise<Result<CreateAddonResponse>>;
+/**
+ * Update add-on
+ *
+ * Update an add-on by id.
+ *
+ * PUT /openmeter/addons/{addonId}
+ */
 export declare function updateAddon(client: Client, req: UpdateAddonRequest, options?: RequestOptions): Promise<Result<UpdateAddonResponse>>;
+/**
+ * Get add-on
+ *
+ * Get add-on by id.
+ *
+ * GET /openmeter/addons/{addonId}
+ */
 export declare function getAddon(client: Client, req: GetAddonRequest, options?: RequestOptions): Promise<Result<GetAddonResponse>>;
+/**
+ * Soft delete add-on
+ *
+ * Soft delete add-on by id.
+ *
+ * DELETE /openmeter/addons/{addonId}
+ */
 export declare function deleteAddon(client: Client, req: DeleteAddonRequest, options?: RequestOptions): Promise<Result<DeleteAddonResponse>>;
+/**
+ * Archive add-on version
+ *
+ * Archive an add-on version.
+ *
+ * POST /openmeter/addons/{addonId}/archive
+ */
 export declare function archiveAddon(client: Client, req: ArchiveAddonRequest, options?: RequestOptions): Promise<Result<ArchiveAddonResponse>>;
+/**
+ * Publish add-on version
+ *
+ * Publish an add-on version.
+ *
+ * POST /openmeter/addons/{addonId}/publish
+ */
 export declare function publishAddon(client: Client, req: PublishAddonRequest, options?: RequestOptions): Promise<Result<PublishAddonResponse>>;
-//# sourceMappingURL=addons.d.ts.map

package/dist/funcs/addons.js

@@ -1,53 +1,185 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
-import { encodePath, toURLSearchParams, encodeSort } from '../lib/encodings.js';
+import { toURLSearchParams, encodeSort } from '../lib/encodings.js';
+import { toWire, fromWire, assertValid, toSnakeCase } from '../lib/wire.js';
+import * as schemas from '../models/schemas.js';
+/**
+ * List add-ons
+ *
+ * List all add-ons.
+ *
+ * GET /openmeter/addons
+ */
 export function listAddons(client, req = {}, options) {
-    const searchParams = toURLSearchParams({
-        page: req.page,
-        sort: encodeSort(req.sort),
-        filter: req.filter,
+    return request(() => {
+        const query = toWire({
+            page: req.page,
+            sort: encodeSort(req.sort, toSnakeCase),
+            filter: req.filter,
+        }, schemas.listAddonsQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listAddonsQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get('openmeter/addons', { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listAddonsResponseWire, data);
+            }
+            return fromWire(data, schemas.listAddonsResponse);
+        });
     });
-    return request(() => http(client)
-        .get('openmeter/addons', { ...options, searchParams })
-        .json());
 }
+/**
+ * Create add-on
+ *
+ * Create a new add-on.
+ *
+ * POST /openmeter/addons
+ */
 export function createAddon(client, req, options) {
-    return request(() => http(client)
-        .post('openmeter/addons', { ...options, json: req })
-        .json());
+    return request(() => {
+        const body = toWire(req, schemas.createAddonBody);
+        if (client._options.validate) {
+            assertValid(schemas.createAddonBodyWire, body);
+        }
+        return http(client)
+            .post('openmeter/addons', { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.createAddonResponseWire, data);
+            }
+            return fromWire(data, schemas.createAddonResponse);
+        });
+    });
 }
+/**
+ * Update add-on
+ *
+ * Update an add-on by id.
+ *
+ * PUT /openmeter/addons/{addonId}
+ */
 export function updateAddon(client, req, options) {
-    const path = encodePath('openmeter/addons/{addonId}', {
-        addonId: req.addonId,
+    return request(() => {
+        const path = `openmeter/addons/${(() => {
+            if (req.addonId === undefined) {
+                throw new Error('missing path parameter: addonId');
+            }
+            return encodeURIComponent(String(req.addonId));
+        })()}`;
+        const body = toWire(req.body, schemas.updateAddonBody);
+        if (client._options.validate) {
+            assertValid(schemas.updateAddonBodyWire, body);
+        }
+        return http(client)
+            .put(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.updateAddonResponseWire, data);
+            }
+            return fromWire(data, schemas.updateAddonResponse);
+        });
     });
-    return request(() => http(client)
-        .put(path, { ...options, json: req.body })
-        .json());
 }
+/**
+ * Get add-on
+ *
+ * Get add-on by id.
+ *
+ * GET /openmeter/addons/{addonId}
+ */
 export function getAddon(client, req, options) {
-    const path = encodePath('openmeter/addons/{addonId}', {
-        addonId: req.addonId,
+    return request(() => {
+        const path = `openmeter/addons/${(() => {
+            if (req.addonId === undefined) {
+                throw new Error('missing path parameter: addonId');
+            }
+            return encodeURIComponent(String(req.addonId));
+        })()}`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getAddonResponseWire, data);
+            }
+            return fromWire(data, schemas.getAddonResponse);
+        });
     });
-    return request(() => http(client).get(path, options).json());
 }
+/**
+ * Soft delete add-on
+ *
+ * Soft delete add-on by id.
+ *
+ * DELETE /openmeter/addons/{addonId}
+ */
 export function deleteAddon(client, req, options) {
-    const path = encodePath('openmeter/addons/{addonId}', {
-        addonId: req.addonId,
-    });
     return request(async () => {
+        const path = `openmeter/addons/${(() => {
+            if (req.addonId === undefined) {
+                throw new Error('missing path parameter: addonId');
+            }
+            return encodeURIComponent(String(req.addonId));
+        })()}`;
         await http(client).delete(path, options);
     });
 }
+/**
+ * Archive add-on version
+ *
+ * Archive an add-on version.
+ *
+ * POST /openmeter/addons/{addonId}/archive
+ */
 export function archiveAddon(client, req, options) {
-    const path = encodePath('openmeter/addons/{addonId}/archive', {
-        addonId: req.addonId,
+    return request(() => {
+        const path = `openmeter/addons/${(() => {
+            if (req.addonId === undefined) {
+                throw new Error('missing path parameter: addonId');
+            }
+            return encodeURIComponent(String(req.addonId));
+        })()}/archive`;
+        return http(client)
+            .post(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.archiveAddonResponseWire, data);
+            }
+            return fromWire(data, schemas.archiveAddonResponse);
+        });
     });
-    return request(() => http(client).post(path, options).json());
 }
+/**
+ * Publish add-on version
+ *
+ * Publish an add-on version.
+ *
+ * POST /openmeter/addons/{addonId}/publish
+ */
 export function publishAddon(client, req, options) {
-    const path = encodePath('openmeter/addons/{addonId}/publish', {
-        addonId: req.addonId,
+    return request(() => {
+        const path = `openmeter/addons/${(() => {
+            if (req.addonId === undefined) {
+                throw new Error('missing path parameter: addonId');
+            }
+            return encodeURIComponent(String(req.addonId));
+        })()}/publish`;
+        return http(client)
+            .post(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.publishAddonResponseWire, data);
+            }
+            return fromWire(data, schemas.publishAddonResponse);
+        });
     });
-    return request(() => http(client).post(path, options).json());
 }
-//# sourceMappingURL=addons.js.map

package/dist/funcs/apps.d.ts

@@ -1,6 +1,19 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListAppsRequest, ListAppsResponse, GetAppRequest, GetAppResponse } from '../models/operations/apps.js';
+/**
+ * List apps
+ *
+ * List installed apps.
+ *
+ * GET /openmeter/apps
+ */
 export declare function listApps(client: Client, req?: ListAppsRequest, options?: RequestOptions): Promise<Result<ListAppsResponse>>;
+/**
+ * Get app
+ *
+ * Get an installed app.
+ *
+ * GET /openmeter/apps/{appId}
+ */
 export declare function getApp(client: Client, req: GetAppRequest, options?: RequestOptions): Promise<Result<GetAppResponse>>;
-//# sourceMappingURL=apps.d.ts.map

package/dist/funcs/apps.js

@@ -1,16 +1,59 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
-import { encodePath, toURLSearchParams } from '../lib/encodings.js';
+import { toURLSearchParams } from '../lib/encodings.js';
+import { toWire, fromWire, assertValid } from '../lib/wire.js';
+import * as schemas from '../models/schemas.js';
+/**
+ * List apps
+ *
+ * List installed apps.
+ *
+ * GET /openmeter/apps
+ */
 export function listApps(client, req = {}, options) {
-    const searchParams = toURLSearchParams({
-        page: req.page,
+    return request(() => {
+        const query = toWire({
+            page: req.page,
+        }, schemas.listAppsQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listAppsQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get('openmeter/apps', { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listAppsResponseWire, data);
+            }
+            return fromWire(data, schemas.listAppsResponse);
+        });
     });
-    return request(() => http(client)
-        .get('openmeter/apps', { ...options, searchParams })
-        .json());
 }
+/**
+ * Get app
+ *
+ * Get an installed app.
+ *
+ * GET /openmeter/apps/{appId}
+ */
 export function getApp(client, req, options) {
-    const path = encodePath('openmeter/apps/{appId}', { appId: req.appId });
-    return request(() => http(client).get(path, options).json());
+    return request(() => {
+        const path = `openmeter/apps/${(() => {
+            if (req.appId === undefined) {
+                throw new Error('missing path parameter: appId');
+            }
+            return encodeURIComponent(String(req.appId));
+        })()}`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getAppResponseWire, data);
+            }
+            return fromWire(data, schemas.getAppResponse);
+        });
+    });
 }
-//# sourceMappingURL=apps.js.map

package/dist/funcs/billing.d.ts

@@ -1,9 +1,54 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListBillingProfilesRequest, ListBillingProfilesResponse, CreateBillingProfileRequest, CreateBillingProfileResponse, GetBillingProfileRequest, GetBillingProfileResponse, UpdateBillingProfileRequest, UpdateBillingProfileResponse, DeleteBillingProfileRequest, DeleteBillingProfileResponse } from '../models/operations/billing.js';
+/**
+ * List billing profiles
+ *
+ * List billing profiles.
+ *
+ * GET /openmeter/profiles
+ */
 export declare function listBillingProfiles(client: Client, req?: ListBillingProfilesRequest, options?: RequestOptions): Promise<Result<ListBillingProfilesResponse>>;
+/**
+ * Create a new billing profile
+ *
+ * Create a new billing profile.
+ *
+ * Billing profiles contain the settings for billing and controls invoice
+ * generation. An organization can have multiple billing profiles defined. A
+ * billing profile is linked to a specific app. This association is established
+ * during the billing profile's creation and remains immutable.
+ *
+ * POST /openmeter/profiles
+ */
 export declare function createBillingProfile(client: Client, req: CreateBillingProfileRequest, options?: RequestOptions): Promise<Result<CreateBillingProfileResponse>>;
+/**
+ * Get a billing profile
+ *
+ * Get a billing profile.
+ *
+ * GET /openmeter/profiles/{id}
+ */
 export declare function getBillingProfile(client: Client, req: GetBillingProfileRequest, options?: RequestOptions): Promise<Result<GetBillingProfileResponse>>;
+/**
+ * Update a billing profile
+ *
+ * Update a billing profile.
+ *
+ * PUT /openmeter/profiles/{id}
+ */
 export declare function updateBillingProfile(client: Client, req: UpdateBillingProfileRequest, options?: RequestOptions): Promise<Result<UpdateBillingProfileResponse>>;
+/**
+ * Delete a billing profile
+ *
+ * Delete a billing profile.
+ *
+ * Only such billing profiles can be deleted that are:
+ *
+ * - not the default profile
+ * - not pinned to any customer using customer overrides
+ * - only have finalized invoices
+ *
+ * DELETE /openmeter/profiles/{id}
+ */
 export declare function deleteBillingProfile(client: Client, req: DeleteBillingProfileRequest, options?: RequestOptions): Promise<Result<DeleteBillingProfileResponse>>;
-//# sourceMappingURL=billing.d.ts.map

package/dist/funcs/billing.js

@@ -1,33 +1,142 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
-import { encodePath, toURLSearchParams } from '../lib/encodings.js';
+import { toURLSearchParams } from '../lib/encodings.js';
+import { toWire, fromWire, assertValid } from '../lib/wire.js';
+import * as schemas from '../models/schemas.js';
+/**
+ * List billing profiles
+ *
+ * List billing profiles.
+ *
+ * GET /openmeter/profiles
+ */
 export function listBillingProfiles(client, req = {}, options) {
-    const searchParams = toURLSearchParams({
-        page: req.page,
+    return request(() => {
+        const query = toWire({
+            page: req.page,
+        }, schemas.listBillingProfilesQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listBillingProfilesQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get('openmeter/profiles', { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listBillingProfilesResponseWire, data);
+            }
+            return fromWire(data, schemas.listBillingProfilesResponse);
+        });
     });
-    return request(() => http(client)
-        .get('openmeter/profiles', { ...options, searchParams })
-        .json());
 }
+/**
+ * Create a new billing profile
+ *
+ * Create a new billing profile.
+ *
+ * Billing profiles contain the settings for billing and controls invoice
+ * generation. An organization can have multiple billing profiles defined. A
+ * billing profile is linked to a specific app. This association is established
+ * during the billing profile's creation and remains immutable.
+ *
+ * POST /openmeter/profiles
+ */
 export function createBillingProfile(client, req, options) {
-    return request(() => http(client)
-        .post('openmeter/profiles', { ...options, json: req })
-        .json());
+    return request(() => {
+        const body = toWire(req, schemas.createBillingProfileBody);
+        if (client._options.validate) {
+            assertValid(schemas.createBillingProfileBodyWire, body);
+        }
+        return http(client)
+            .post('openmeter/profiles', { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.createBillingProfileResponseWire, data);
+            }
+            return fromWire(data, schemas.createBillingProfileResponse);
+        });
+    });
 }
+/**
+ * Get a billing profile
+ *
+ * Get a billing profile.
+ *
+ * GET /openmeter/profiles/{id}
+ */
 export function getBillingProfile(client, req, options) {
-    const path = encodePath('openmeter/profiles/{id}', { id: req.id });
-    return request(() => http(client).get(path, options).json());
+    return request(() => {
+        const path = `openmeter/profiles/${(() => {
+            if (req.id === undefined) {
+                throw new Error('missing path parameter: id');
+            }
+            return encodeURIComponent(String(req.id));
+        })()}`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getBillingProfileResponseWire, data);
+            }
+            return fromWire(data, schemas.getBillingProfileResponse);
+        });
+    });
 }
+/**
+ * Update a billing profile
+ *
+ * Update a billing profile.
+ *
+ * PUT /openmeter/profiles/{id}
+ */
 export function updateBillingProfile(client, req, options) {
-    const path = encodePath('openmeter/profiles/{id}', { id: req.id });
-    return request(() => http(client)
-        .put(path, { ...options, json: req.body })
-        .json());
+    return request(() => {
+        const path = `openmeter/profiles/${(() => {
+            if (req.id === undefined) {
+                throw new Error('missing path parameter: id');
+            }
+            return encodeURIComponent(String(req.id));
+        })()}`;
+        const body = toWire(req.body, schemas.updateBillingProfileBody);
+        if (client._options.validate) {
+            assertValid(schemas.updateBillingProfileBodyWire, body);
+        }
+        return http(client)
+            .put(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.updateBillingProfileResponseWire, data);
+            }
+            return fromWire(data, schemas.updateBillingProfileResponse);
+        });
+    });
 }
+/**
+ * Delete a billing profile
+ *
+ * Delete a billing profile.
+ *
+ * Only such billing profiles can be deleted that are:
+ *
+ * - not the default profile
+ * - not pinned to any customer using customer overrides
+ * - only have finalized invoices
+ *
+ * DELETE /openmeter/profiles/{id}
+ */
 export function deleteBillingProfile(client, req, options) {
-    const path = encodePath('openmeter/profiles/{id}', { id: req.id });
     return request(async () => {
+        const path = `openmeter/profiles/${(() => {
+            if (req.id === undefined) {
+                throw new Error('missing path parameter: id');
+            }
+            return encodeURIComponent(String(req.id));
+        })()}`;
         await http(client).delete(path, options);
     });
 }
-//# sourceMappingURL=billing.js.map

package/dist/funcs/currencies.d.ts

@@ -1,8 +1,37 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListCurrenciesRequest, ListCurrenciesResponse, CreateCustomCurrencyRequest, CreateCustomCurrencyResponse, ListCostBasesRequest, ListCostBasesResponse, CreateCostBasisRequest, CreateCostBasisResponse } from '../models/operations/currencies.js';
+/**
+ * List currencies
+ *
+ * List currencies supported by the billing system.
+ *
+ * GET /openmeter/currencies
+ */
 export declare function listCurrencies(client: Client, req?: ListCurrenciesRequest, options?: RequestOptions): Promise<Result<ListCurrenciesResponse>>;
+/**
+ * Create custom currency
+ *
+ * Create a custom currency. This operation allows defining your own custom
+ * currency for billing purposes.
+ *
+ * POST /openmeter/currencies/custom
+ */
 export declare function createCustomCurrency(client: Client, req: CreateCustomCurrencyRequest, options?: RequestOptions): Promise<Result<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
+ */
 export declare function listCostBases(client: Client, req: ListCostBasesRequest, options?: RequestOptions): Promise<Result<ListCostBasesResponse>>;
+/**
+ * Create cost basis
+ *
+ * Create a cost basis for a currency.
+ *
+ * POST /openmeter/currencies/custom/{currencyId}/cost-bases
+ */
 export declare function createCostBasis(client: Client, req: CreateCostBasisRequest, options?: RequestOptions): Promise<Result<CreateCostBasisResponse>>;
-//# sourceMappingURL=currencies.d.ts.map