@commet/node 1.1.1 → 1.3.0

package/README.md

@@ -8,7 +8,7 @@
   <p>TypeScript SDK for Commet billing platform</p>
 
   <a href="https://www.npmjs.com/package/@commet/node"><img alt="NPM version" src="https://img.shields.io/npm/v/@commet/node.svg?style=for-the-badge&labelColor=000000"></a>
-  <a href="https://docs.commet.co/docs/library/quickstart"><img alt="Documentation" src="https://img.shields.io/badge/docs-SDK-blue.svg?style=for-the-badge&labelColor=000000"></a>
+  <a href="https://commet.co/docs/library/quickstart"><img alt="Documentation" src="https://img.shields.io/badge/docs-SDK-blue.svg?style=for-the-badge&labelColor=000000"></a>
 </div>
 
 <br/>
@@ -55,7 +55,7 @@ await commet.subscriptions.create({
 
 // Manage customers
 await commet.customers.create({
-  legalName: 'Acme Corp',
+  fullName: 'Acme Corp',
   billingEmail: 'billing@acme.com'
 });
 
@@ -80,7 +80,7 @@ This generates type-safe autocomplete for your event types, seat types, and prod
 
 ## Documentation
 
-Visit [docs.commet.co/docs/library/quickstart](https://docs.commet.co/docs/library/quickstart) for:
+Visit [commet.co/docs/library/quickstart](https://commet.co/docs/library/quickstart) for:
 
 - Complete API reference
 - Advanced usage examples
@@ -89,8 +89,8 @@ Visit [docs.commet.co/docs/library/quickstart](https://docs.commet.co/docs/libra
 
 ## Resources
 
-- [CLI Documentation](https://docs.commet.co/docs/library/cli/overview)
-- [SDK Reference](https://docs.commet.co/docs/library/quickstart)
+- [CLI Documentation](https://commet.co/docs/library/cli/overview)
+- [SDK Reference](https://commet.co/docs/library/quickstart)
 - [GitHub](https://github.com/commet-labs/commet)
 - [Issues](https://github.com/commet-labs/commet/issues)
 

package/dist/index.d.mts

@@ -129,6 +129,13 @@ declare class CommetHTTPClient {
     private sleep;
 }
 
+interface FeatureParams {
+    externalId: string;
+    code: GeneratedFeatureCode;
+}
+type GetFeatureParams = FeatureParams;
+type CheckFeatureParams = FeatureParams;
+type CanUseFeatureParams = FeatureParams;
 interface FeatureAccess {
     code: string;
     name: string;
@@ -165,21 +172,24 @@ declare class FeaturesResource {
      *
      * @example
      * ```typescript
-     * const seats = await commet.features.get("team_members", "user_123");
+     * const seats = await commet.features.get({ code: "team_members", externalId: "user_123" });
      * console.log(seats.current, seats.included, seats.remaining);
      * ```
      */
-    get(code: GeneratedFeatureCode, externalId: string, options?: RequestOptions): Promise<ApiResponse<FeatureAccess>>;
+    get(params: GetFeatureParams, options?: RequestOptions): Promise<ApiResponse<FeatureAccess>>;
     /**
      * Check if a boolean feature is enabled for a customer
      *
      * @example
      * ```typescript
-     * const { allowed } = await commet.features.check("custom_branding", "user_123");
+     * const { allowed } = await commet.features.check({
+     *   code: "custom_branding",
+     *   externalId: "user_123"
+     * });
      * if (!allowed) redirect("/upgrade");
      * ```
      */
-    check(code: GeneratedFeatureCode, externalId: string, options?: RequestOptions): Promise<ApiResponse<CheckResult>>;
+    check(params: CheckFeatureParams, options?: RequestOptions): Promise<ApiResponse<CheckResult>>;
     /**
      * Check if customer can use one more unit of a feature
      *
@@ -188,7 +198,10 @@ declare class FeaturesResource {
      *
      * @example
      * ```typescript
-     * const { allowed, willBeCharged } = await commet.features.canUse("team_members", "user_123");
+     * const { allowed, willBeCharged } = await commet.features.canUse({
+     *   code: "team_members",
+     *   externalId: "user_123"
+     * });
      *
      * if (!allowed) {
      *   return { error: "Upgrade to add more members" };
@@ -199,13 +212,13 @@ declare class FeaturesResource {
      * }
      * ```
      */
-    canUse(code: GeneratedFeatureCode, externalId: string, options?: RequestOptions): Promise<ApiResponse<CanUseResult>>;
+    canUse(params: CanUseFeatureParams, options?: RequestOptions): Promise<ApiResponse<CanUseResult>>;
     /**
      * List all features for a customer's active subscription
      *
      * @example
      * ```typescript
-     * const features = await commet.features.list("user_123");
+     * const features = await commet.features.list({ externalId: "user_123" });
      * for (const feature of features) {
      *   console.log(feature.code, feature.allowed);
      * }
@@ -214,6 +227,44 @@ declare class FeaturesResource {
     list(externalId: string, options?: RequestOptions): Promise<ApiResponse<FeatureAccess[]>>;
 }
 
+interface PortalAccess {
+    success: boolean;
+    message: string;
+    portalUrl: string;
+}
+interface GetUrlByCustomerId {
+    customerId: CustomerID;
+    email?: never;
+    externalId?: never;
+}
+interface GetUrlByExternalId {
+    externalId: string;
+    email?: never;
+    customerId?: never;
+}
+interface GetUrlByEmail {
+    email: string;
+    customerId?: never;
+    externalId?: never;
+}
+type GetUrlParams = GetUrlByCustomerId | GetUrlByExternalId | GetUrlByEmail;
+/**
+ * Portal resource - Generate customer portal access
+ */
+declare class PortalResource {
+    private httpClient;
+    constructor(httpClient: CommetHTTPClient);
+    /**
+     * Get a portal URL
+     *
+     * @example
+     * ```typescript
+     * const portal = await commet.portal.getUrl({ externalId: 'user_123' });
+     * ```
+     */
+    getUrl(params: GetUrlParams, options?: RequestOptions): Promise<ApiResponse<PortalAccess>>;
+}
+
 interface SeatEvent {
     id: string;
     organizationId: string;
@@ -344,78 +395,6 @@ declare class SeatsResource {
     getAllBalances(params: GetAllBalancesParams): Promise<ApiResponse<Record<string, SeatBalance>>>;
 }
 
-interface UsageEvent {
-    id: EventID;
-    organizationId: string;
-    customerId: CustomerID;
-    eventType: GeneratedEventType;
-    idempotencyKey?: string;
-    ts: string;
-    properties?: UsageEventProperty[];
-    createdAt: string;
-}
-interface UsageEventProperty {
-    id: string;
-    usageEventId: EventID;
-    property: string;
-    value: string;
-    createdAt: string;
-}
-interface BatchResult$1<T> {
-    successful: T[];
-    failed: Array<{
-        index: number;
-        error: string;
-        data: TrackParams;
-    }>;
-}
-interface TrackParams {
-    eventType: GeneratedEventType;
-    customerId?: CustomerID;
-    externalId?: string;
-    idempotencyKey?: string;
-    value?: number;
-    timestamp?: string;
-    properties?: Record<string, string>;
-}
-/**
- * Usage resource - Track consumption events for usage-based billing
- */
-declare class UsageResource {
-    private httpClient;
-    constructor(httpClient: CommetHTTPClient);
-    /**
-     * Track a usage event
-     *
-     * @example
-     * ```typescript
-     * await commet.usage.track({
-     *   externalId: 'user_123',
-     *   eventType: 'api_call',
-     *   idempotencyKey: `evt_${requestId}`,
-     *   properties: { endpoint: '/users', method: 'GET' }
-     * });
-     * ```
-     */
-    track(params: TrackParams, options?: RequestOptions): Promise<ApiResponse<UsageEvent>>;
-    /**
-     * Track multiple usage events in a batch
-     *
-     * @example
-     * ```typescript
-     * await commet.usage.trackBatch({
-     *   events: [
-     *     { externalId: 'user_123', eventType: 'api_call', idempotencyKey: 'evt_1' },
-     *     { externalId: 'user_456', eventType: 'api_call', idempotencyKey: 'evt_2' }
-     *   ]
-     * });
-     * ```
-     */
-    trackBatch(params: {
-        events: TrackParams[];
-    }, options?: RequestOptions): Promise<ApiResponse<BatchResult$1<UsageEvent>>>;
-}
-
 type PlanID = `plan_${string}`;
 type BillingInterval = "monthly" | "quarterly" | "yearly";
 type FeatureType = "boolean" | "metered" | "seats";
@@ -579,13 +558,14 @@ type CreateSubscriptionParams = CustomerIdentifier & PlanIdentifier & {
     startDate?: string;
 };
 type ChangePlanParams = PlanIdentifier & {
+    subscriptionId: string;
     billingInterval?: BillingInterval;
 };
 interface CancelParams {
+    subscriptionId: string;
     reason?: string;
     immediate?: boolean;
 }
-type GetSubscriptionParams = CustomerIdentifier;
 /**
  * Subscription resource for managing subscriptions (plan-first model)
  *
@@ -613,70 +593,106 @@ declare class SubscriptionsResource {
      *
      * @example
      * ```typescript
-     * const sub = await commet.subscriptions.get({ externalId: 'user_123' });
+     * const sub = await commet.subscriptions.get('user_123');
      * ```
      */
-    get(params: GetSubscriptionParams): Promise<ApiResponse<ActiveSubscription | null>>;
+    get(externalId: string): Promise<ApiResponse<ActiveSubscription | null>>;
     /**
      * Change the plan of a subscription (upgrade/downgrade)
      *
      * @example
      * ```typescript
-     * await commet.subscriptions.changePlan('sub_xxx', {
+     * await commet.subscriptions.changePlan({
+     *   subscriptionId: 'sub_xxx',
      *   planCode: 'enterprise' // autocomplete works after `commet pull`
      * });
      * ```
      */
-    changePlan(subscriptionId: string, params: ChangePlanParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
+    changePlan(params: ChangePlanParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
     /**
      * Cancel a subscription
      *
      * @example
      * ```typescript
-     * await commet.subscriptions.cancel('sub_xxx', {
+     * await commet.subscriptions.cancel({
+     *   subscriptionId: 'sub_xxx',
      *   reason: 'switched_to_competitor'
      * });
      * ```
      */
-    cancel(subscriptionId: string, params?: CancelParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
+    cancel(params: CancelParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
 }
 
-interface PortalAccess {
-    success: boolean;
-    message: string;
-    portalUrl: string;
-}
-interface GetUrlByCustomerId {
+interface UsageEvent {
+    id: EventID;
+    organizationId: string;
     customerId: CustomerID;
-    email?: never;
-    externalId?: never;
+    eventType: GeneratedEventType;
+    idempotencyKey?: string;
+    ts: string;
+    properties?: UsageEventProperty[];
+    createdAt: string;
 }
-interface GetUrlByExternalId {
-    externalId: string;
-    email?: never;
-    customerId?: never;
+interface UsageEventProperty {
+    id: string;
+    usageEventId: EventID;
+    property: string;
+    value: string;
+    createdAt: string;
 }
-interface GetUrlByEmail {
-    email: string;
-    customerId?: never;
-    externalId?: never;
+interface BatchResult$1<T> {
+    successful: T[];
+    failed: Array<{
+        index: number;
+        error: string;
+        data: TrackParams;
+    }>;
+}
+interface TrackParams {
+    eventType: GeneratedEventType;
+    customerId?: CustomerID;
+    externalId?: string;
+    idempotencyKey?: string;
+    value?: number;
+    timestamp?: string;
+    properties?: Record<string, string>;
 }
-type GetUrlParams = GetUrlByCustomerId | GetUrlByExternalId | GetUrlByEmail;
 /**
- * Portal resource - Generate customer portal access
+ * Usage resource - Track consumption events for usage-based billing
  */
-declare class PortalResource {
+declare class UsageResource {
     private httpClient;
     constructor(httpClient: CommetHTTPClient);
     /**
-     * Get a portal URL
+     * Track a usage event
      *
      * @example
      * ```typescript
-     * const portal = await commet.portal.getUrl({ externalId: 'user_123' });
+     * await commet.usage.track({
+     *   externalId: 'user_123',
+     *   eventType: 'api_call',
+     *   idempotencyKey: `evt_${requestId}`,
+     *   properties: { endpoint: '/users', method: 'GET' }
+     * });
      * ```
      */
-    getUrl(params: GetUrlParams, options?: RequestOptions): Promise<ApiResponse<PortalAccess>>;
+    track(params: TrackParams, options?: RequestOptions): Promise<ApiResponse<UsageEvent>>;
+    /**
+     * Track multiple usage events in a batch
+     *
+     * @example
+     * ```typescript
+     * await commet.usage.trackBatch({
+     *   events: [
+     *     { externalId: 'user_123', eventType: 'api_call', idempotencyKey: 'evt_1' },
+     *     { externalId: 'user_456', eventType: 'api_call', idempotencyKey: 'evt_2' }
+     *   ]
+     * });
+     * ```
+     */
+    trackBatch(params: {
+        events: TrackParams[];
+    }, options?: RequestOptions): Promise<ApiResponse<BatchResult$1<UsageEvent>>>;
 }
 
 /**
@@ -751,8 +767,7 @@ interface Customer {
     id: CustomerID;
     organizationId: string;
     externalId?: string;
-    legalName?: string;
-    displayName?: string;
+    fullName?: string;
     domain?: string;
     website?: string;
     billingEmail: string;
@@ -776,8 +791,7 @@ interface CustomerAddress {
 interface CreateParams {
     email: string;
     externalId?: string;
-    legalName?: string;
-    displayName?: string;
+    fullName?: string;
     domain?: string;
     website?: string;
     timezone?: string;
@@ -787,10 +801,10 @@ interface CreateParams {
     address?: CustomerAddress;
 }
 interface UpdateParams {
+    customerId: CustomerID;
     externalId?: string;
     email?: string;
-    legalName?: string;
-    displayName?: string;
+    fullName?: string;
     domain?: string;
     website?: string;
     timezone?: string;
@@ -834,7 +848,7 @@ declare class CustomersResource {
     /**
      * Update a customer
      */
-    update(customerId: CustomerID, params: UpdateParams, options?: RequestOptions): Promise<ApiResponse<Customer>>;
+    update(params: UpdateParams, options?: RequestOptions): Promise<ApiResponse<Customer>>;
     /**
      * List customers with optional filters
      */
@@ -872,6 +886,16 @@ interface WebhookData {
  * Supported webhook events
  */
 type WebhookEvent = "subscription.created" | "subscription.activated" | "subscription.canceled" | "subscription.updated";
+interface VerifyParams {
+    payload: string;
+    signature: string | null;
+    secret: string;
+}
+interface VerifyAndParseParams {
+    rawBody: string;
+    signature: string | null;
+    secret: string;
+}
 /**
  * Webhooks resource for signature verification
  */
@@ -909,7 +933,7 @@ declare class Webhooks {
      * }
      * ```
      */
-    verify(payload: string, signature: string | null, secret: string): boolean;
+    verify(params: VerifyParams): boolean;
     /**
      * Generate HMAC-SHA256 signature (internal use)
      * @internal
@@ -918,18 +942,13 @@ declare class Webhooks {
     /**
      * Parse and verify webhook payload in one step
      *
-     * @param rawBody - Raw request body as string
-     * @param signature - Value from X-Commet-Signature header
-     * @param secret - Your webhook secret from Commet dashboard
-     * @returns Parsed payload if valid, null if invalid
-     *
      * @example
      * ```typescript
-     * const payload = commet.webhooks.verifyAndParse(
+     * const payload = commet.webhooks.verifyAndParse({
      *   rawBody,
      *   signature,
-     *   process.env.COMMET_WEBHOOK_SECRET
-     * );
+     *   secret: process.env.COMMET_WEBHOOK_SECRET
+     * });
      *
      * if (!payload) {
      *   return new Response('Invalid signature', { status: 401 });
@@ -941,7 +960,7 @@ declare class Webhooks {
      * }
      * ```
      */
-    verifyAndParse(rawBody: string, signature: string | null, secret: string): WebhookPayload | null;
+    verifyAndParse(params: VerifyAndParseParams): WebhookPayload | null;
 }
 
 /**
@@ -991,4 +1010,4 @@ declare function isProduction(environment: Environment): boolean;
  * Commet SDK - Billing and usage tracking for SaaS
  */
 
-export { type ActiveSubscription, type AddParams as AddSeatsParams, type ApiResponse, type BillingInterval, type CanUseResult, type CancelParams, type ChangePlanParams, type CheckResult, Commet, CommetAPIError, type CommetConfig, CommetError, type CommetGeneratedTypes, CommetValidationError, type CreateParams as CreateCustomerParams, type CreateSubscriptionParams, type Currency, type Customer, type CustomerAddress, CustomerContext, type CustomerID, type BatchResult as CustomersBatchResult, type Environment, type EventID, type FeatureAccess, type FeatureSummary, type FeatureType, type GeneratedEventType, type GeneratedFeatureCode, type GeneratedPlanCode, type GeneratedSeatType, type GetAllBalancesParams, type GetBalanceParams, type GetSubscriptionParams, type GetUrlParams, type ListCustomersParams, type ListPlansParams, type PaginatedList, type PaginatedResponse, type Plan, type PlanDetail, type PlanFeature, type PlanID, type PlanPrice, type PortalAccess, type RemoveParams as RemoveSeatsParams, type RequestOptions, type SeatBalance, type SeatEvent, type SetAllParams as SetAllSeatsParams, type SetParams as SetSeatsParams, type Subscription, type SubscriptionStatus, type TrackParams, type UpdateParams as UpdateCustomerParams, type BatchResult$1 as UsageBatchResult, type UsageEvent, type UsageEventProperty, type WebhookData, type WebhookEvent, type WebhookPayload, Webhooks, Commet as default, isProduction, isSandbox };
+export { type ActiveSubscription, type AddParams as AddSeatsParams, type ApiResponse, type BillingInterval, type CanUseFeatureParams, type CanUseResult, type CancelParams, type ChangePlanParams, type CheckFeatureParams, type CheckResult, Commet, CommetAPIError, type CommetConfig, CommetError, type CommetGeneratedTypes, CommetValidationError, type CreateParams as CreateCustomerParams, type CreateSubscriptionParams, type Currency, type Customer, type CustomerAddress, CustomerContext, type CustomerID, type BatchResult as CustomersBatchResult, type Environment, type EventID, type FeatureAccess, type FeatureSummary, type FeatureType, type GeneratedEventType, type GeneratedFeatureCode, type GeneratedPlanCode, type GeneratedSeatType, type GetAllBalancesParams, type GetBalanceParams, type GetFeatureParams, type GetUrlParams, type ListCustomersParams, type ListPlansParams, type PaginatedList, type PaginatedResponse, type Plan, type PlanDetail, type PlanFeature, type PlanID, type PlanPrice, type PortalAccess, type RemoveParams as RemoveSeatsParams, type RequestOptions, type SeatBalance, type SeatEvent, type SetAllParams as SetAllSeatsParams, type SetParams as SetSeatsParams, type Subscription, type SubscriptionStatus, type TrackParams, type UpdateParams as UpdateCustomerParams, type BatchResult$1 as UsageBatchResult, type UsageEvent, type UsageEventProperty, type WebhookData, type WebhookEvent, type WebhookPayload, Webhooks, Commet as default, isProduction, isSandbox };