@lavapayments/nodejs 6.1.0 → 8.0.0

package/README.md

@@ -38,8 +38,8 @@ console.log(checkoutSession.checkout_session_token);
 ```typescript
 // Generate a forward token
 const forwardToken = lava.generateForwardToken({
-  connection_secret: 'connection_secret',
-  product_secret: 'product_secret',
+  connection_id: 'connection_id',
+  meter_slug: 'meter_slug',
 });
 
 // Use the token to make an API request through Lava
@@ -65,11 +65,11 @@ const data = await response.json();
 console.log(data);
 ```
 
-### Check a connection's balance
+### Check a connection's credit status
 
 ```typescript
 const connection = await lava.connections.retrieve('connection_id');
-console.log('Current balance:', connection.wallet.balance);
+console.log('Has credit balance:', connection.has_lava_credit_balance);
 ```
 
 ### Get connection requests

package/dist/index.d.mts

@@ -1,32 +1,25 @@
 interface CreateCheckoutSessionParams {
     checkout_mode: 'onboarding' | 'topup' | 'subscription' | 'credit_bundle';
     origin_url: string;
-    reference_id?: string;
     connection_id?: string;
     subscription_config_id?: string;
     credit_bundle_id?: string;
 }
-interface CheckoutSessionsListParams {
-    cursor?: string;
-    limit?: number;
-    reference_id?: string;
-}
 interface ConnectionsListParams {
     cursor?: string;
     limit?: number;
-    reference_id?: string;
 }
 interface RequestsListParams {
     cursor?: string;
     limit?: number;
     connection_id?: string;
-    product_id?: string;
+    meter_id?: string;
     metadata_filters?: Record<string, string>;
 }
 interface CreateRequestParams {
     request_id: string;
-    connection_secret: string;
-    product_secret: string;
+    connection_id: string;
+    meter_slug: string;
     metadata?: Record<string, string>;
     input_tokens?: number;
     output_tokens?: number;
@@ -44,7 +37,7 @@ interface UsageParams {
     start: string;
     end?: string;
     connection_id?: string;
-    product_id?: string;
+    meter_id?: string;
     metadata_filters?: Record<string, string>;
 }
 interface ListResponse<T> {
@@ -52,79 +45,66 @@ interface ListResponse<T> {
     has_more: boolean;
     next_cursor?: string;
 }
-interface CreateSubscriptionConfigParams {
-    name: string;
-    period_amount: string;
-    rollover_type: 'full' | 'none';
-}
-interface UpdateSubscriptionConfigParams {
-    name?: string;
-    period_amount?: string;
-    rollover_type?: 'full' | 'none';
-}
 type RestCheckoutSession = {
     checkout_session_id: string;
     checkout_session_token: string;
     checkout_mode: 'onboarding' | 'topup' | 'subscription' | 'credit_bundle';
     origin_url: string;
     connection_id?: string;
-    reference_id?: string;
     subscription_config_id?: string;
     created_at: string;
     completed_at?: string;
 };
-type RestConnection = {
-    connection_id: string;
-    connection_secret: string;
-    reference_id?: string;
-    wallet: {
-        balance: string;
-        phone: string;
-        email: string;
-        first_name: string;
-        last_name: string;
-        autopay_enabled: boolean;
-    };
-    next_usage_reset: string;
-    previous_usage_reset: string;
-    created_at: string;
-};
-type RestConnectionSubscriptionCredits = {
-    total_remaining: string;
-    cycle_remaining: string;
-    bundle_remaining: string;
-    cycle_rollover: 'full' | 'none';
-    bundle_rollover: 'full' | 'none';
-};
-type RestConnectionSubscriptionPendingChange = {
-    type: 'cancellation' | 'downgrade';
-    effective_at: string | null;
-    subscription_config_id?: string;
-    name?: string;
-    period_amount?: string;
-    included_credit?: string;
+type RestConnectionCustomer = {
+    phone: string;
+    email: string;
+    first_name: string;
+    last_name: string;
 };
-type RestConnectionSubscriptionDetails = {
-    active_subscription_id: string;
+/**
+ * Simple subscription summary included in connection responses.
+ * For full subscription details, use getSubscription().
+ */
+type RestConnectionSubscription = {
+    subscription_id: string;
     subscription_config_id: string;
     name: string;
     status: 'active' | 'cancelled';
-    billing_interval: 'month' | 'year';
-    period_amount: string;
-    included_credit: string;
+};
+/**
+ * Base subscription shape shared between endpoints.
+ * Used directly by GET /v1/connections/:id/subscription
+ */
+type RestSubscriptionBase = {
+    subscription_id: string;
+    subscription_config_id: string;
+    status: 'active' | 'cancelled';
+    started_at: string;
+    cancelled_at: string | null;
     cycle_start_at: string | null;
     cycle_end_at: string | null;
-    credits: RestConnectionSubscriptionCredits;
-    pending_change: RestConnectionSubscriptionPendingChange | null;
+    plan: RestSubscriptionPlan;
+    credits: RestSubscriptionCredits;
+    pending_change: RestPendingChange | null;
 };
-type RestConnectionSubscription = {
-    subscription: RestConnectionSubscriptionDetails | null;
+/**
+ * Response shape for getSubscription() method.
+ */
+type RestConnectionSubscriptionResponse = {
+    subscription: RestSubscriptionBase | null;
+};
+type RestConnection = {
+    connection_id: string;
+    has_lava_credit_balance: boolean;
+    customer: RestConnectionCustomer;
+    subscription: RestConnectionSubscription | null;
+    created_at: string;
 };
 type RestRequest = {
     request_id: string;
     status: 'pending' | 'completed' | 'error';
     connection_id?: string;
-    product_id?: string;
+    meter_id?: string;
     provider: string;
     provider_key_type: 'managed' | 'unmanaged';
     model?: string;
@@ -201,35 +181,91 @@ type RestUsage = {
         total_net_volume: string;
     };
 };
+type RestSubscriptionConfigLinkedMeter = {
+    meter_id: string;
+    name: string;
+};
+type RestSubscriptionConfigCreditBundle = {
+    credit_bundle_id: string;
+    name: string;
+    cost: string;
+    credit_amount: string;
+};
 type RestSubscriptionConfig = {
     subscription_config_id: string;
     merchant_id: string;
     name: string;
     period_amount: string;
+    included_credit: string;
+    billing_interval: 'day' | 'week' | 'month' | 'year';
     rollover_type: 'full' | 'none';
     bundle_rollover_type: 'full' | 'none';
+    linked_meters: RestSubscriptionConfigLinkedMeter[];
+    credit_bundles: RestSubscriptionConfigCreditBundle[];
     created_at: string;
 };
-type RestActiveSubscription = {
-    active_subscription_id: string;
-    wallet_id: string;
+type RestPendingChange = {
+    type: 'cancellation' | 'downgrade';
+    effective_at: string | null;
+    subscription_config_id?: string;
+    name?: string;
+    period_amount?: string;
+    included_credit?: string;
+};
+type RestSubscriptionPlan = {
+    name: string;
+    period_amount: string;
+    included_credit: string;
+    billing_interval: 'day' | 'week' | 'month' | 'year';
+    rollover_type: 'full' | 'none';
+    bundle_rollover_type: 'full' | 'none';
+};
+type RestSubscriptionCredits = {
+    total_remaining: string;
+    cycle_remaining: string;
+    bundle_remaining: string;
+};
+type RestSubscriptionCustomer = {
+    phone: string;
+    email?: string;
+    first_name?: string;
+    last_name?: string;
+};
+/**
+ * Extended subscription shape for list endpoint.
+ * Adds connection_id and customer since endpoint spans connections.
+ */
+type RestSubscription = RestSubscriptionBase & {
+    connection_id: string;
+    customer: RestSubscriptionCustomer;
+};
+/** @deprecated Use RestSubscription instead */
+type RestActiveSubscription = RestSubscription;
+/** @deprecated Use RestSubscriptionPlan instead */
+type RestSubscriptionPlanDetails = RestSubscriptionPlan;
+type RestMeterTier = {
+    start: number;
+    rate: string;
+    type: 'tokens_1m' | 'characters_1m' | 'minutes' | 'requests';
+};
+type RestMeter = {
+    meter_id: string;
+    meter_slug: string;
+    name: string;
+    rate_type: 'fixed' | 'percentage';
+    token_basis: 'input+output' | 'output';
+    base_cost_payer: 'merchant' | 'wallet';
+    service_charge_payer: 'merchant' | 'wallet';
+    tiers: RestMeterTier[];
+    created_at: string;
+};
+type RestCreditBundle = {
+    credit_bundle_id: string;
     subscription_config_id: string;
-    started_at: string;
-    billing_anchor: number;
-    cancelled_at?: string;
-    scheduled_cancellation_at: string | null;
-    status: 'active' | 'cancelled';
+    name: string;
+    cost: string;
+    credit_amount: string;
     created_at: string;
-    subscription_config: RestSubscriptionConfig;
-    wallet: {
-        wallet_id: string;
-        phone: string;
-        email?: string;
-        first_name?: string;
-        last_name?: string;
-        active_balance: string;
-        created_at: string;
-    };
 };
 
 /** biome-ignore-all lint/style/noNamespace: package uses namespace */
@@ -249,18 +285,6 @@ declare namespace Resources {
          * @returns Created checkout session
          */
         create(params: CreateCheckoutSessionParams): Promise<RestCheckoutSession>;
-        /**
-         * List checkout sessions
-         * @param params List parameters
-         * @returns Paginated list of checkout sessions
-         */
-        list(params?: CheckoutSessionsListParams): Promise<ListResponse<RestCheckoutSession>>;
-        /**
-         * Retrieve a checkout session
-         * @param checkoutSessionId Checkout session ID
-         * @returns Checkout session details
-         */
-        retrieve(checkoutSessionId: string): Promise<RestCheckoutSession>;
     }
     /**
      * Connection related endpoints
@@ -284,7 +308,7 @@ declare namespace Resources {
          * @param connectionId Connection ID
          * @returns Subscription details or null if no active subscription
          */
-        getSubscription(connectionId: string): Promise<RestConnectionSubscription>;
+        getSubscription(connectionId: string): Promise<RestConnectionSubscriptionResponse>;
         /**
          * Delete a connection
          * @param connectionId Connection ID
@@ -328,44 +352,80 @@ declare namespace Resources {
          */
         retrieve(params: UsageParams): Promise<RestUsage>;
     }
-    export class SubscriptionsResource extends BaseResource {
+    /**
+     * Meter related endpoints
+     */
+    export class MetersResource extends BaseResource {
         /**
-         * List subscription configurations
-         * @returns List of subscription configurations
+         * List meters
+         * @param params Optional pagination parameters
+         * @returns Paginated list of meters
+         */
+        list(params?: {
+            cursor?: string;
+            limit?: number;
+        }): Promise<ListResponse<RestMeter>>;
+        /**
+         * Retrieve a meter
+         * @param id Meter ID
+         * @returns Meter details
          */
-        listConfigs(): Promise<RestSubscriptionConfig[]>;
+        retrieve(id: string): Promise<RestMeter>;
+    }
+    /**
+     * Credit bundle related endpoints
+     */
+    export class CreditBundlesResource extends BaseResource {
         /**
-         * Create a subscription configuration
-         * @param params Subscription configuration parameters
-         * @returns Created subscription configuration
+         * List credit bundles
+         * @param params Optional filter and pagination parameters
+         * @returns Paginated list of credit bundles
          */
-        createConfig(params: CreateSubscriptionConfigParams): Promise<RestSubscriptionConfig>;
+        list(params?: {
+            subscription_config_id?: string;
+            cursor?: string;
+            limit?: number;
+        }): Promise<ListResponse<RestCreditBundle>>;
         /**
-         * Update a subscription configuration
-         * @param id Subscription configuration ID
-         * @param params Update parameters
-         * @returns Updated subscription configuration
+         * Retrieve a credit bundle
+         * @param id Credit bundle ID
+         * @returns Credit bundle details
+         */
+        retrieve(id: string): Promise<RestCreditBundle>;
+    }
+    export class SubscriptionsResource extends BaseResource {
+        /**
+         * List subscription configurations
+         * @param params Optional pagination parameters
+         * @returns Paginated list of subscription configurations
          */
-        updateConfig(id: string, params: UpdateSubscriptionConfigParams): Promise<RestSubscriptionConfig>;
+        listConfigs(params?: {
+            cursor?: string;
+            limit?: number;
+        }): Promise<ListResponse<RestSubscriptionConfig>>;
         /**
-         * Delete a subscription configuration
+         * Retrieve a subscription configuration
          * @param id Subscription configuration ID
-         * @returns Success response
+         * @returns Subscription configuration details
          */
-        deleteConfig(id: string): Promise<{
-            success: boolean;
-        }>;
+        retrieveConfig(id: string): Promise<RestSubscriptionConfig>;
         /**
-         * List active subscriptions for a merchant
-         * @returns List of active subscriptions
+         * List subscriptions for a merchant
+         * @param params Optional filter and pagination parameters
+         * @returns Paginated list of subscriptions
          */
-        listActiveSubscriptions(): Promise<RestActiveSubscription[]>;
+        list(params?: {
+            status?: 'active' | 'cancelled' | 'all';
+            connection_id?: string;
+            cursor?: string;
+            limit?: number;
+        }): Promise<ListResponse<RestSubscription>>;
         /**
-         * Cancel an active subscription
-         * @param id Active subscription ID
+         * Cancel a subscription
+         * @param id Subscription ID
          * @returns Success response
          */
-        cancelActiveSubscription(id: string): Promise<{
+        cancel(id: string): Promise<{
             success: boolean;
         }>;
     }
@@ -382,12 +442,12 @@ interface Config {
     baseUrl?: string;
 }
 type ForwardTokenOptions = {
-    connection_secret: string;
-    product_secret: string;
+    connection_id: string;
+    meter_slug: string;
     provider_key?: string;
 } | {
-    connection_secret: null;
-    product_secret: null;
+    connection_id: null;
+    meter_slug: null;
     provider_key: string;
 };
 declare class Lava {
@@ -414,6 +474,14 @@ declare class Lava {
      * The subscriptions resource
      */
     readonly subscriptions: Resources.SubscriptionsResource;
+    /**
+     * The meters resource
+     */
+    readonly meters: Resources.MetersResource;
+    /**
+     * The credit bundles resource
+     */
+    readonly creditBundles: Resources.CreditBundlesResource;
     /**
      * Provider URLs for convenience
      */
@@ -471,4 +539,4 @@ declare class Lava {
     generateForwardToken(options: ForwardTokenOptions): string;
 }
 
-export { type ApiVersion, type CheckoutSessionsListParams, type Config, type ConnectionsListParams, type CreateCheckoutSessionParams, type CreateRequestParams, type CreateSubscriptionConfigParams, type ForwardTokenOptions, Lava, type ListResponse, type RequestsListParams, type RequestsListResponse, Resources, type RestActiveSubscription, type RestCheckoutSession, type RestConnection, type RestConnectionSubscription, type RestConnectionSubscriptionCredits, type RestConnectionSubscriptionDetails, type RestConnectionSubscriptionPendingChange, type RestRequest, type RestSubscriptionConfig, type RestUsage, type UpdateSubscriptionConfigParams, type UsageParams };
+export { type ApiVersion, type Config, type ConnectionsListParams, type CreateCheckoutSessionParams, type CreateRequestParams, type ForwardTokenOptions, Lava, type ListResponse, type RequestsListParams, type RequestsListResponse, Resources, type RestActiveSubscription, type RestCheckoutSession, type RestConnection, type RestConnectionCustomer, type RestConnectionSubscription, type RestConnectionSubscriptionResponse, type RestCreditBundle, type RestMeter, type RestMeterTier, type RestPendingChange, type RestRequest, type RestSubscription, type RestSubscriptionBase, type RestSubscriptionConfig, type RestSubscriptionConfigCreditBundle, type RestSubscriptionConfigLinkedMeter, type RestSubscriptionCredits, type RestSubscriptionCustomer, type RestSubscriptionPlan, type RestSubscriptionPlanDetails, type RestUsage, type UsageParams };