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

package/dist/funcs/entitlements.js

@@ -1,7 +1,8 @@
 // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { http } from '../core.js';
 import { request } from '../lib/request.js';
-import { toPathWire, fromWire, assertValid } from '../lib/wire.js';
+import { toURLSearchParams, encodeSort } from '../lib/encodings.js';
+import { toWire, toPathWire, fromWire, assertValid, toSnakeCase, } from '../lib/wire.js';
 import * as schemas from '../models/schemas.js';
 /**
  * List customer entitlement access
@@ -36,3 +37,214 @@ export function listCustomerEntitlementAccess(client, req, options) {
         });
     });
 }
+/**
+ * Get customer entitlement access
+ *
+ * Get the customer's access to a single feature.
+ *
+ * GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
+ */
+export function getCustomerEntitlementAccess(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            customerId: req.customerId,
+            featureKey: req.featureKey,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getCustomerEntitlementAccessPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getCustomerEntitlementAccessPathParamsWire, pathParams);
+        }
+        const path = `openmeter/customers/${(() => {
+            if (pathParams.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(pathParams.customerId));
+        })()}/entitlement-access/features/${(() => {
+            if (pathParams.featureKey === undefined) {
+                throw new Error('missing path parameter: featureKey');
+            }
+            return encodeURIComponent(String(pathParams.featureKey));
+        })()}`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getCustomerEntitlementAccessResponseWire, data);
+            }
+            return fromWire(data, schemas.getCustomerEntitlementAccessResponse);
+        });
+    });
+}
+/**
+ * Get customer entitlement value by feature key
+ *
+ * Get the customer's entitlement value for a feature at a point in time. Without
+ * an active entitlement, the result denies access and omits the type.
+ *
+ * GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}/value
+ */
+export function getCustomerEntitlementValueByFeatureKey(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            customerId: req.customerId,
+            featureKey: req.featureKey,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getCustomerEntitlementValueByFeatureKeyPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getCustomerEntitlementValueByFeatureKeyPathParamsWire, pathParams);
+        }
+        const path = `openmeter/customers/${(() => {
+            if (pathParams.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(pathParams.customerId));
+        })()}/entitlement-access/features/${(() => {
+            if (pathParams.featureKey === undefined) {
+                throw new Error('missing path parameter: featureKey');
+            }
+            return encodeURIComponent(String(pathParams.featureKey));
+        })()}/value`;
+        const query = toWire({
+            expand: req.expand,
+            at: req.at,
+        }, schemas.getCustomerEntitlementValueByFeatureKeyQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.getCustomerEntitlementValueByFeatureKeyQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get(path, { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getCustomerEntitlementValueByFeatureKeyResponseWire, data);
+            }
+            return fromWire(data, schemas.getCustomerEntitlementValueByFeatureKeyResponse);
+        });
+    });
+}
+/**
+ * List entitlements
+ *
+ * List the active entitlements of all customers. Intended for administrative use.
+ * To list the entitlements of a single customer, use the customer entitlements
+ * endpoints; to check entitlement access, use the entitlement access endpoints.
+ *
+ * GET /openmeter/entitlements
+ */
+export function listEntitlements(client, req = {}, options) {
+    return request(() => {
+        if (client._options.validate && req.sort !== undefined) {
+            assertValid(schemas.listEntitlementsQueryParams.shape.sort, req.sort);
+        }
+        const query = toWire({
+            page: req.page,
+            sort: encodeSort(req.sort, toSnakeCase),
+            filter: req.filter,
+        }, schemas.listEntitlementsQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listEntitlementsQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get('openmeter/entitlements', { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listEntitlementsResponseWire, data);
+            }
+            return fromWire(data, schemas.listEntitlementsResponse);
+        });
+    });
+}
+/**
+ * Get entitlement
+ *
+ * Get an entitlement by ID. To check entitlement access, use the entitlement
+ * access endpoints instead.
+ *
+ * GET /openmeter/entitlements/{entitlementId}
+ */
+export function getEntitlement(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            entitlementId: req.entitlementId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getEntitlementPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getEntitlementPathParamsWire, pathParams);
+        }
+        const path = `openmeter/entitlements/${(() => {
+            if (pathParams.entitlementId === undefined) {
+                throw new Error('missing path parameter: entitlementId');
+            }
+            return encodeURIComponent(String(pathParams.entitlementId));
+        })()}`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getEntitlementResponseWire, data);
+            }
+            return fromWire(data, schemas.getEntitlementResponse);
+        });
+    });
+}
+/**
+ * Get customer entitlement value
+ *
+ * Get the customer's access through a single entitlement, optionally evaluated at
+ * a point in time.
+ *
+ * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/value
+ */
+export function getCustomerEntitlementValue(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            customerId: req.customerId,
+            entitlementId: req.entitlementId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getCustomerEntitlementValuePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getCustomerEntitlementValuePathParamsWire, pathParams);
+        }
+        const path = `openmeter/customers/${(() => {
+            if (pathParams.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(pathParams.customerId));
+        })()}/entitlements/${(() => {
+            if (pathParams.entitlementId === undefined) {
+                throw new Error('missing path parameter: entitlementId');
+            }
+            return encodeURIComponent(String(pathParams.entitlementId));
+        })()}/value`;
+        const query = toWire({
+            expand: req.expand,
+            at: req.at,
+        }, schemas.getCustomerEntitlementValueQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.getCustomerEntitlementValueQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get(path, { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getCustomerEntitlementValueResponseWire, data);
+            }
+            return fromWire(data, schemas.getCustomerEntitlementValueResponse);
+        });
+    });
+}

package/dist/funcs/grants.d.ts

@@ -0,0 +1,24 @@
+import { type Client } from '../core.js';
+import { type Result, type RequestOptions } from '../lib/types.js';
+import type { ListGrantsRequest, ListGrantsResponse, VoidGrantRequest, VoidGrantResponse } from '../models/operations/grants.js';
+/**
+ * List grants
+ *
+ * List the grants of all customers and entitlements. To list the grants of a
+ * single entitlement, use the customer entitlement grants endpoint.
+ *
+ * Deleted grants are excluded unless `include_deleted` is set. Voided and expired
+ * grants are always included, as they are part of the balance history.
+ *
+ * GET /openmeter/grants
+ */
+export declare function listGrants(client: Client, req?: ListGrantsRequest, options?: RequestOptions): Promise<Result<ListGrantsResponse>>;
+/**
+ * Void grant
+ *
+ * Void a grant so it no longer adds to the balance. Usage already deducted from
+ * the grant is kept.
+ *
+ * DELETE /openmeter/grants/{grantId}
+ */
+export declare function voidGrant(client: Client, req: VoidGrantRequest, options?: RequestOptions): Promise<Result<VoidGrantResponse>>;

package/dist/funcs/grants.js

@@ -0,0 +1,78 @@
+// 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, toPathWire, fromWire, assertValid, toSnakeCase, } from '../lib/wire.js';
+import * as schemas from '../models/schemas.js';
+/**
+ * List grants
+ *
+ * List the grants of all customers and entitlements. To list the grants of a
+ * single entitlement, use the customer entitlement grants endpoint.
+ *
+ * Deleted grants are excluded unless `include_deleted` is set. Voided and expired
+ * grants are always included, as they are part of the balance history.
+ *
+ * GET /openmeter/grants
+ */
+export function listGrants(client, req = {}, options) {
+    return request(() => {
+        if (client._options.validate && req.sort !== undefined) {
+            assertValid(schemas.listGrantsQueryParams.shape.sort, req.sort);
+        }
+        const query = toWire({
+            page: req.page,
+            sort: encodeSort(req.sort, toSnakeCase),
+            filter: req.filter,
+            includeDeleted: req.includeDeleted,
+        }, schemas.listGrantsQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listGrantsQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get('openmeter/grants', { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listGrantsResponseWire, data);
+            }
+            return fromWire(data, schemas.listGrantsResponse);
+        });
+    });
+}
+/**
+ * Void grant
+ *
+ * Void a grant so it no longer adds to the balance. Usage already deducted from
+ * the grant is kept.
+ *
+ * DELETE /openmeter/grants/{grantId}
+ */
+export function voidGrant(client, req, options) {
+    return request(async () => {
+        const pathParamsInput = {
+            grantId: req.grantId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.voidGrantPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.voidGrantPathParamsWire, pathParams);
+        }
+        const path = `openmeter/grants/${(() => {
+            if (pathParams.grantId === undefined) {
+                throw new Error('missing path parameter: grantId');
+            }
+            return encodeURIComponent(String(pathParams.grantId));
+        })()}`;
+        const query = toWire({
+            voidedAt: req.voidedAt,
+        }, schemas.voidGrantQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.voidGrantQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        await http(client).delete(path, { ...options, searchParams });
+    });
+}

package/dist/funcs/index.d.ts

@@ -2,10 +2,12 @@ export * from './events.js';
 export * from './meters.js';
 export * from './customers.js';
 export * from './entitlements.js';
+export * from './grants.js';
 export * from './subscriptions.js';
 export * from './apps.js';
 export * from './billing.js';
 export * from './invoices.js';
+export * from './charges.js';
 export * from './tax.js';
 export * from './currencies.js';
 export * from './features.js';
@@ -14,4 +16,5 @@ export * from './plans.js';
 export * from './addons.js';
 export * from './planAddons.js';
 export * from './defaults.js';
-export * from './governance.js';
+export * from './entitlementAccess.js';
+export * from './notifications.js';

package/dist/funcs/index.js

@@ -3,10 +3,12 @@ export * from './events.js';
 export * from './meters.js';
 export * from './customers.js';
 export * from './entitlements.js';
+export * from './grants.js';
 export * from './subscriptions.js';
 export * from './apps.js';
 export * from './billing.js';
 export * from './invoices.js';
+export * from './charges.js';
 export * from './tax.js';
 export * from './currencies.js';
 export * from './features.js';
@@ -15,4 +17,5 @@ export * from './plans.js';
 export * from './addons.js';
 export * from './planAddons.js';
 export * from './defaults.js';
-export * from './governance.js';
+export * from './entitlementAccess.js';
+export * from './notifications.js';

package/dist/funcs/notifications.d.ts

@@ -0,0 +1,43 @@
+import { type Client } from '../core.js';
+import { type Result, type RequestOptions } from '../lib/types.js';
+import type { ListNotificationChannelsRequest, ListNotificationChannelsResponse, CreateNotificationChannelRequest, CreateNotificationChannelResponse, GetNotificationChannelRequest, GetNotificationChannelResponse, UpdateNotificationChannelRequest, UpdateNotificationChannelResponse, DeleteNotificationChannelRequest, DeleteNotificationChannelResponse } from '../models/operations/notifications.js';
+/**
+ * List notification channels
+ *
+ * List all notification channels.
+ *
+ * GET /openmeter/notification/channels
+ */
+export declare function listNotificationChannels(client: Client, req?: ListNotificationChannelsRequest, options?: RequestOptions): Promise<Result<ListNotificationChannelsResponse>>;
+/**
+ * Create notification channel
+ *
+ * Create a notification channel.
+ *
+ * POST /openmeter/notification/channels
+ */
+export declare function createNotificationChannel(client: Client, req: CreateNotificationChannelRequest, options?: RequestOptions): Promise<Result<CreateNotificationChannelResponse>>;
+/**
+ * Get notification channel
+ *
+ * Get a notification channel by id.
+ *
+ * GET /openmeter/notification/channels/{notificationChannelId}
+ */
+export declare function getNotificationChannel(client: Client, req: GetNotificationChannelRequest, options?: RequestOptions): Promise<Result<GetNotificationChannelResponse>>;
+/**
+ * Update notification channel
+ *
+ * Update a notification channel by id.
+ *
+ * PUT /openmeter/notification/channels/{notificationChannelId}
+ */
+export declare function updateNotificationChannel(client: Client, req: UpdateNotificationChannelRequest, options?: RequestOptions): Promise<Result<UpdateNotificationChannelResponse>>;
+/**
+ * Delete notification channel
+ *
+ * Delete a notification channel by id.
+ *
+ * DELETE /openmeter/notification/channels/{notificationChannelId}
+ */
+export declare function deleteNotificationChannel(client: Client, req: DeleteNotificationChannelRequest, options?: RequestOptions): Promise<Result<DeleteNotificationChannelResponse>>;

package/dist/funcs/notifications.js

@@ -0,0 +1,163 @@
+// 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, toPathWire, fromWire, assertValid, toSnakeCase, } from '../lib/wire.js';
+import * as schemas from '../models/schemas.js';
+/**
+ * List notification channels
+ *
+ * List all notification channels.
+ *
+ * GET /openmeter/notification/channels
+ */
+export function listNotificationChannels(client, req = {}, options) {
+    return request(() => {
+        if (client._options.validate && req.sort !== undefined) {
+            assertValid(schemas.listNotificationChannelsQueryParams.shape.sort, req.sort);
+        }
+        const query = toWire({
+            page: req.page,
+            sort: encodeSort(req.sort, toSnakeCase),
+            filter: req.filter,
+        }, schemas.listNotificationChannelsQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listNotificationChannelsQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get('openmeter/notification/channels', { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listNotificationChannelsResponseWire, data);
+            }
+            return fromWire(data, schemas.listNotificationChannelsResponse);
+        });
+    });
+}
+/**
+ * Create notification channel
+ *
+ * Create a notification channel.
+ *
+ * POST /openmeter/notification/channels
+ */
+export function createNotificationChannel(client, req, options) {
+    return request(() => {
+        const body = toWire(req, schemas.createNotificationChannelBody);
+        if (client._options.validate) {
+            assertValid(schemas.createNotificationChannelBodyWire, body);
+        }
+        return http(client)
+            .post('openmeter/notification/channels', { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.createNotificationChannelResponseWire, data);
+            }
+            return fromWire(data, schemas.createNotificationChannelResponse);
+        });
+    });
+}
+/**
+ * Get notification channel
+ *
+ * Get a notification channel by id.
+ *
+ * GET /openmeter/notification/channels/{notificationChannelId}
+ */
+export function getNotificationChannel(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            notificationChannelId: req.notificationChannelId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getNotificationChannelPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getNotificationChannelPathParamsWire, pathParams);
+        }
+        const path = `openmeter/notification/channels/${(() => {
+            if (pathParams.notificationChannelId === undefined) {
+                throw new Error('missing path parameter: notificationChannelId');
+            }
+            return encodeURIComponent(String(pathParams.notificationChannelId));
+        })()}`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getNotificationChannelResponseWire, data);
+            }
+            return fromWire(data, schemas.getNotificationChannelResponse);
+        });
+    });
+}
+/**
+ * Update notification channel
+ *
+ * Update a notification channel by id.
+ *
+ * PUT /openmeter/notification/channels/{notificationChannelId}
+ */
+export function updateNotificationChannel(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            notificationChannelId: req.notificationChannelId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.updateNotificationChannelPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.updateNotificationChannelPathParamsWire, pathParams);
+        }
+        const path = `openmeter/notification/channels/${(() => {
+            if (pathParams.notificationChannelId === undefined) {
+                throw new Error('missing path parameter: notificationChannelId');
+            }
+            return encodeURIComponent(String(pathParams.notificationChannelId));
+        })()}`;
+        const body = toWire(req.body, schemas.updateNotificationChannelBody);
+        if (client._options.validate) {
+            assertValid(schemas.updateNotificationChannelBodyWire, body);
+        }
+        return http(client)
+            .put(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.updateNotificationChannelResponseWire, data);
+            }
+            return fromWire(data, schemas.updateNotificationChannelResponse);
+        });
+    });
+}
+/**
+ * Delete notification channel
+ *
+ * Delete a notification channel by id.
+ *
+ * DELETE /openmeter/notification/channels/{notificationChannelId}
+ */
+export function deleteNotificationChannel(client, req, options) {
+    return request(async () => {
+        const pathParamsInput = {
+            notificationChannelId: req.notificationChannelId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.deleteNotificationChannelPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.deleteNotificationChannelPathParamsWire, pathParams);
+        }
+        const path = `openmeter/notification/channels/${(() => {
+            if (pathParams.notificationChannelId === undefined) {
+                throw new Error('missing path parameter: notificationChannelId');
+            }
+            return encodeURIComponent(String(pathParams.notificationChannelId));
+        })()}`;
+        await http(client).delete(path, options);
+    });
+}

package/dist/funcs/planAddons.js

@@ -1,8 +1,8 @@
 // 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, toPathWire, fromWire, assertValid } from '../lib/wire.js';
+import { toURLSearchParams, encodeSort } from '../lib/encodings.js';
+import { toWire, toPathWire, fromWire, assertValid, toSnakeCase, } from '../lib/wire.js';
 import * as schemas from '../models/schemas.js';
 /**
  * List add-ons for plan
@@ -28,8 +28,13 @@ export function listPlanAddons(client, req, options) {
             }
             return encodeURIComponent(String(pathParams.planId));
         })()}/addons`;
+        if (client._options.validate && req.sort !== undefined) {
+            assertValid(schemas.listPlanAddonsQueryParams.shape.sort, req.sort);
+        }
         const query = toWire({
             page: req.page,
+            sort: encodeSort(req.sort, toSnakeCase),
+            filter: req.filter,
         }, schemas.listPlanAddonsQueryParams);
         if (client._options.validate) {
             assertValid(schemas.listPlanAddonsQueryParamsWire, query);