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

package/dist/funcs/customers.js

@@ -1,141 +1,631 @@
+// 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';
+/**
+ * Create customer
+ *
+ * POST /openmeter/customers
+ */
 export function createCustomer(client, req, options) {
-    return request(() => http(client)
-        .post('openmeter/customers', { ...options, json: req })
-        .json());
+    return request(() => {
+        const body = toWire(req, schemas.createCustomerBody);
+        if (client._options.validate) {
+            assertValid(schemas.createCustomerBodyWire, body);
+        }
+        return http(client)
+            .post('openmeter/customers', { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.createCustomerResponseWire, data);
+            }
+            return fromWire(data, schemas.createCustomerResponse);
+        });
+    });
 }
+/**
+ * Get customer
+ *
+ * GET /openmeter/customers/{customerId}
+ */
 export function getCustomer(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}', {
-        customerId: req.customerId,
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getCustomerResponseWire, data);
+            }
+            return fromWire(data, schemas.getCustomerResponse);
+        });
     });
-    return request(() => http(client).get(path, options).json());
 }
+/**
+ * List customers
+ *
+ * GET /openmeter/customers
+ */
 export function listCustomers(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.listCustomersQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listCustomersQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get('openmeter/customers', { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listCustomersResponseWire, data);
+            }
+            return fromWire(data, schemas.listCustomersResponse);
+        });
     });
-    return request(() => http(client)
-        .get('openmeter/customers', { ...options, searchParams })
-        .json());
 }
+/**
+ * Upsert customer
+ *
+ * PUT /openmeter/customers/{customerId}
+ */
 export function upsertCustomer(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}', {
-        customerId: req.customerId,
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}`;
+        const body = toWire(req.body, schemas.upsertCustomerBody);
+        if (client._options.validate) {
+            assertValid(schemas.upsertCustomerBodyWire, body);
+        }
+        return http(client)
+            .put(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.upsertCustomerResponseWire, data);
+            }
+            return fromWire(data, schemas.upsertCustomerResponse);
+        });
     });
-    return request(() => http(client)
-        .put(path, { ...options, json: req.body })
-        .json());
 }
+/**
+ * Delete customer
+ *
+ * DELETE /openmeter/customers/{customerId}
+ */
 export function deleteCustomer(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}', {
-        customerId: req.customerId,
-    });
     return request(async () => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}`;
         await http(client).delete(path, options);
     });
 }
+/**
+ * Get customer billing data
+ *
+ * GET /openmeter/customers/{customerId}/billing
+ */
 export function getCustomerBilling(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}/billing', {
-        customerId: req.customerId,
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/billing`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getCustomerBillingResponseWire, data);
+            }
+            return fromWire(data, schemas.getCustomerBillingResponse);
+        });
     });
-    return request(() => http(client).get(path, options).json());
 }
+/**
+ * Update customer billing data
+ *
+ * PUT /openmeter/customers/{customerId}/billing
+ */
 export function updateCustomerBilling(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}/billing', {
-        customerId: req.customerId,
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/billing`;
+        const body = toWire(req.body, schemas.updateCustomerBillingBody);
+        if (client._options.validate) {
+            assertValid(schemas.updateCustomerBillingBodyWire, body);
+        }
+        return http(client)
+            .put(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.updateCustomerBillingResponseWire, data);
+            }
+            return fromWire(data, schemas.updateCustomerBillingResponse);
+        });
     });
-    return request(() => http(client)
-        .put(path, { ...options, json: req.body })
-        .json());
 }
+/**
+ * Update customer billing app data
+ *
+ * PUT /openmeter/customers/{customerId}/billing/app-data
+ */
 export function updateCustomerBillingAppData(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}/billing/app-data', {
-        customerId: req.customerId,
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/billing/app-data`;
+        const body = toWire(req.body, schemas.updateCustomerBillingAppDataBody);
+        if (client._options.validate) {
+            assertValid(schemas.updateCustomerBillingAppDataBodyWire, body);
+        }
+        return http(client)
+            .put(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.updateCustomerBillingAppDataResponseWire, data);
+            }
+            return fromWire(data, schemas.updateCustomerBillingAppDataResponse);
+        });
     });
-    return request(() => http(client)
-        .put(path, { ...options, json: req.body })
-        .json());
 }
+/**
+ * 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 function createCustomerStripeCheckoutSession(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}/billing/stripe/checkout-sessions', { customerId: req.customerId });
-    return request(() => http(client)
-        .post(path, { ...options, json: req.body })
-        .json());
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/billing/stripe/checkout-sessions`;
+        const body = toWire(req.body, schemas.createCustomerStripeCheckoutSessionBody);
+        if (client._options.validate) {
+            assertValid(schemas.createCustomerStripeCheckoutSessionBodyWire, body);
+        }
+        return http(client)
+            .post(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.createCustomerStripeCheckoutSessionResponseWire, data);
+            }
+            return fromWire(data, schemas.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 function createCustomerStripePortalSession(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}/billing/stripe/portal-sessions', { customerId: req.customerId });
-    return request(() => http(client)
-        .post(path, { ...options, json: req.body })
-        .json());
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/billing/stripe/portal-sessions`;
+        const body = toWire(req.body, schemas.createCustomerStripePortalSessionBody);
+        if (client._options.validate) {
+            assertValid(schemas.createCustomerStripePortalSessionBodyWire, body);
+        }
+        return http(client)
+            .post(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.createCustomerStripePortalSessionResponseWire, data);
+            }
+            return fromWire(data, schemas.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 function createCreditGrant(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}/credits/grants', {
-        customerId: req.customerId,
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/credits/grants`;
+        const body = toWire(req.body, schemas.createCreditGrantBody);
+        if (client._options.validate) {
+            assertValid(schemas.createCreditGrantBodyWire, body);
+        }
+        return http(client)
+            .post(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.createCreditGrantResponseWire, data);
+            }
+            return fromWire(data, schemas.createCreditGrantResponse);
+        });
     });
-    return request(() => http(client)
-        .post(path, { ...options, json: req.body })
-        .json());
 }
+/**
+ * Get a credit grant
+ *
+ * Get a credit grant.
+ *
+ * GET /openmeter/customers/{customerId}/credits/grants/{creditGrantId}
+ */
 export function getCreditGrant(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}/credits/grants/{creditGrantId}', { customerId: req.customerId, creditGrantId: req.creditGrantId });
-    return request(() => http(client).get(path, options).json());
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/credits/grants/${(() => {
+            if (req.creditGrantId === undefined) {
+                throw new Error('missing path parameter: creditGrantId');
+            }
+            return encodeURIComponent(String(req.creditGrantId));
+        })()}`;
+        return http(client)
+            .get(path, options)
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getCreditGrantResponseWire, data);
+            }
+            return fromWire(data, schemas.getCreditGrantResponse);
+        });
+    });
 }
+/**
+ * List credit grants
+ *
+ * List credit grants.
+ *
+ * GET /openmeter/customers/{customerId}/credits/grants
+ */
 export function listCreditGrants(client, req, options) {
-    const searchParams = toURLSearchParams({
-        page: req.page,
-        filter: req.filter,
-    });
-    const path = encodePath('openmeter/customers/{customerId}/credits/grants', {
-        customerId: req.customerId,
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/credits/grants`;
+        const query = toWire({
+            page: req.page,
+            filter: req.filter,
+        }, schemas.listCreditGrantsQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listCreditGrantsQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get(path, { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listCreditGrantsResponseWire, data);
+            }
+            return fromWire(data, schemas.listCreditGrantsResponse);
+        });
     });
-    return request(() => http(client)
-        .get(path, { ...options, searchParams })
-        .json());
 }
+/**
+ * Get a customer's credit balance
+ *
+ * Get a credit balance.
+ *
+ * GET /openmeter/customers/{customerId}/credits/balance
+ */
 export function getCustomerCreditBalance(client, req, options) {
-    const searchParams = toURLSearchParams({
-        timestamp: req.timestamp,
-        filter: req.filter,
-    });
-    const path = encodePath('openmeter/customers/{customerId}/credits/balance', {
-        customerId: req.customerId,
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/credits/balance`;
+        const query = toWire({
+            timestamp: req.timestamp,
+            filter: req.filter,
+        }, schemas.getCustomerCreditBalanceQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.getCustomerCreditBalanceQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get(path, { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getCustomerCreditBalanceResponseWire, data);
+            }
+            return fromWire(data, schemas.getCustomerCreditBalanceResponse);
+        });
     });
-    return request(() => http(client)
-        .get(path, { ...options, searchParams })
-        .json());
 }
+/**
+ * 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 function createCreditAdjustment(client, req, options) {
-    const path = encodePath('openmeter/customers/{customerId}/credits/adjustments', { customerId: req.customerId });
-    return request(() => http(client)
-        .post(path, { ...options, json: req.body })
-        .json());
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/credits/adjustments`;
+        const body = toWire(req.body, schemas.createCreditAdjustmentBody);
+        if (client._options.validate) {
+            assertValid(schemas.createCreditAdjustmentBodyWire, body);
+        }
+        return http(client)
+            .post(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.createCreditAdjustmentResponseWire, data);
+            }
+            return fromWire(data, schemas.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 function voidCreditGrant(client, req, options) {
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/credits/grants/${(() => {
+            if (req.creditGrantId === undefined) {
+                throw new Error('missing path parameter: creditGrantId');
+            }
+            return encodeURIComponent(String(req.creditGrantId));
+        })()}/void`;
+        const body = toWire(req.body, schemas.voidCreditGrantBody);
+        if (client._options.validate) {
+            assertValid(schemas.voidCreditGrantBodyWire, body);
+        }
+        return http(client)
+            .post(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.voidCreditGrantResponseWire, data);
+            }
+            return fromWire(data, schemas.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 function updateCreditGrantExternalSettlement(client, req, options) {
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/credits/grants/${(() => {
+            if (req.creditGrantId === undefined) {
+                throw new Error('missing path parameter: creditGrantId');
+            }
+            return encodeURIComponent(String(req.creditGrantId));
+        })()}/settlement/external`;
+        const body = toWire(req.body, schemas.updateCreditGrantExternalSettlementBody);
+        if (client._options.validate) {
+            assertValid(schemas.updateCreditGrantExternalSettlementBodyWire, body);
+        }
+        return http(client)
+            .post(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.updateCreditGrantExternalSettlementResponseWire, data);
+            }
+            return fromWire(data, schemas.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 function listCreditTransactions(client, req, options) {
-    const searchParams = toURLSearchParams({
-        page: req.page,
-        filter: req.filter,
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/credits/transactions`;
+        const query = toWire({
+            page: req.page,
+            filter: req.filter,
+        }, schemas.listCreditTransactionsQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listCreditTransactionsQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get(path, { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listCreditTransactionsResponseWire, data);
+            }
+            return fromWire(data, schemas.listCreditTransactionsResponse);
+        });
     });
-    const path = encodePath('openmeter/customers/{customerId}/credits/transactions', { customerId: req.customerId });
-    return request(() => http(client)
-        .get(path, { ...options, searchParams })
-        .json());
 }
+/**
+ * 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 function listCustomerCharges(client, req, options) {
-    const searchParams = toURLSearchParams({
-        page: req.page,
-        sort: encodeSort(req.sort),
-        filter: req.filter,
-        expand: req.expand,
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/charges`;
+        const query = toWire({
+            page: req.page,
+            sort: encodeSort(req.sort, toSnakeCase),
+            filter: req.filter,
+            expand: req.expand,
+        }, schemas.listCustomerChargesQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.listCustomerChargesQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get(path, { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.listCustomerChargesResponseWire, data);
+            }
+            return fromWire(data, schemas.listCustomerChargesResponse);
+        });
     });
-    const path = encodePath('openmeter/customers/{customerId}/charges', {
-        customerId: req.customerId,
+}
+/**
+ * Create customer charge
+ *
+ * Create customer charge.
+ *
+ * POST /openmeter/customers/{customerId}/charges
+ */
+export function createCustomerCharges(client, req, options) {
+    return request(() => {
+        const path = `openmeter/customers/${(() => {
+            if (req.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(req.customerId));
+        })()}/charges`;
+        const body = toWire(req.body, schemas.createCustomerChargesBody);
+        if (client._options.validate) {
+            assertValid(schemas.createCustomerChargesBodyWire, body);
+        }
+        return http(client)
+            .post(path, { ...options, json: body })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.createCustomerChargesResponseWire, data);
+            }
+            return fromWire(data, schemas.createCustomerChargesResponse);
+        });
     });
-    return request(() => http(client)
-        .get(path, { ...options, searchParams })
-        .json());
 }
-//# sourceMappingURL=customers.js.map