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

package/dist/funcs/billing.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 billing profiles
+ *
+ * List billing profiles.
+ *
+ * GET /openmeter/profiles
+ */
 export function listBillingProfiles(client, req = {}, options) {
     return request(() => {
         const query = toWire({
@@ -23,6 +31,18 @@ export function listBillingProfiles(client, req = {}, options) {
         });
     });
 }
+/**
+ * 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(() => {
         const body = toWire(req, schemas.createBillingProfileBody);
@@ -40,13 +60,29 @@ export function createBillingProfile(client, req, options) {
         });
     });
 }
+/**
+ * Get a billing profile
+ *
+ * Get a billing profile.
+ *
+ * GET /openmeter/profiles/{id}
+ */
 export function getBillingProfile(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            id: req.id,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getBillingProfilePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getBillingProfilePathParamsWire, pathParams);
+        }
         const path = `openmeter/profiles/${(() => {
-            if (req.id === undefined) {
+            if (pathParams.id === undefined) {
                 throw new Error('missing path parameter: id');
             }
-            return encodeURIComponent(String(req.id));
+            return encodeURIComponent(String(pathParams.id));
         })()}`;
         return http(client)
             .get(path, options)
@@ -59,13 +95,29 @@ export function getBillingProfile(client, req, options) {
         });
     });
 }
+/**
+ * Update a billing profile
+ *
+ * Update a billing profile.
+ *
+ * PUT /openmeter/profiles/{id}
+ */
 export function updateBillingProfile(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            id: req.id,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.updateBillingProfilePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.updateBillingProfilePathParamsWire, pathParams);
+        }
         const path = `openmeter/profiles/${(() => {
-            if (req.id === undefined) {
+            if (pathParams.id === undefined) {
                 throw new Error('missing path parameter: id');
             }
-            return encodeURIComponent(String(req.id));
+            return encodeURIComponent(String(pathParams.id));
         })()}`;
         const body = toWire(req.body, schemas.updateBillingProfileBody);
         if (client._options.validate) {
@@ -82,15 +134,36 @@ export function updateBillingProfile(client, req, options) {
         });
     });
 }
+/**
+ * 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) {
     return request(async () => {
+        const pathParamsInput = {
+            id: req.id,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.deleteBillingProfilePathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.deleteBillingProfilePathParamsWire, pathParams);
+        }
         const path = `openmeter/profiles/${(() => {
-            if (req.id === undefined) {
+            if (pathParams.id === undefined) {
                 throw new Error('missing path parameter: id');
             }
-            return encodeURIComponent(String(req.id));
+            return encodeURIComponent(String(pathParams.id));
         })()}`;
         await http(client).delete(path, options);
     });
 }
-//# sourceMappingURL=billing.js.map

package/dist/funcs/currencies.d.ts

@@ -1,8 +1,45 @@
 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';
+import type { ListCurrenciesRequest, ListCurrenciesResponse, CreateCustomCurrencyRequest, CreateCustomCurrencyResponse, GetCustomCurrencyRequest, GetCustomCurrencyResponse, 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>>;
+/**
+ * Get custom currency
+ *
+ * Get a custom currency.
+ *
+ * GET /openmeter/currencies/custom/{currencyId}
+ */
+export declare function getCustomCurrency(client: Client, req: GetCustomCurrencyRequest, options?: RequestOptions): Promise<Result<GetCustomCurrencyResponse>>;
+/**
+ * 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

package/dist/funcs/currencies.js

@@ -1,14 +1,26 @@
+// 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 currencies
+ *
+ * List currencies supported by the billing system.
+ *
+ * GET /openmeter/currencies
+ */
 export function listCurrencies(client, req = {}, options) {
     return request(() => {
+        if (client._options.validate && req.sort !== undefined) {
+            assertValid(schemas.listCurrenciesQueryParams.shape.sort, req.sort);
+        }
         const query = toWire({
             page: req.page,
             sort: encodeSort(req.sort, toSnakeCase),
             filter: req.filter,
+            expand: req.expand,
         }, schemas.listCurrenciesQueryParams);
         if (client._options.validate) {
             assertValid(schemas.listCurrenciesQueryParamsWire, query);
@@ -25,6 +37,14 @@ export function listCurrencies(client, req = {}, options) {
         });
     });
 }
+/**
+ * Create custom currency
+ *
+ * Create a custom currency. This operation allows defining your own custom
+ * currency for billing purposes.
+ *
+ * POST /openmeter/currencies/custom
+ */
 export function createCustomCurrency(client, req, options) {
     return request(() => {
         const body = toWire(req, schemas.createCustomCurrencyBody);
@@ -42,13 +62,65 @@ export function createCustomCurrency(client, req, options) {
         });
     });
 }
+/**
+ * Get custom currency
+ *
+ * Get a custom currency.
+ *
+ * GET /openmeter/currencies/custom/{currencyId}
+ */
+export function getCustomCurrency(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            currencyId: req.currencyId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getCustomCurrencyPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getCustomCurrencyPathParamsWire, pathParams);
+        }
+        const path = `openmeter/currencies/custom/${(() => {
+            if (pathParams.currencyId === undefined) {
+                throw new Error('missing path parameter: currencyId');
+            }
+            return encodeURIComponent(String(pathParams.currencyId));
+        })()}`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getCustomCurrencyResponseWire, data);
+            }
+            return fromWire(data, schemas.getCustomCurrencyResponse);
+        });
+    });
+}
+/**
+ * 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 function listCostBases(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            currencyId: req.currencyId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.listCostBasesPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.listCostBasesPathParamsWire, pathParams);
+        }
         const path = `openmeter/currencies/custom/${(() => {
-            if (req.currencyId === undefined) {
+            if (pathParams.currencyId === undefined) {
                 throw new Error('missing path parameter: currencyId');
             }
-            return encodeURIComponent(String(req.currencyId));
+            return encodeURIComponent(String(pathParams.currencyId));
         })()}/cost-bases`;
         const query = toWire({
             filter: req.filter,
@@ -69,13 +141,29 @@ export function listCostBases(client, req, options) {
         });
     });
 }
+/**
+ * Create cost basis
+ *
+ * Create a cost basis for a currency.
+ *
+ * POST /openmeter/currencies/custom/{currencyId}/cost-bases
+ */
 export function createCostBasis(client, req, options) {
     return request(() => {
+        const pathParamsInput = {
+            currencyId: req.currencyId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.createCostBasisPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.createCostBasisPathParamsWire, pathParams);
+        }
         const path = `openmeter/currencies/custom/${(() => {
-            if (req.currencyId === undefined) {
+            if (pathParams.currencyId === undefined) {
                 throw new Error('missing path parameter: currencyId');
             }
-            return encodeURIComponent(String(req.currencyId));
+            return encodeURIComponent(String(pathParams.currencyId));
         })()}/cost-bases`;
         const body = toWire(req.body, schemas.createCostBasisBody);
         if (client._options.validate) {
@@ -92,4 +180,3 @@ export function createCostBasis(client, req, options) {
         });
     });
 }
-//# sourceMappingURL=currencies.js.map

package/dist/funcs/customers.d.ts

@@ -1,23 +1,186 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
-import type { CreateCustomerRequest, CreateCustomerResponse, GetCustomerRequest, GetCustomerResponse, ListCustomersRequest, ListCustomersResponse, UpsertCustomerRequest, UpsertCustomerResponse, DeleteCustomerRequest, DeleteCustomerResponse, GetCustomerBillingRequest, GetCustomerBillingResponse, UpdateCustomerBillingRequest, UpdateCustomerBillingResponse, UpdateCustomerBillingAppDataRequest, UpdateCustomerBillingAppDataResponse, CreateCustomerStripeCheckoutSessionRequest, CreateCustomerStripeCheckoutSessionResponse, CreateCustomerStripePortalSessionRequest, CreateCustomerStripePortalSessionResponse, CreateCreditGrantRequest, CreateCreditGrantResponse, GetCreditGrantRequest, GetCreditGrantResponse, ListCreditGrantsRequest, ListCreditGrantsResponse, GetCustomerCreditBalanceRequest, GetCustomerCreditBalanceResponse, CreateCreditAdjustmentRequest, CreateCreditAdjustmentResponse, UpdateCreditGrantExternalSettlementRequest, UpdateCreditGrantExternalSettlementResponse, ListCreditTransactionsRequest, ListCreditTransactionsResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
+import type { CreateCustomerRequest, CreateCustomerResponse, GetCustomerRequest, GetCustomerResponse, ListCustomersRequest, ListCustomersResponse, UpsertCustomerRequest, UpsertCustomerResponse, DeleteCustomerRequest, DeleteCustomerResponse, GetCustomerBillingRequest, GetCustomerBillingResponse, UpdateCustomerBillingRequest, UpdateCustomerBillingResponse, UpdateCustomerBillingAppDataRequest, UpdateCustomerBillingAppDataResponse, CreateCustomerStripeCheckoutSessionRequest, CreateCustomerStripeCheckoutSessionResponse, CreateCustomerStripePortalSessionRequest, CreateCustomerStripePortalSessionResponse, CreateCreditGrantRequest, CreateCreditGrantResponse, GetCreditGrantRequest, GetCreditGrantResponse, ListCreditGrantsRequest, ListCreditGrantsResponse, GetCustomerCreditBalanceRequest, GetCustomerCreditBalanceResponse, CreateCreditAdjustmentRequest, CreateCreditAdjustmentResponse, VoidCreditGrantRequest, VoidCreditGrantResponse, UpdateCreditGrantExternalSettlementRequest, UpdateCreditGrantExternalSettlementResponse, ListCreditTransactionsRequest, ListCreditTransactionsResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
+/**
+ * Create customer
+ *
+ * POST /openmeter/customers
+ */
 export declare function createCustomer(client: Client, req: CreateCustomerRequest, options?: RequestOptions): Promise<Result<CreateCustomerResponse>>;
+/**
+ * Get customer
+ *
+ * GET /openmeter/customers/{customerId}
+ */
 export declare function getCustomer(client: Client, req: GetCustomerRequest, options?: RequestOptions): Promise<Result<GetCustomerResponse>>;
+/**
+ * List customers
+ *
+ * GET /openmeter/customers
+ */
 export declare function listCustomers(client: Client, req?: ListCustomersRequest, options?: RequestOptions): Promise<Result<ListCustomersResponse>>;
+/**
+ * Upsert customer
+ *
+ * PUT /openmeter/customers/{customerId}
+ */
 export declare function upsertCustomer(client: Client, req: UpsertCustomerRequest, options?: RequestOptions): Promise<Result<UpsertCustomerResponse>>;
+/**
+ * Delete customer
+ *
+ * DELETE /openmeter/customers/{customerId}
+ */
 export declare function deleteCustomer(client: Client, req: DeleteCustomerRequest, options?: RequestOptions): Promise<Result<DeleteCustomerResponse>>;
+/**
+ * Get customer billing data
+ *
+ * GET /openmeter/customers/{customerId}/billing
+ */
 export declare function getCustomerBilling(client: Client, req: GetCustomerBillingRequest, options?: RequestOptions): Promise<Result<GetCustomerBillingResponse>>;
+/**
+ * Update customer billing data
+ *
+ * PUT /openmeter/customers/{customerId}/billing
+ */
 export declare function updateCustomerBilling(client: Client, req: UpdateCustomerBillingRequest, options?: RequestOptions): Promise<Result<UpdateCustomerBillingResponse>>;
+/**
+ * Update customer billing app data
+ *
+ * PUT /openmeter/customers/{customerId}/billing/app-data
+ */
 export declare function updateCustomerBillingAppData(client: Client, req: UpdateCustomerBillingAppDataRequest, options?: RequestOptions): Promise<Result<UpdateCustomerBillingAppDataResponse>>;
+/**
+ * Create Stripe Checkout Session
+ *
+ * Create a [Stripe Checkout Session](https://docs.stripe.com/payments/checkout)
+ * for the customer.
+ *
+ * Creates a Checkout Session for collecting payment method information from
+ * customers. The session operates in "setup" mode, which collects payment details
+ * without charging the customer immediately. The collected payment method can be
+ * used for future subscription billing.
+ *
+ * For hosted checkout sessions, redirect customers to the returned URL. For
+ * embedded sessions, use the client_secret to initialize Stripe.js in your
+ * application.
+ *
+ * POST /openmeter/customers/{customerId}/billing/stripe/checkout-sessions
+ */
 export declare function createCustomerStripeCheckoutSession(client: Client, req: CreateCustomerStripeCheckoutSessionRequest, options?: RequestOptions): Promise<Result<CreateCustomerStripeCheckoutSessionResponse>>;
+/**
+ * Create Stripe customer portal session
+ *
+ * Create Stripe Customer Portal Session.
+ *
+ * Useful to redirect the customer to the Stripe Customer Portal to manage their
+ * payment methods, change their billing address and access their invoice history.
+ * Only returns URL if the customer billing profile is linked to a stripe app and
+ * customer.
+ *
+ * POST /openmeter/customers/{customerId}/billing/stripe/portal-sessions
+ */
 export declare function createCustomerStripePortalSession(client: Client, req: CreateCustomerStripePortalSessionRequest, options?: RequestOptions): Promise<Result<CreateCustomerStripePortalSessionResponse>>;
+/**
+ * Create a new credit grant
+ *
+ * Create a new credit grant. A credit grant represents an allocation of prepaid
+ * credits to a customer.
+ *
+ * POST /openmeter/customers/{customerId}/credits/grants
+ */
 export declare function createCreditGrant(client: Client, req: CreateCreditGrantRequest, options?: RequestOptions): Promise<Result<CreateCreditGrantResponse>>;
+/**
+ * Get a credit grant
+ *
+ * Get a credit grant.
+ *
+ * GET /openmeter/customers/{customerId}/credits/grants/{creditGrantId}
+ */
 export declare function getCreditGrant(client: Client, req: GetCreditGrantRequest, options?: RequestOptions): Promise<Result<GetCreditGrantResponse>>;
+/**
+ * List credit grants
+ *
+ * List credit grants.
+ *
+ * GET /openmeter/customers/{customerId}/credits/grants
+ */
 export declare function listCreditGrants(client: Client, req: ListCreditGrantsRequest, options?: RequestOptions): Promise<Result<ListCreditGrantsResponse>>;
+/**
+ * Get a customer's credit balance
+ *
+ * Get a credit balance.
+ *
+ * GET /openmeter/customers/{customerId}/credits/balance
+ */
 export declare function getCustomerCreditBalance(client: Client, req: GetCustomerCreditBalanceRequest, options?: RequestOptions): Promise<Result<GetCustomerCreditBalanceResponse>>;
+/**
+ * Create a credit adjustment
+ *
+ * A credit adjustment can be used to make manual adjustments to a customer's
+ * credit balance.
+ *
+ * Supported use-cases:
+ *
+ * - Usage correction
+ *
+ * POST /openmeter/customers/{customerId}/credits/adjustments
+ */
 export declare function createCreditAdjustment(client: Client, req: CreateCreditAdjustmentRequest, options?: RequestOptions): Promise<Result<CreateCreditAdjustmentResponse>>;
+/**
+ * Void credit grant
+ *
+ * Void a credit grant, forfeiting the remaining unused balance.
+ *
+ * Voiding is a forward-looking, irreversible operation. Credits already consumed
+ * by usage remain unaffected — only the remaining balance is forfeited. The grant
+ * reads as `voided` status afterwards. Payment state is not adjusted when
+ * `payment_adjustment` is `none`, so invoice-backed or externally collected
+ * payments may still collect the original amount. Only `active` grants can be
+ * voided; voiding a pending, expired, or fully consumed grant returns a conflict.
+ * Retrying a successful void is an idempotent success.
+ *
+ * POST /openmeter/customers/{customerId}/credits/grants/{creditGrantId}/void
+ */
+export declare function voidCreditGrant(client: Client, req: VoidCreditGrantRequest, options?: RequestOptions): Promise<Result<VoidCreditGrantResponse>>;
+/**
+ * Update credit grant external settlement status
+ *
+ * Update the payment settlement status of an externally funded credit grant.
+ *
+ * Use this endpoint to synchronize the payment state of an external payment with
+ * the system so that revenue recognition and credit availability work as expected.
+ *
+ * POST /openmeter/customers/{customerId}/credits/grants/{creditGrantId}/settlement/external
+ */
 export declare function updateCreditGrantExternalSettlement(client: Client, req: UpdateCreditGrantExternalSettlementRequest, options?: RequestOptions): Promise<Result<UpdateCreditGrantExternalSettlementResponse>>;
+/**
+ * List credit transactions
+ *
+ * List credit transactions for a customer.
+ *
+ * Returns an immutable, chronological record of credit movements: funded credits
+ * and consumed credits. Transactions are returned in reverse chronological order
+ * by default.
+ *
+ * GET /openmeter/customers/{customerId}/credits/transactions
+ */
 export declare function listCreditTransactions(client: Client, req: ListCreditTransactionsRequest, options?: RequestOptions): Promise<Result<ListCreditTransactionsResponse>>;
+/**
+ * List customer charges
+ *
+ * List customer charges.
+ *
+ * Returns the customer's charges that are represented as either flat fee or
+ * usage-based charges.
+ *
+ * GET /openmeter/customers/{customerId}/charges
+ */
 export declare function listCustomerCharges(client: Client, req: ListCustomerChargesRequest, options?: RequestOptions): Promise<Result<ListCustomerChargesResponse>>;
+/**
+ * Create customer charge
+ *
+ * Create customer charge.
+ *
+ * POST /openmeter/customers/{customerId}/charges
+ */
 export declare function createCustomerCharges(client: Client, req: CreateCustomerChargesRequest, options?: RequestOptions): Promise<Result<CreateCustomerChargesResponse>>;
-//# sourceMappingURL=customers.d.ts.map