autumn-js 0.0.67 → 0.0.72

package/dist/sdk/index.d.ts

@@ -1,17 +1,3 @@
-import { AttachParams, AttachResult, UsageParams, UsageResult, CancelParams, CancelResult, CheckParams, CheckResult, TrackParams, TrackResult } from './general.js';
-export { AttachFeatureOptions, EntitledBalance } from './general.js';
-import { Logger } from 'pino';
-import { Product, CreateProductParams, ListProductsParams } from './products.js';
-export { FreeTrial, PriceTier, ProductItem } from './products.js';
-import { G as GetCustomerParams, C as Customer, a as CreateCustomerParams, U as UpdateCustomerParams, B as BillingPortalParams, b as BillingPortalResponse } from './cusTypes-BTV6ui4e.js';
-export { e as CustomerData, g as CustomerExpandOption, c as CustomerFeature, f as CustomerInvoice, d as CustomerProduct, P as ProductStatus } from './cusTypes-BTV6ui4e.js';
-import { G as GetEntityParams, E as Entity, C as CreateEntityParams, a as CreateEntityResult, D as DeleteEntityResult } from './entTypes-BwLV9Jn4.js';
-export { b as EntityData, c as EntityExpandOption } from './entTypes-BwLV9Jn4.js';
-import { CreateReferralCodeParams, RedeemReferralCodeParams } from './referrals.js';
-export { CreateReferralCodeResult, RedeemReferralCodeResult } from './referrals.js';
-export { CheckFeaturePreview, CheckFeatureScenario, CheckProductPreview, CheckProductScenario } from './check.js';
-export { A as AppEnv, F as FreeTrialDuration, I as Infinite, P as ProductItemInterval, b as ProductItemIntervalType, U as UsageModel, a as UsageModelType } from './prodEnums-C1lccCWI.js';
-
 interface ErrorResponse {
     message: string;
     code: string;
@@ -28,6 +14,366 @@ declare class AutumnError extends Error {
     };
 }
 
+declare enum AppEnv {
+    Sandbox = "sandbox",
+    Live = "live"
+}
+
+declare const Infinite = "inf";
+declare enum FreeTrialDuration {
+    Day = "day"
+}
+declare enum UsageModel {
+    Prepaid = "prepaid",
+    PayPerUse = "pay_per_use"
+}
+type UsageModelType = "prepaid" | "pay_per_use";
+declare enum ProductItemInterval {
+    Minute = "minute",
+    Hour = "hour",
+    Day = "day",
+    Week = "week",
+    Month = "month",
+    Quarter = "quarter",
+    SemiAnnual = "semi_annual",
+    Year = "year",
+    Multiple = "multiple"
+}
+type ProductItemIntervalType = "minute" | "hour" | "day" | "week" | "month" | "quarter" | "semi_annual" | "year" | "multiple";
+
+declare enum ProductStatus {
+    Active = "active",
+    Expired = "expired",
+    Trialing = "trialing",
+    Scheduled = "scheduled",
+    PastDue = "past_due"
+}
+type CustomerExpandOption = "invoices" | "rewards" | "trials_used" | "entities";
+
+interface CoreCustomerFeature {
+    unlimited?: boolean;
+    interval?: ProductItemInterval | null;
+    balance?: number;
+    usage?: number;
+    included_usage?: number;
+    next_reset_at?: number | null;
+    overage_allowed?: boolean;
+    breakdown?: {
+        interval: ProductItemInterval;
+        balance?: number;
+        usage?: number;
+        included_usage?: number;
+        next_reset_at?: number;
+    }[];
+    credit_schema?: {
+        feature_id: string;
+        credit_amount: number;
+    }[];
+}
+interface CustomerFeature extends CoreCustomerFeature {
+    id: string;
+    name: string;
+    type: "static" | "single_use" | "continuous_use";
+}
+interface CustomerProduct {
+    id: string;
+    name: string | null;
+    group: string | null;
+    status: ProductStatus;
+    started_at: number;
+    canceled_at: number | null;
+    subscription_ids?: string[] | null;
+    current_period_start?: number | null;
+    current_period_end?: number | null;
+    trial_ends_at?: number;
+    entity_id?: string;
+    is_add_on: boolean;
+    is_default: boolean;
+}
+interface Customer {
+    id: string | null;
+    created_at: number;
+    name: string | null;
+    email: string | null;
+    fingerprint: string | null;
+    stripe_id: string | null;
+    env: AppEnv;
+    metadata: Record<string, any>;
+    products: CustomerProduct[];
+    features: Record<string, CustomerFeature>;
+    invoices?: CustomerInvoice[];
+}
+interface CustomerData {
+    name?: string;
+    email?: string;
+    fingerprint?: string;
+}
+interface GetCustomerParams {
+    expand?: CustomerExpandOption[];
+}
+interface CreateCustomerParams {
+    id?: string | null;
+    email?: string | null;
+    name?: string | null;
+    fingerprint?: string | null;
+    metadata?: Record<string, any>;
+    expand?: CustomerExpandOption[];
+}
+interface UpdateCustomerParams {
+    id?: string | null;
+    name?: string | null;
+    email?: string | null;
+    fingerprint?: string | null;
+}
+interface BillingPortalParams {
+    return_url?: string;
+}
+interface BillingPortalResult {
+    customer_id: string;
+    url: string;
+}
+interface CustomerInvoice {
+    product_ids: string[];
+    stripe_id: string;
+    status: string;
+    total: number;
+    currency: string;
+    created_at: number;
+}
+
+type EntityExpandOption = "invoices";
+
+interface CreateEntityParams {
+    id: string;
+    name: string;
+    feature_id: string;
+    customer_data?: CustomerData;
+}
+interface CreateEntityResult {
+    success: boolean;
+}
+interface DeleteEntityResult {
+    success: boolean;
+}
+interface GetEntityParams {
+    expand?: EntityExpandOption[];
+}
+interface Entity {
+    id: string;
+    name: string;
+    customer_id: string;
+    created_at: number;
+    env: string;
+    products: CustomerProduct[];
+    features: Record<string, CustomerFeature>;
+    invoices?: CustomerInvoice[];
+}
+interface EntityData {
+    name?: string;
+    feature_id: string;
+}
+
+interface PriceTier {
+    to: number;
+    amount: number | "inf";
+}
+interface ProductItem {
+    feature_id?: string;
+    included_usage?: number | typeof Infinite;
+    interval?: ProductItemIntervalType;
+    usage_model?: UsageModel;
+    price?: number;
+    billing_units?: number;
+    entity_feature_id?: string;
+    reset_usage_on_billing?: boolean;
+    reset_usage_when_enabled?: boolean;
+    display?: {
+        primary_text?: string;
+        secondary_text?: string;
+    };
+}
+interface FreeTrial {
+    duration: FreeTrialDuration;
+    length: number;
+    unique_fingerprint: boolean;
+    trial_available?: boolean;
+}
+interface Product {
+    id: string;
+    created_at: number;
+    name: string;
+    env: AppEnv;
+    is_add_on: boolean;
+    is_default: boolean;
+    group: string;
+    version: number;
+    items: ProductItem[];
+    free_trial: FreeTrial | null;
+    scenario?: ProductScenario;
+    properties?: {
+        is_free?: boolean;
+        is_one_off?: boolean;
+        interval_group?: string;
+    };
+    display?: {
+        description?: string;
+        button_text?: string;
+        recommend_text?: string;
+        everything_from?: string;
+        button_url?: string;
+    };
+}
+interface CreateProductParams {
+    id: string;
+    name?: string;
+    is_add_on?: boolean;
+    is_default?: boolean;
+    items?: ProductItem[];
+    free_trial?: FreeTrial;
+}
+interface ListProductsParams {
+    customer_id?: string;
+}
+
+type CheckFeatureScenario = "usage_limit" | "feature_flag";
+interface CheckFeatureResult extends CoreCustomerFeature {
+    allowed: boolean;
+    feature_id: string;
+    customer_id: string;
+    entity_id?: string;
+    required_balance: number;
+    code: string;
+    preview?: CheckFeaturePreview;
+}
+interface CheckFeaturePreview {
+    scenario: CheckFeatureScenario;
+    title: string;
+    message: string;
+    feature_id: string;
+    feature_name: string;
+    products: Product[];
+}
+type ProductScenario = "scheduled" | "active" | "new" | "renew" | "upgrade" | "downgrade" | "cancel";
+interface CheckProductResult {
+    allowed: boolean;
+    customer_id: string;
+    product_id: string;
+    code: string;
+    status?: string;
+    preview?: CheckProductPreview;
+}
+interface CheckProductPreview {
+    scenario: ProductScenario;
+    product_id: string;
+    product_name: string;
+    recurring: boolean;
+    error_on_attach?: boolean;
+    next_cycle_at?: number;
+    current_product_name?: string;
+    items?: {
+        price: string;
+        description: string;
+        usage_model?: UsageModelType;
+    }[];
+    options?: {
+        feature_id: string;
+        feature_name: string;
+        billing_units: number;
+        price?: number;
+        tiers?: {
+            to: number | string;
+            amount: number;
+        }[];
+    }[];
+    due_today?: {
+        price: number;
+        currency: string;
+    };
+    due_next_cycle?: {
+        price: number;
+        currency: string;
+    };
+}
+
+interface AttachFeatureOptions {
+    feature_id: string;
+    quantity: number;
+}
+interface AttachParams {
+    customer_id: string;
+    product_id?: string;
+    entity_id?: string;
+    options?: AttachFeatureOptions[];
+    product_ids?: string[];
+    free_trial?: boolean;
+    success_url?: string;
+    metadata?: Record<string, string>;
+    force_checkout?: boolean;
+    customer_data?: CustomerData;
+    entity_data?: EntityData;
+    checkout_session_params?: Record<string, any>;
+    reward?: string;
+}
+interface CancelParams {
+    customer_id: string;
+    product_id: string;
+    entity_id?: string;
+    cancel_immediately?: boolean;
+}
+interface CancelResult {
+    success: boolean;
+    customer_id: string;
+    product_id: string;
+}
+interface AttachResult {
+    checkout_url?: string;
+    customer_id: string;
+    product_ids: string[];
+    code: string;
+    message: string;
+    customer_data?: CustomerData;
+}
+interface TrackParams {
+    customer_id: string;
+    value?: number;
+    feature_id?: string;
+    event_name?: string;
+    entity_id?: string;
+    customer_data?: CustomerData;
+    idempotency_key?: string;
+    entity_data?: EntityData;
+}
+interface TrackResult {
+    id: string;
+    code: string;
+    customer_id: string;
+    feature_id?: string;
+    event_name?: string;
+}
+interface CheckParams {
+    customer_id: string;
+    feature_id?: string;
+    product_id?: string;
+    entity_id?: string;
+    customer_data?: CustomerData;
+    required_balance?: number;
+    send_event?: boolean;
+    with_preview?: boolean;
+    entity_data?: EntityData;
+}
+type CheckResult = CheckFeatureResult & CheckProductResult;
+interface UsageParams {
+    customer_id: string;
+    feature_id: string;
+    value: number;
+    customer_data?: CustomerData;
+}
+interface UsageResult {
+    code: string;
+    customer_id: string;
+    feature_id: string;
+}
+
 type Success<T> = {
     data: T;
     error: null;
@@ -40,7 +386,7 @@ type Failure<E> = {
 };
 declare const toContainerResult: ({ response, logger }: {
     response: Response;
-    logger: Logger | Console;
+    logger: Console;
 }) => Promise<Result<any, AutumnError>>;
 type Result<T, E> = Success<T> | Failure<E>;
 type AutumnPromise<T> = Promise<Result<T, AutumnError>>;
@@ -72,7 +418,9 @@ declare class Autumn {
     static products: {
         get: (id: string) => Promise<Result<Product, AutumnError>>;
         create: (params?: CreateProductParams) => Promise<Result<Product, AutumnError>>;
-        list: (params?: ListProductsParams) => Promise<Result<Product[], AutumnError>>;
+        list: (params?: ListProductsParams) => Promise<Result<{
+            list: Product[];
+        }, AutumnError>>;
     };
     static entities: {
         get: (customer_id: string, entity_id: string, params?: GetEntityParams) => Promise<Result<Entity, AutumnError>>;
@@ -93,7 +441,9 @@ declare class Autumn {
     products: {
         get: (id: string) => Promise<Result<Product, AutumnError>>;
         create: (params?: CreateProductParams) => Promise<Result<Product, AutumnError>>;
-        list: (params?: ListProductsParams) => Promise<Result<Product[], AutumnError>>;
+        list: (params?: ListProductsParams) => Promise<Result<{
+            list: Product[];
+        }, AutumnError>>;
     };
     entities: {
         get: (customer_id: string, entity_id: string, params?: GetEntityParams) => Promise<Result<Entity, AutumnError>>;
@@ -142,15 +492,19 @@ interface GetPricingTableParams {
 interface PricingTableProduct {
     id: string;
     name: string;
-    buttonText: string;
+    description?: string;
+    button_text?: string;
+    recommend_text?: string;
+    everything_from?: string;
     price: {
-        primaryText: string;
-        secondaryText?: string;
-    };
-    items: {
-        primaryText: string;
-        secondaryText?: string;
-    }[];
+        primary_text: string;
+        secondary_text?: string;
+    } & ProductItem;
+    items: ({
+        primary_text: string;
+        secondary_text?: string;
+    } & ProductItem)[];
+    scenario: ProductScenario;
 }
 
 declare const fetchPricingTable: ({ instance, params, }: {
@@ -158,4 +512,24 @@ declare const fetchPricingTable: ({ instance, params, }: {
     params?: GetPricingTableParams;
 }) => AutumnPromise<PricingTableProduct[]>;
 
-export { AttachParams, AttachResult, Autumn, AutumnError, type AutumnPromise, BillingPortalParams, BillingPortalResponse, CancelParams, CancelResult, CheckParams, CheckResult, CreateCustomerParams, CreateEntityParams, CreateEntityResult, CreateProductParams, CreateReferralCodeParams, Customer, DeleteEntityResult, Entity, type ErrorResponse, GetCustomerParams, GetEntityParams, type GetPricingTableParams, ListProductsParams, type PricingTableProduct, Product, RedeemReferralCodeParams, TrackParams, TrackResult, UpdateCustomerParams, UsageParams, UsageResult, fetchPricingTable, toContainerResult };
+interface CreateReferralCodeParams {
+    customer_id: string;
+    program_id: string;
+}
+interface CreateReferralCodeResult {
+    code: string;
+    customer_id: string;
+    created_at: number;
+}
+interface RedeemReferralCodeParams {
+    code: string;
+    customer_id: string;
+}
+interface RedeemReferralCodeResult {
+    id: string;
+    customer_id: string;
+    reward_id: string;
+    applied: boolean;
+}
+
+export { AppEnv, type AttachFeatureOptions, type AttachParams, type AttachResult, Autumn, AutumnError, type AutumnPromise, type BillingPortalParams, type BillingPortalResult, type CancelParams, type CancelResult, type CheckFeaturePreview, type CheckFeatureResult, type CheckFeatureScenario, type CheckParams, type CheckProductPreview, type CheckProductResult, type CheckResult, type CoreCustomerFeature, type CreateCustomerParams, type CreateEntityParams, type CreateEntityResult, type CreateProductParams, type CreateReferralCodeParams, type CreateReferralCodeResult, type Customer, type CustomerData, type CustomerExpandOption, type CustomerFeature, type CustomerInvoice, type CustomerProduct, type DeleteEntityResult, type Entity, type EntityData, type EntityExpandOption, type ErrorResponse, type FreeTrial, FreeTrialDuration, type GetCustomerParams, type GetEntityParams, type GetPricingTableParams, Infinite, type ListProductsParams, type PriceTier, type PricingTableProduct, type Product, type ProductItem, ProductItemInterval, type ProductItemIntervalType, type ProductScenario, ProductStatus, type RedeemReferralCodeParams, type RedeemReferralCodeResult, type TrackParams, type TrackResult, type UpdateCustomerParams, UsageModel, type UsageModelType, type UsageParams, type UsageResult, fetchPricingTable, toContainerResult };

package/dist/sdk/index.js

@@ -207,7 +207,7 @@ var listProducts = async ({
   instance,
   params
 }) => {
-  let path = "/products";
+  let path = "/products_beta";
   if (params) {
     const queryParams = new URLSearchParams();
     for (const [key, value] of Object.entries(params)) {

package/dist/sdk/index.mjs

@@ -201,7 +201,7 @@ var listProducts = async ({
   instance,
   params
 }) => {
-  let path = "/products";
+  let path = "/products_beta";
   if (params) {
     const queryParams = new URLSearchParams();
     for (const [key, value] of Object.entries(params)) {