@lumnsh/node 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,448 @@
+interface PaginationParams {
+    cursor?: string;
+    limit?: number;
+}
+interface PaginatedList<T> {
+    data: T[];
+    hasMore: boolean;
+    cursor: string | null;
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+}
+interface LumnApiErrorBody {
+    code: string;
+    message: string;
+    suggestion?: string;
+    details?: Record<string, unknown>;
+}
+
+declare abstract class ApiResource {
+    protected readonly _client: Lumn;
+    constructor(_client: Lumn);
+    protected get<T>(path: string, query?: Record<string, string | number | boolean | undefined>): Promise<T>;
+    protected post<T>(path: string, body?: unknown): Promise<T>;
+    protected del<T>(path: string, query?: Record<string, string | number | boolean | undefined>): Promise<T>;
+    protected _list<T>(path: string, params?: object): Promise<PaginatedList<T>>;
+}
+
+interface Customer {
+    id: string;
+    projectId: string;
+    environment: 'development' | 'production';
+    externalId: string;
+    email: string | null;
+    name: string | null;
+    providerCustomerId: string | null;
+    connectionId: string | null;
+    lastSyncedAt: string | null;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CustomerCreateParams {
+    external_id: string;
+    email?: string;
+    name?: string;
+}
+interface CustomerListParams extends PaginationParams {
+    search?: string;
+}
+
+declare class Customers extends ApiResource {
+    create(params: CustomerCreateParams): Promise<Customer>;
+    list(params?: CustomerListParams): Promise<PaginatedList<Customer>>;
+}
+
+interface ProductPricing {
+    monthly?: {
+        amount: number;
+        currency: string;
+        discount?: number;
+    };
+    quarterly?: {
+        amount: number;
+        currency: string;
+        discount?: number;
+    };
+    yearly?: {
+        amount: number;
+        currency: string;
+        discount?: number;
+    };
+    trial?: {
+        days: number;
+    };
+}
+interface Product {
+    id: string;
+    projectId: string;
+    environment: 'development' | 'production';
+    name: string;
+    slug: string;
+    description: string | null;
+    active: boolean;
+    pricing: ProductPricing | null;
+    providerProductId: string | null;
+    providerPriceIds: Record<string, string> | null;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ProductCreateParams {
+    slug: string;
+    name: string;
+    description?: string;
+    pricing?: ProductPricing;
+    active?: boolean;
+    metadata?: Record<string, unknown>;
+}
+type ProductListParams = PaginationParams;
+
+declare class Products extends ApiResource {
+    create(params: ProductCreateParams): Promise<Product>;
+    list(params?: ProductListParams): Promise<PaginatedList<Product>>;
+}
+
+type FeatureType = 'boolean' | 'limit' | 'metered';
+interface Feature {
+    id: string;
+    projectId: string;
+    environment: 'development' | 'production';
+    key: string;
+    name: string;
+    description: string | null;
+    type: FeatureType;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface FeatureCreateParams {
+    key: string;
+    name: string;
+    description?: string;
+    type: FeatureType;
+}
+type FeatureListParams = PaginationParams;
+
+declare class Features extends ApiResource {
+    create(params: FeatureCreateParams): Promise<Feature>;
+    list(params?: FeatureListParams): Promise<PaginatedList<Feature>>;
+}
+
+interface EntitlementCheck {
+    entitled: boolean;
+    feature_key: string;
+    reason?: string;
+    feature_type?: FeatureType;
+    limit?: number | null;
+    unit_price_cents?: number | null;
+}
+interface EntitlementCheckParams {
+    customer_id: string;
+    feature_key: string;
+}
+
+declare class Entitlements extends ApiResource {
+    check(params: EntitlementCheckParams): Promise<EntitlementCheck>;
+}
+
+type PaymentStatus = 'pending' | 'processing' | 'succeeded' | 'failed' | 'canceled' | 'refunded';
+interface Payment {
+    id: string;
+    projectId: string;
+    customerId: string | null;
+    subscriptionId: string | null;
+    providerPaymentId: string | null;
+    providerInvoiceId: string | null;
+    amount: number;
+    currency: string;
+    amountRefunded: number;
+    status: PaymentStatus;
+    failureCode: string | null;
+    failureMessage: string | null;
+    idempotencyKey: string | null;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    succeededAt: string | null;
+    failedAt: string | null;
+}
+interface PaymentListParams extends PaginationParams {
+    customer_id?: string;
+    status?: PaymentStatus;
+    from?: string;
+    to?: string;
+}
+
+declare class Payments extends ApiResource {
+    list(params?: PaymentListParams): Promise<PaginatedList<Payment>>;
+}
+
+type SubscriptionStatus = 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'paused' | 'trialing' | 'unpaid';
+interface Subscription {
+    id: string;
+    projectId: string;
+    customerId: string;
+    providerSubscriptionId: string | null;
+    providerCustomerId: string | null;
+    status: SubscriptionStatus;
+    currentPeriodStart: string | null;
+    currentPeriodEnd: string | null;
+    cancelAtPeriodEnd: boolean;
+    canceledAt: string | null;
+    trialEnd: string | null;
+    syncedData: Record<string, unknown> | null;
+    lastSyncedAt: string | null;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SubscriptionListParams extends PaginationParams {
+    customer_id?: string;
+    status?: SubscriptionStatus;
+}
+
+declare class Subscriptions extends ApiResource {
+    list(params?: SubscriptionListParams): Promise<PaginatedList<Subscription>>;
+}
+
+type EventStatus = 'pending' | 'processing' | 'processed' | 'failed' | 'skipped';
+interface LumnEvent {
+    id: string;
+    providerEventId: string;
+    eventType: string;
+    objectType: string | null;
+    objectId: string | null;
+    status: EventStatus;
+    retryCount: number;
+    processingError: string | null;
+    processedAt: string | null;
+    createdAt: string;
+}
+interface EventListParams extends PaginationParams {
+    type?: string;
+    status?: EventStatus;
+    from?: string;
+    to?: string;
+}
+
+declare class Events extends ApiResource {
+    list(params?: EventListParams): Promise<PaginatedList<LumnEvent>>;
+}
+
+interface MeterEvent {
+    id: string;
+    customer_id: string;
+    feature_key: string;
+    value: number;
+    idempotency_key: string;
+    cached: boolean;
+    timestamp: string;
+    created_at: string;
+}
+interface MeterRecordParams {
+    customer_id: string;
+    feature_key: string;
+    value?: number;
+    idempotency_key: string;
+    timestamp?: string;
+    properties?: Record<string, unknown>;
+}
+
+declare class Meter extends ApiResource {
+    record(params: MeterRecordParams): Promise<MeterEvent>;
+}
+
+interface SyncResult {
+    customer_id: string;
+    status: 'completed';
+    synced_at: string;
+    changes: {
+        subscriptions: number;
+        payments: number;
+    };
+}
+interface SyncTriggerParams {
+    customer_id: string;
+}
+
+declare class Sync extends ApiResource {
+    trigger(params: SyncTriggerParams): Promise<SyncResult>;
+}
+
+type Provider = 'stripe' | 'paypal' | 'paddle' | 'airwallex' | 'lemonsqueezy' | 'polar';
+interface ConnectionCapabilities {
+    payments: boolean;
+    subscriptions: boolean;
+    invoices: boolean;
+    usageBilling: boolean;
+}
+interface Connection {
+    id: string;
+    provider: Provider;
+    environment: 'development' | 'staging' | 'production';
+    status: 'pending' | 'active' | 'error' | 'disconnected';
+    capabilities: ConnectionCapabilities | null;
+    lastHealthCheck: string | null;
+    healthCheckError: string | null;
+    createdAt: string;
+}
+interface ConnectionCreateParams {
+    provider: Provider;
+    api_key: string;
+    publishable_key?: string;
+    webhook_secret?: string;
+    environment?: 'development' | 'staging' | 'production';
+}
+
+declare class Connections extends ApiResource {
+    create(params: ConnectionCreateParams): Promise<Connection>;
+    list(): Promise<Connection[]>;
+}
+
+interface ApiKey {
+    id: string;
+    name: string;
+    environment: 'development' | 'staging' | 'production';
+    keyPrefix: string;
+    scopes: string[] | null;
+    lastUsedAt: string | null;
+    expiresAt: string | null;
+    createdAt: string;
+}
+interface ApiKeyWithSecret extends ApiKey {
+    key: string;
+}
+interface ApiKeyCreateParams {
+    name: string;
+    environment?: 'development' | 'staging' | 'production';
+    scopes?: string[];
+    expires_in_days?: number;
+}
+
+declare class ApiKeys extends ApiResource {
+    create(params: ApiKeyCreateParams): Promise<ApiKeyWithSecret>;
+    list(): Promise<ApiKey[]>;
+    revoke(id: string): Promise<{
+        id: string;
+        revoked: boolean;
+    }>;
+}
+
+interface CopyConfigParams {
+    from: 'development' | 'production';
+    to: 'development' | 'production';
+}
+interface CopyConfigResult {
+    products_copied: number;
+    features_copied: number;
+    product_features_copied: number;
+}
+
+declare class CopyConfig extends ApiResource {
+    copy(params: CopyConfigParams): Promise<CopyConfigResult>;
+}
+
+interface CheckoutSession {
+    checkout_url: string;
+    session_id: string;
+    publishable_key: string | null;
+}
+interface CheckoutCreateParams {
+    customer_id: string;
+    product_slug: string;
+    price_interval: 'monthly' | 'quarterly' | 'yearly';
+    success_url: string;
+    cancel_url: string;
+}
+
+declare class Checkout extends ApiResource {
+    create(params: CheckoutCreateParams): Promise<CheckoutSession>;
+}
+
+interface LumnConfig {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+    fetch?: typeof globalThis.fetch;
+}
+declare class Lumn {
+    private readonly _apiKey;
+    private readonly _baseUrl;
+    private readonly _timeout;
+    private readonly _maxRetries;
+    private readonly _fetch;
+    readonly customers: Customers;
+    readonly products: Products;
+    readonly features: Features;
+    readonly entitlements: Entitlements;
+    readonly payments: Payments;
+    readonly subscriptions: Subscriptions;
+    readonly events: Events;
+    readonly meter: Meter;
+    readonly sync: Sync;
+    readonly connections: Connections;
+    readonly apiKeys: ApiKeys;
+    readonly copyConfig: CopyConfig;
+    readonly checkout: Checkout;
+    constructor(config: string | LumnConfig | undefined);
+    /** @internal */
+    _request<T>(method: string, path: string, body?: unknown, query?: Record<string, string | number | boolean | undefined>): Promise<T>;
+    private _buildUrl;
+    private _throwTypedError;
+    private _sleep;
+}
+
+declare class LumnError extends Error {
+    constructor(message: string);
+}
+declare class LumnApiError extends LumnError {
+    readonly status: number;
+    readonly code: string;
+    readonly suggestion?: string;
+    readonly details?: Record<string, unknown>;
+    constructor(status: number, body: {
+        code: string;
+        message: string;
+        suggestion?: string;
+        details?: Record<string, unknown>;
+    });
+}
+declare class LumnAuthenticationError extends LumnApiError {
+    constructor(body: {
+        code: string;
+        message: string;
+        suggestion?: string;
+    });
+}
+declare class LumnValidationError extends LumnApiError {
+    constructor(body: {
+        code: string;
+        message: string;
+        suggestion?: string;
+    });
+}
+declare class LumnNotFoundError extends LumnApiError {
+    constructor(body: {
+        code: string;
+        message: string;
+        suggestion?: string;
+    });
+}
+declare class LumnRateLimitError extends LumnApiError {
+    readonly retryAfter: number | null;
+    constructor(body: {
+        code: string;
+        message: string;
+    }, retryAfter: number | null);
+}
+declare class LumnConnectionError extends LumnError {
+    readonly cause?: Error | undefined;
+    constructor(message: string, cause?: Error | undefined);
+}
+declare class LumnTimeoutError extends LumnError {
+    constructor(timeoutMs: number);
+}
+
+declare const SDK_VERSION = "0.1.0";
+
+export { type ApiKey, type ApiKeyCreateParams, type ApiKeyWithSecret, type CheckoutCreateParams, type CheckoutSession, type Connection, type ConnectionCapabilities, type ConnectionCreateParams, type CopyConfigParams, type CopyConfigResult, type Customer, type CustomerCreateParams, type CustomerListParams, type EntitlementCheck, type EntitlementCheckParams, type EventListParams, type EventStatus, type Feature, type FeatureCreateParams, type FeatureListParams, type FeatureType, Lumn, LumnApiError, type LumnApiErrorBody, LumnAuthenticationError, type LumnConfig, LumnConnectionError, LumnError, type LumnEvent, LumnNotFoundError, LumnRateLimitError, LumnTimeoutError, LumnValidationError, type MeterEvent, type MeterRecordParams, type PaginatedList, type PaginationParams, type Payment, type PaymentListParams, type PaymentStatus, type Product, type ProductCreateParams, type ProductListParams, type ProductPricing, type Provider, SDK_VERSION, type Subscription, type SubscriptionListParams, type SubscriptionStatus, type SyncResult, type SyncTriggerParams, Lumn as default };