@commet/node 1.5.0 → 1.6.1

package/dist/index.d.mts

@@ -9,8 +9,9 @@ type CommetConfig = {
 interface ApiResponse<T = unknown> {
     success: boolean;
     data?: T;
-    error?: string;
+    code?: string;
     message?: string;
+    details?: unknown;
     hasMore?: boolean;
     nextCursor?: string;
 }
@@ -57,39 +58,24 @@ interface RequestOptions {
  * Generated types interface - augmented by CLI after 'commet pull'
  *
  * This interface gets filled by module augmentation when you run `commet pull`.
- * The CLI generates a .commet.d.ts file that augments this interface with your
- * organization's specific event and seat types.
+ * The CLI generates a .commet/types.d.ts file that augments this interface with your
+ * organization's specific feature codes, seat types, and plan codes.
  *
  * @example
  * // After running `commet pull`, TypeScript will automatically know your types:
- * await commet.usage.events.create({
- *   eventType: 'api_call', // Autocomplete works!
- *   customerId: 'cus_123'
+ * await commet.usage.track({
+ *   feature: 'api_calls', // Autocomplete works!
+ *   externalId: 'user_123'
  * });
  */
 interface CommetGeneratedTypes {
 }
-/**
- * Helper type that provides fallback to string if types are not generated
- */
-type GeneratedEventType = CommetGeneratedTypes extends {
-    eventType: infer T;
-} ? T : string;
-/**
- * Helper type that provides fallback to string if types are not generated
- */
 type GeneratedSeatType = CommetGeneratedTypes extends {
     seatType: infer T;
 } ? T : string;
-/**
- * Helper type that provides fallback to string if types are not generated
- */
 type GeneratedPlanCode = CommetGeneratedTypes extends {
     planCode: infer T;
 } ? T : string;
-/**
- * Helper type that provides fallback to string if types are not generated
- */
 type GeneratedFeatureCode = CommetGeneratedTypes extends {
     featureCode: infer T;
 } ? T : string;
@@ -402,6 +388,7 @@ interface PlanPrice {
     billingInterval: BillingInterval;
     price: number;
     isDefault: boolean;
+    trialDays: number;
 }
 interface PlanFeature {
     code: string;
@@ -417,30 +404,46 @@ interface Plan {
     id: PlanID;
     code: string;
     name: string;
-    description?: string;
+    description: string | null;
     isPublic: boolean;
+    isFree: boolean;
     isDefault: boolean;
-    trialDays: number;
     sortOrder: number;
     prices: PlanPrice[];
     features: PlanFeature[];
     createdAt: string;
 }
-interface PlanDetail extends Plan {
-    features: Array<PlanFeature & {
-        unitName?: string;
-        overage?: {
-            enabled: boolean;
-            model: "per_unit" | "tiered";
-            unitPrice: number;
-            tiers?: Array<{
-                order: number;
-                upTo: number | null;
-                unitAmount: number;
-                flatFee: number;
-            }>;
-        } | null;
-    }>;
+interface PlanDetailPrice {
+    billingInterval: BillingInterval;
+    price: number;
+    isDefault: boolean;
+    trialDays: number;
+    introOffer: {
+        enabled: boolean;
+        discountType: "percentage" | "amount" | null;
+        discountValue: number | null;
+        durationCycles: number | null;
+    } | null;
+}
+interface PlanDetailFeature extends PlanFeature {
+    unitName: string | null;
+    overage: {
+        enabled: boolean;
+        model: "per_unit" | "tiered" | null;
+        unitPrice: number | null;
+    } | null;
+}
+interface PlanDetail {
+    id: PlanID;
+    code: string;
+    name: string;
+    description: string | null;
+    isPublic: boolean;
+    isDefault: boolean;
+    sortOrder: number;
+    prices: PlanDetailPrice[];
+    features: PlanDetailFeature[];
+    createdAt: string;
     updatedAt: string;
 }
 interface ListPlansParams extends ListParams {
@@ -498,12 +501,12 @@ interface ActiveSubscription {
         id: string;
         name: string;
         basePrice: number;
-        billingInterval: BillingInterval;
+        billingInterval: BillingInterval | null;
     };
     name: string;
-    description?: string;
+    description: string | null;
     status: SubscriptionStatus;
-    trialEndsAt?: string;
+    trialEndsAt: string | null;
     currentPeriod: {
         start: string;
         end: string;
@@ -511,13 +514,35 @@ interface ActiveSubscription {
     };
     features: FeatureSummary[];
     startDate: string;
-    endDate?: string;
+    endDate: string | null;
     billingDayOfMonth: number;
     nextBillingDate: string;
-    checkoutUrl?: string;
+    checkoutUrl: string | null;
     createdAt: string;
     updatedAt: string;
 }
+interface CreatedSubscription {
+    id: string;
+    customerId: string;
+    externalId: string;
+    planId: string;
+    planName: string;
+    name: string;
+    status: SubscriptionStatus;
+    billingInterval: BillingInterval | null;
+    trialEndsAt: string | null;
+    startDate: string;
+    endDate: string | null;
+    currentPeriodStart: string | null;
+    currentPeriodEnd: string | null;
+    billingDayOfMonth: number;
+    checkoutUrl: string | null;
+    createdAt: string;
+    updatedAt: string;
+    introOfferEndsAt: string | null;
+    introOfferDiscountType: "percentage" | "amount" | null;
+    introOfferDiscountValue: number | null;
+}
 interface Subscription {
     id: string;
     customerId: string;
@@ -559,10 +584,6 @@ type CreateSubscriptionParams = CustomerIdentifier & PlanIdentifier & {
     startDate?: string;
     successUrl?: string;
 };
-type ChangePlanParams = PlanIdentifier & {
-    subscriptionId: string;
-    billingInterval?: BillingInterval;
-};
 interface CancelParams {
     subscriptionId: string;
     reason?: string;
@@ -589,7 +610,7 @@ declare class SubscriptionsResource {
      * });
      * ```
      */
-    create(params: CreateSubscriptionParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
+    create(params: CreateSubscriptionParams, options?: RequestOptions): Promise<ApiResponse<CreatedSubscription>>;
     /**
      * Get the active subscription for a customer
      *
@@ -599,18 +620,6 @@ declare class SubscriptionsResource {
      * ```
      */
     get(externalId: string): Promise<ApiResponse<ActiveSubscription | null>>;
-    /**
-     * Change the plan of a subscription (upgrade/downgrade)
-     *
-     * @example
-     * ```typescript
-     * await commet.subscriptions.changePlan({
-     *   subscriptionId: 'sub_xxx',
-     *   planCode: 'enterprise' // autocomplete works after `commet pull`
-     * });
-     * ```
-     */
-    changePlan(params: ChangePlanParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
     /**
      * Cancel a subscription
      *
@@ -651,7 +660,7 @@ interface BatchResult$1<T> {
     }>;
 }
 interface TrackParams {
-    feature: string;
+    feature: GeneratedFeatureCode;
     customerId?: CustomerID;
     externalId?: string;
     idempotencyKey?: string;
@@ -766,6 +775,32 @@ declare class CustomerContext {
     };
 }
 
+interface CreditPack {
+    id: string;
+    name: string;
+    description: string | null;
+    credits: number;
+    price: number;
+    currency: string;
+}
+/**
+ * Credit Packs resource for listing available credit packs
+ */
+declare class CreditPacksResource {
+    private httpClient;
+    constructor(httpClient: CommetHTTPClient);
+    /**
+     * List all active credit packs
+     *
+     * @example
+     * ```typescript
+     * const packs = await commet.creditPacks.list();
+     * console.log(packs.data); // [{ id: "cp_xxx", name: "100 Credits", ... }]
+     * ```
+     */
+    list(): Promise<ApiResponse<CreditPack[]>>;
+}
+
 interface Customer {
     id: CustomerID;
     organizationId: string;
@@ -862,32 +897,6 @@ declare class CustomersResource {
     archive(customerId: CustomerID, options?: RequestOptions): Promise<ApiResponse<Customer>>;
 }
 
-interface CreditPack {
-    id: string;
-    name: string;
-    description: string | null;
-    credits: number;
-    price: number;
-    currency: string;
-}
-/**
- * Credit Packs resource for listing available credit packs
- */
-declare class CreditPacksResource {
-    private httpClient;
-    constructor(httpClient: CommetHTTPClient);
-    /**
-     * List all active credit packs
-     *
-     * @example
-     * ```typescript
-     * const packs = await commet.creditPacks.list();
-     * console.log(packs.data); // [{ id: "cp_xxx", name: "100 Credits", ... }]
-     * ```
-     */
-    list(): Promise<ApiResponse<CreditPack[]>>;
-}
-
 /**
  * Webhook payload structure from Commet
  */
@@ -1040,4 +1049,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 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 CreditPack, 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 };
+export { type ActiveSubscription, type AddParams as AddSeatsParams, type ApiResponse, type BillingInterval, type CanUseFeatureParams, type CanUseResult, type CancelParams, type CheckFeatureParams, type CheckResult, Commet, CommetAPIError, type CommetConfig, CommetError, type CommetGeneratedTypes, CommetValidationError, type CreateParams as CreateCustomerParams, type CreateSubscriptionParams, type CreatedSubscription, type CreditPack, type Currency, type Customer, type CustomerAddress, CustomerContext, type CustomerID, type BatchResult as CustomersBatchResult, type Environment, type EventID, type FeatureAccess, type FeatureSummary, type FeatureType, 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 };

package/dist/index.d.ts

@@ -9,8 +9,9 @@ type CommetConfig = {
 interface ApiResponse<T = unknown> {
     success: boolean;
     data?: T;
-    error?: string;
+    code?: string;
     message?: string;
+    details?: unknown;
     hasMore?: boolean;
     nextCursor?: string;
 }
@@ -57,39 +58,24 @@ interface RequestOptions {
  * Generated types interface - augmented by CLI after 'commet pull'
  *
  * This interface gets filled by module augmentation when you run `commet pull`.
- * The CLI generates a .commet.d.ts file that augments this interface with your
- * organization's specific event and seat types.
+ * The CLI generates a .commet/types.d.ts file that augments this interface with your
+ * organization's specific feature codes, seat types, and plan codes.
  *
  * @example
  * // After running `commet pull`, TypeScript will automatically know your types:
- * await commet.usage.events.create({
- *   eventType: 'api_call', // Autocomplete works!
- *   customerId: 'cus_123'
+ * await commet.usage.track({
+ *   feature: 'api_calls', // Autocomplete works!
+ *   externalId: 'user_123'
  * });
  */
 interface CommetGeneratedTypes {
 }
-/**
- * Helper type that provides fallback to string if types are not generated
- */
-type GeneratedEventType = CommetGeneratedTypes extends {
-    eventType: infer T;
-} ? T : string;
-/**
- * Helper type that provides fallback to string if types are not generated
- */
 type GeneratedSeatType = CommetGeneratedTypes extends {
     seatType: infer T;
 } ? T : string;
-/**
- * Helper type that provides fallback to string if types are not generated
- */
 type GeneratedPlanCode = CommetGeneratedTypes extends {
     planCode: infer T;
 } ? T : string;
-/**
- * Helper type that provides fallback to string if types are not generated
- */
 type GeneratedFeatureCode = CommetGeneratedTypes extends {
     featureCode: infer T;
 } ? T : string;
@@ -402,6 +388,7 @@ interface PlanPrice {
     billingInterval: BillingInterval;
     price: number;
     isDefault: boolean;
+    trialDays: number;
 }
 interface PlanFeature {
     code: string;
@@ -417,30 +404,46 @@ interface Plan {
     id: PlanID;
     code: string;
     name: string;
-    description?: string;
+    description: string | null;
     isPublic: boolean;
+    isFree: boolean;
     isDefault: boolean;
-    trialDays: number;
     sortOrder: number;
     prices: PlanPrice[];
     features: PlanFeature[];
     createdAt: string;
 }
-interface PlanDetail extends Plan {
-    features: Array<PlanFeature & {
-        unitName?: string;
-        overage?: {
-            enabled: boolean;
-            model: "per_unit" | "tiered";
-            unitPrice: number;
-            tiers?: Array<{
-                order: number;
-                upTo: number | null;
-                unitAmount: number;
-                flatFee: number;
-            }>;
-        } | null;
-    }>;
+interface PlanDetailPrice {
+    billingInterval: BillingInterval;
+    price: number;
+    isDefault: boolean;
+    trialDays: number;
+    introOffer: {
+        enabled: boolean;
+        discountType: "percentage" | "amount" | null;
+        discountValue: number | null;
+        durationCycles: number | null;
+    } | null;
+}
+interface PlanDetailFeature extends PlanFeature {
+    unitName: string | null;
+    overage: {
+        enabled: boolean;
+        model: "per_unit" | "tiered" | null;
+        unitPrice: number | null;
+    } | null;
+}
+interface PlanDetail {
+    id: PlanID;
+    code: string;
+    name: string;
+    description: string | null;
+    isPublic: boolean;
+    isDefault: boolean;
+    sortOrder: number;
+    prices: PlanDetailPrice[];
+    features: PlanDetailFeature[];
+    createdAt: string;
     updatedAt: string;
 }
 interface ListPlansParams extends ListParams {
@@ -498,12 +501,12 @@ interface ActiveSubscription {
         id: string;
         name: string;
         basePrice: number;
-        billingInterval: BillingInterval;
+        billingInterval: BillingInterval | null;
     };
     name: string;
-    description?: string;
+    description: string | null;
     status: SubscriptionStatus;
-    trialEndsAt?: string;
+    trialEndsAt: string | null;
     currentPeriod: {
         start: string;
         end: string;
@@ -511,13 +514,35 @@ interface ActiveSubscription {
     };
     features: FeatureSummary[];
     startDate: string;
-    endDate?: string;
+    endDate: string | null;
     billingDayOfMonth: number;
     nextBillingDate: string;
-    checkoutUrl?: string;
+    checkoutUrl: string | null;
     createdAt: string;
     updatedAt: string;
 }
+interface CreatedSubscription {
+    id: string;
+    customerId: string;
+    externalId: string;
+    planId: string;
+    planName: string;
+    name: string;
+    status: SubscriptionStatus;
+    billingInterval: BillingInterval | null;
+    trialEndsAt: string | null;
+    startDate: string;
+    endDate: string | null;
+    currentPeriodStart: string | null;
+    currentPeriodEnd: string | null;
+    billingDayOfMonth: number;
+    checkoutUrl: string | null;
+    createdAt: string;
+    updatedAt: string;
+    introOfferEndsAt: string | null;
+    introOfferDiscountType: "percentage" | "amount" | null;
+    introOfferDiscountValue: number | null;
+}
 interface Subscription {
     id: string;
     customerId: string;
@@ -559,10 +584,6 @@ type CreateSubscriptionParams = CustomerIdentifier & PlanIdentifier & {
     startDate?: string;
     successUrl?: string;
 };
-type ChangePlanParams = PlanIdentifier & {
-    subscriptionId: string;
-    billingInterval?: BillingInterval;
-};
 interface CancelParams {
     subscriptionId: string;
     reason?: string;
@@ -589,7 +610,7 @@ declare class SubscriptionsResource {
      * });
      * ```
      */
-    create(params: CreateSubscriptionParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
+    create(params: CreateSubscriptionParams, options?: RequestOptions): Promise<ApiResponse<CreatedSubscription>>;
     /**
      * Get the active subscription for a customer
      *
@@ -599,18 +620,6 @@ declare class SubscriptionsResource {
      * ```
      */
     get(externalId: string): Promise<ApiResponse<ActiveSubscription | null>>;
-    /**
-     * Change the plan of a subscription (upgrade/downgrade)
-     *
-     * @example
-     * ```typescript
-     * await commet.subscriptions.changePlan({
-     *   subscriptionId: 'sub_xxx',
-     *   planCode: 'enterprise' // autocomplete works after `commet pull`
-     * });
-     * ```
-     */
-    changePlan(params: ChangePlanParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
     /**
      * Cancel a subscription
      *
@@ -651,7 +660,7 @@ interface BatchResult$1<T> {
     }>;
 }
 interface TrackParams {
-    feature: string;
+    feature: GeneratedFeatureCode;
     customerId?: CustomerID;
     externalId?: string;
     idempotencyKey?: string;
@@ -766,6 +775,32 @@ declare class CustomerContext {
     };
 }
 
+interface CreditPack {
+    id: string;
+    name: string;
+    description: string | null;
+    credits: number;
+    price: number;
+    currency: string;
+}
+/**
+ * Credit Packs resource for listing available credit packs
+ */
+declare class CreditPacksResource {
+    private httpClient;
+    constructor(httpClient: CommetHTTPClient);
+    /**
+     * List all active credit packs
+     *
+     * @example
+     * ```typescript
+     * const packs = await commet.creditPacks.list();
+     * console.log(packs.data); // [{ id: "cp_xxx", name: "100 Credits", ... }]
+     * ```
+     */
+    list(): Promise<ApiResponse<CreditPack[]>>;
+}
+
 interface Customer {
     id: CustomerID;
     organizationId: string;
@@ -862,32 +897,6 @@ declare class CustomersResource {
     archive(customerId: CustomerID, options?: RequestOptions): Promise<ApiResponse<Customer>>;
 }
 
-interface CreditPack {
-    id: string;
-    name: string;
-    description: string | null;
-    credits: number;
-    price: number;
-    currency: string;
-}
-/**
- * Credit Packs resource for listing available credit packs
- */
-declare class CreditPacksResource {
-    private httpClient;
-    constructor(httpClient: CommetHTTPClient);
-    /**
-     * List all active credit packs
-     *
-     * @example
-     * ```typescript
-     * const packs = await commet.creditPacks.list();
-     * console.log(packs.data); // [{ id: "cp_xxx", name: "100 Credits", ... }]
-     * ```
-     */
-    list(): Promise<ApiResponse<CreditPack[]>>;
-}
-
 /**
  * Webhook payload structure from Commet
  */
@@ -1040,4 +1049,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 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 CreditPack, 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 };
+export { type ActiveSubscription, type AddParams as AddSeatsParams, type ApiResponse, type BillingInterval, type CanUseFeatureParams, type CanUseResult, type CancelParams, type CheckFeatureParams, type CheckResult, Commet, CommetAPIError, type CommetConfig, CommetError, type CommetGeneratedTypes, CommetValidationError, type CreateParams as CreateCustomerParams, type CreateSubscriptionParams, type CreatedSubscription, type CreditPack, type Currency, type Customer, type CustomerAddress, CustomerContext, type CustomerID, type BatchResult as CustomersBatchResult, type Environment, type EventID, type FeatureAccess, type FeatureSummary, type FeatureType, 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 };