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

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,15 @@ export class Client {
                 beforeRequest: [
                     ...(options.hooks?.beforeRequest ?? []),
                     async ({ request }) => {
+                        // User-Agent is settable on the web but is not CORS-safelisted, so
+                        // setting it would preflight otherwise-simple cross-origin requests.
+                        // Gate on a positive Node check, not `window`: workers are also
+                        // CORS-bound yet have no `window`.
+                        if (typeof process !== 'undefined' &&
+                            process.versions?.node != null &&
+                            !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 +46,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,10 +1,21 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
 import { toURLSearchParams, encodeSort } from '../lib/encodings.js';
-import { toWire, fromWire, assertValid, toSnakeCase } from '../lib/wire.js';
+import { toWire, toPathWire, 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) {
     return request(() => {
+        if (client._options.validate && req.sort !== undefined) {
+            assertValid(schemas.listAddonsQueryParams.shape.sort, req.sort);
+        }
         const query = toWire({
             page: req.page,
             sort: encodeSort(req.sort, toSnakeCase),
@@ -25,6 +36,13 @@ export function listAddons(client, req = {}, options) {
         });
     });
 }
+/**
+ * Create add-on
+ *
+ * Create a new add-on.
+ *
+ * POST /openmeter/addons
+ */
 export function createAddon(client, req, options) {
     return request(() => {
         const body = toWire(req, schemas.createAddonBody);
@@ -42,13 +60,29 @@ export function createAddon(client, req, options) {
         });
     });
 }
+/**
+ * Update add-on
+ *
+ * Update an add-on by id.
+ *
+ * PUT /openmeter/addons/{addonId}
+ */
 export function updateAddon(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            addonId: req.addonId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.updateAddonPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.updateAddonPathParamsWire, pathParams);
+        }
         const path = `openmeter/addons/${(() => {
-            if (req.addonId === undefined) {
+            if (pathParams.addonId === undefined) {
                 throw new Error('missing path parameter: addonId');
             }
-            return encodeURIComponent(String(req.addonId));
+            return encodeURIComponent(String(pathParams.addonId));
         })()}`;
         const body = toWire(req.body, schemas.updateAddonBody);
         if (client._options.validate) {
@@ -65,13 +99,29 @@ export function updateAddon(client, req, options) {
         });
     });
 }
+/**
+ * Get add-on
+ *
+ * Get add-on by id.
+ *
+ * GET /openmeter/addons/{addonId}
+ */
 export function getAddon(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            addonId: req.addonId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getAddonPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getAddonPathParamsWire, pathParams);
+        }
         const path = `openmeter/addons/${(() => {
-            if (req.addonId === undefined) {
+            if (pathParams.addonId === undefined) {
                 throw new Error('missing path parameter: addonId');
             }
-            return encodeURIComponent(String(req.addonId));
+            return encodeURIComponent(String(pathParams.addonId));
         })()}`;
         return http(client)
             .get(path, options)
@@ -84,24 +134,56 @@ export function getAddon(client, req, options) {
         });
     });
 }
+/**
+ * Soft delete add-on
+ *
+ * Soft delete add-on by id.
+ *
+ * DELETE /openmeter/addons/{addonId}
+ */
 export function deleteAddon(client, req, options) {
     return request(async () => {
+        const pathParamsInput = {
+            addonId: req.addonId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.deleteAddonPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.deleteAddonPathParamsWire, pathParams);
+        }
         const path = `openmeter/addons/${(() => {
-            if (req.addonId === undefined) {
+            if (pathParams.addonId === undefined) {
                 throw new Error('missing path parameter: addonId');
             }
-            return encodeURIComponent(String(req.addonId));
+            return encodeURIComponent(String(pathParams.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) {
     return request(() => {
+        const pathParamsInput = {
+            addonId: req.addonId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.archiveAddonPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.archiveAddonPathParamsWire, pathParams);
+        }
         const path = `openmeter/addons/${(() => {
-            if (req.addonId === undefined) {
+            if (pathParams.addonId === undefined) {
                 throw new Error('missing path parameter: addonId');
             }
-            return encodeURIComponent(String(req.addonId));
+            return encodeURIComponent(String(pathParams.addonId));
         })()}/archive`;
         return http(client)
             .post(path, options)
@@ -114,13 +196,29 @@ export function archiveAddon(client, req, options) {
         });
     });
 }
+/**
+ * Publish add-on version
+ *
+ * Publish an add-on version.
+ *
+ * POST /openmeter/addons/{addonId}/publish
+ */
 export function publishAddon(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            addonId: req.addonId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.publishAddonPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.publishAddonPathParamsWire, pathParams);
+        }
         const path = `openmeter/addons/${(() => {
-            if (req.addonId === undefined) {
+            if (pathParams.addonId === undefined) {
                 throw new Error('missing path parameter: addonId');
             }
-            return encodeURIComponent(String(req.addonId));
+            return encodeURIComponent(String(pathParams.addonId));
         })()}/publish`;
         return http(client)
             .post(path, options)
@@ -133,4 +231,3 @@ export function publishAddon(client, req, options) {
         });
     });
 }
-//# sourceMappingURL=addons.js.map

package/dist/funcs/apps.d.ts

@@ -1,6 +1,59 @@
 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';
+import type { ListAppsRequest, ListAppsResponse, GetAppRequest, GetAppResponse, UninstallAppRequest, UninstallAppResponse, UpdateAppRequest, UpdateAppResponse, ListAppCatalogRequest, ListAppCatalogResponse, GetAppCatalogItemRequest, GetAppCatalogItemResponse, InstallAppRequest, InstallAppResponse } 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
+/**
+ * Uninstall app
+ *
+ * Uninstall an app by ID.
+ *
+ * DELETE /openmeter/apps/{appId}
+ */
+export declare function uninstallApp(client: Client, req: UninstallAppRequest, options?: RequestOptions): Promise<Result<UninstallAppResponse>>;
+/**
+ * Update app
+ *
+ * Update an installed app.
+ *
+ * PUT /openmeter/apps/{appId}
+ */
+export declare function updateApp(client: Client, req: UpdateAppRequest, options?: RequestOptions): Promise<Result<UpdateAppResponse>>;
+/**
+ * List app catalog
+ *
+ * List available apps.
+ *
+ * GET /openmeter/app-catalog
+ */
+export declare function listAppCatalog(client: Client, req?: ListAppCatalogRequest, options?: RequestOptions): Promise<Result<ListAppCatalogResponse>>;
+/**
+ * Get app catalog item by type
+ *
+ * Get an app catalog item by type.
+ *
+ * GET /openmeter/app-catalog/{appType}
+ */
+export declare function getAppCatalogItem(client: Client, req: GetAppCatalogItemRequest, options?: RequestOptions): Promise<Result<GetAppCatalogItemResponse>>;
+/**
+ * Install app from the catalog
+ *
+ * Install an app from the catalog.
+ *
+ * POST /openmeter/app-catalog/install
+ */
+export declare function installApp(client: Client, req: InstallAppRequest, options?: RequestOptions): Promise<Result<InstallAppResponse>>;

package/dist/funcs/apps.js

@@ -1,8 +1,16 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
 import { toURLSearchParams } from '../lib/encodings.js';
-import { toWire, fromWire, assertValid } from '../lib/wire.js';
+import { toWire, toPathWire, 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) {
     return request(() => {
         const query = toWire({
@@ -23,13 +31,29 @@ export function listApps(client, req = {}, options) {
         });
     });
 }
+/**
+ * Get app
+ *
+ * Get an installed app.
+ *
+ * GET /openmeter/apps/{appId}
+ */
 export function getApp(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            appId: req.appId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getAppPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getAppPathParamsWire, pathParams);
+        }
         const path = `openmeter/apps/${(() => {
-            if (req.appId === undefined) {
+            if (pathParams.appId === undefined) {
                 throw new Error('missing path parameter: appId');
             }
-            return encodeURIComponent(String(req.appId));
+            return encodeURIComponent(String(pathParams.appId));
         })()}`;
         return http(client)
             .get(path, options)
@@ -42,4 +66,155 @@ export function getApp(client, req, options) {
         });
     });
 }
-//# sourceMappingURL=apps.js.map
+/**
+ * Uninstall app
+ *
+ * Uninstall an app by ID.
+ *
+ * DELETE /openmeter/apps/{appId}
+ */
+export function uninstallApp(client, req, options) {
+    return request(async () => {
+        const pathParamsInput = {
+            appId: req.appId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.uninstallAppPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.uninstallAppPathParamsWire, pathParams);
+        }
+        const path = `openmeter/apps/${(() => {
+            if (pathParams.appId === undefined) {
+                throw new Error('missing path parameter: appId');
+            }
+            return encodeURIComponent(String(pathParams.appId));
+        })()}`;
+        await http(client).delete(path, options);
+    });
+}
+/**
+ * Update app
+ *
+ * Update an installed app.
+ *
+ * PUT /openmeter/apps/{appId}
+ */
+export function updateApp(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            appId: req.appId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.updateAppPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.updateAppPathParamsWire, pathParams);
+        }
+        const path = `openmeter/apps/${(() => {
+            if (pathParams.appId === undefined) {
+                throw new Error('missing path parameter: appId');
+            }
+            return encodeURIComponent(String(pathParams.appId));
+        })()}`;
+        const body = toWire(req.body, schemas.updateAppBody);
+        if (client._options.validate) {
+            assertValid(schemas.updateAppBodyWire, body);
+        }
+        return http(client)
+            .put(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.updateAppResponseWire, data);
+            }
+            return fromWire(data, schemas.updateAppResponse);
+        });
+    });
+}
+/**
+ * List app catalog
+ *
+ * List available apps.
+ *
+ * GET /openmeter/app-catalog
+ */
+export function listAppCatalog(client, req = {}, options) {
+    return request(() => {
+        const query = toWire({
+            page: req.page,
+        }, schemas.listAppCatalogQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listAppCatalogQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get('openmeter/app-catalog', { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listAppCatalogResponseWire, data);
+            }
+            return fromWire(data, schemas.listAppCatalogResponse);
+        });
+    });
+}
+/**
+ * Get app catalog item by type
+ *
+ * Get an app catalog item by type.
+ *
+ * GET /openmeter/app-catalog/{appType}
+ */
+export function getAppCatalogItem(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            appType: req.appType,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getAppCatalogItemPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getAppCatalogItemPathParamsWire, pathParams);
+        }
+        const path = `openmeter/app-catalog/${(() => {
+            if (pathParams.appType === undefined) {
+                throw new Error('missing path parameter: appType');
+            }
+            return encodeURIComponent(String(pathParams.appType));
+        })()}`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getAppCatalogItemResponseWire, data);
+            }
+            return fromWire(data, schemas.getAppCatalogItemResponse);
+        });
+    });
+}
+/**
+ * Install app from the catalog
+ *
+ * Install an app from the catalog.
+ *
+ * POST /openmeter/app-catalog/install
+ */
+export function installApp(client, req, options) {
+    return request(() => {
+        const body = toWire(req, schemas.installAppBody);
+        if (client._options.validate) {
+            assertValid(schemas.installAppBodyWire, body);
+        }
+        return http(client)
+            .post('openmeter/app-catalog/install', { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.installAppResponseWire, data);
+            }
+            return fromWire(data, schemas.installAppResponse);
+        });
+    });
+}

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