autumn-js 0.0.102 → 0.0.104

package/dist/sdk/index.d.mts

@@ -108,10 +108,17 @@ interface PriceTier {
     to: number;
     amount: number | "inf";
 }
+interface Feature {
+    id: string;
+    name: string;
+    type: "boolean" | "continuous_use" | "single_use" | "credit_system";
+}
 interface ProductItem {
+    type?: "feature" | "priced_feature" | "price";
     feature_id?: string;
     included_usage?: number | typeof Infinite;
     interval?: ProductItemIntervalType;
+    feature?: Feature;
     usage_model?: UsageModel;
     price?: number;
     billing_units?: number;
@@ -143,10 +150,12 @@ interface Product {
     free_trial: FreeTrial | null;
     scenario?: ProductScenario;
     base_variant_id: string | null;
-    properties?: {
-        is_free?: boolean;
-        is_one_off?: boolean;
-        interval_group?: string;
+    properties: {
+        is_free: boolean;
+        is_one_off: boolean;
+        interval_group: string;
+        has_trial: boolean;
+        has_prepaid: boolean;
     };
     display?: {
         name?: string;
@@ -235,11 +244,20 @@ interface Customer {
     features: Record<string, CustomerFeature>;
     invoices?: CustomerInvoice[];
 }
-interface CustomerData {
-    name?: string;
-    email?: string;
-    fingerprint?: string;
-}
+declare const CustomerDataSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    name?: string | null | undefined;
+    email?: string | null | undefined;
+    fingerprint?: string | null | undefined;
+}, {
+    name?: string | null | undefined;
+    email?: string | null | undefined;
+    fingerprint?: string | null | undefined;
+}>;
+type CustomerData = z.infer<typeof CustomerDataSchema>;
 interface GetCustomerParams {
     expand?: CustomerExpandOption[];
 }
@@ -294,99 +312,6 @@ interface CustomerInvoice {
     hosted_invoice_url: string;
 }
 
-declare const AttachFeatureOptionsSchema: z.ZodObject<{
-    feature_id: z.ZodString;
-    quantity: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    feature_id: string;
-    quantity: number;
-}, {
-    feature_id: string;
-    quantity: number;
-}>;
-type AttachFeatureOptions = z.infer<typeof AttachFeatureOptionsSchema>;
-declare const AttachParamsSchema: z.ZodObject<{
-    customer_id: z.ZodString;
-    product_id: z.ZodOptional<z.ZodString>;
-    entity_id: z.ZodOptional<z.ZodString>;
-    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        feature_id: z.ZodString;
-        quantity: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        feature_id: string;
-        quantity: number;
-    }, {
-        feature_id: string;
-        quantity: number;
-    }>, "many">>;
-    product_ids: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    free_trial: z.ZodOptional<z.ZodBoolean>;
-    success_url: z.ZodOptional<z.ZodString>;
-    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-    force_checkout: z.ZodOptional<z.ZodBoolean>;
-    customer_data: z.ZodOptional<z.ZodAny>;
-    entity_data: z.ZodOptional<z.ZodAny>;
-    checkout_session_params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    reward: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    customer_id: string;
-    entity_id?: string | undefined;
-    options?: {
-        feature_id: string;
-        quantity: number;
-    }[] | undefined;
-    metadata?: Record<string, string> | undefined;
-    product_id?: string | undefined;
-    product_ids?: string[] | undefined;
-    free_trial?: boolean | undefined;
-    success_url?: string | undefined;
-    force_checkout?: boolean | undefined;
-    customer_data?: any;
-    entity_data?: any;
-    checkout_session_params?: Record<string, any> | undefined;
-    reward?: string | undefined;
-}, {
-    customer_id: string;
-    entity_id?: string | undefined;
-    options?: {
-        feature_id: string;
-        quantity: number;
-    }[] | undefined;
-    metadata?: Record<string, string> | undefined;
-    product_id?: string | undefined;
-    product_ids?: string[] | undefined;
-    free_trial?: boolean | undefined;
-    success_url?: string | undefined;
-    force_checkout?: boolean | undefined;
-    customer_data?: any;
-    entity_data?: any;
-    checkout_session_params?: Record<string, any> | undefined;
-    reward?: string | undefined;
-}>;
-type AttachParams = z.infer<typeof AttachParamsSchema>;
-declare const AttachResultSchema: z.ZodObject<{
-    checkout_url: z.ZodOptional<z.ZodString>;
-    customer_id: z.ZodString;
-    product_ids: z.ZodArray<z.ZodString, "many">;
-    code: z.ZodString;
-    message: z.ZodString;
-    customer_data: z.ZodOptional<z.ZodAny>;
-}, "strip", z.ZodTypeAny, {
-    customer_id: string;
-    code: string;
-    message: string;
-    product_ids: string[];
-    customer_data?: any;
-    checkout_url?: string | undefined;
-}, {
-    customer_id: string;
-    code: string;
-    message: string;
-    product_ids: string[];
-    customer_data?: any;
-    checkout_url?: string | undefined;
-}>;
-type AttachResult = z.infer<typeof AttachResultSchema>;
 declare const CancelParamsSchema: z.ZodObject<{
     customer_id: z.ZodString;
     product_id: z.ZodString;
@@ -536,6 +461,197 @@ interface SetupPaymentResult {
     url: string;
 }
 
+declare const AttachFeatureOptionsSchema: z.ZodObject<{
+    feature_id: z.ZodString;
+    quantity: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    feature_id: string;
+    quantity: number;
+}, {
+    feature_id: string;
+    quantity: number;
+}>;
+type AttachFeatureOptions = z.infer<typeof AttachFeatureOptionsSchema>;
+declare const AttachParamsSchema: z.ZodObject<{
+    customer_id: z.ZodString;
+    product_id: z.ZodOptional<z.ZodString>;
+    entity_id: z.ZodOptional<z.ZodString>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        feature_id: z.ZodString;
+        quantity: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        feature_id: string;
+        quantity: number;
+    }, {
+        feature_id: string;
+        quantity: number;
+    }>, "many">>;
+    product_ids: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    free_trial: z.ZodOptional<z.ZodBoolean>;
+    success_url: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    force_checkout: z.ZodOptional<z.ZodBoolean>;
+    customer_data: z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string | null | undefined;
+        email?: string | null | undefined;
+        fingerprint?: string | null | undefined;
+    }, {
+        name?: string | null | undefined;
+        email?: string | null | undefined;
+        fingerprint?: string | null | undefined;
+    }>>;
+    entity_data: z.ZodOptional<z.ZodAny>;
+    checkout_session_params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    reward: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    customer_id: string;
+    entity_id?: string | undefined;
+    options?: {
+        feature_id: string;
+        quantity: number;
+    }[] | undefined;
+    metadata?: Record<string, string> | undefined;
+    product_id?: string | undefined;
+    product_ids?: string[] | undefined;
+    free_trial?: boolean | undefined;
+    success_url?: string | undefined;
+    force_checkout?: boolean | undefined;
+    customer_data?: {
+        name?: string | null | undefined;
+        email?: string | null | undefined;
+        fingerprint?: string | null | undefined;
+    } | undefined;
+    entity_data?: any;
+    checkout_session_params?: Record<string, any> | undefined;
+    reward?: string | undefined;
+}, {
+    customer_id: string;
+    entity_id?: string | undefined;
+    options?: {
+        feature_id: string;
+        quantity: number;
+    }[] | undefined;
+    metadata?: Record<string, string> | undefined;
+    product_id?: string | undefined;
+    product_ids?: string[] | undefined;
+    free_trial?: boolean | undefined;
+    success_url?: string | undefined;
+    force_checkout?: boolean | undefined;
+    customer_data?: {
+        name?: string | null | undefined;
+        email?: string | null | undefined;
+        fingerprint?: string | null | undefined;
+    } | undefined;
+    entity_data?: any;
+    checkout_session_params?: Record<string, any> | undefined;
+    reward?: string | undefined;
+}>;
+type AttachParams = z.infer<typeof AttachParamsSchema>;
+declare const AttachResultSchema: z.ZodObject<{
+    checkout_url: z.ZodOptional<z.ZodString>;
+    customer_id: z.ZodString;
+    product_ids: z.ZodArray<z.ZodString, "many">;
+    code: z.ZodString;
+    message: z.ZodString;
+    customer_data: z.ZodOptional<z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    customer_id: string;
+    code: string;
+    message: string;
+    product_ids: string[];
+    customer_data?: any;
+    checkout_url?: string | undefined;
+}, {
+    customer_id: string;
+    code: string;
+    message: string;
+    product_ids: string[];
+    customer_data?: any;
+    checkout_url?: string | undefined;
+}>;
+type AttachResult = z.infer<typeof AttachResultSchema>;
+declare const CheckoutParamsSchema: z.ZodObject<{
+    customer_id: z.ZodString;
+    product_id: z.ZodString;
+    entity_id: z.ZodOptional<z.ZodString>;
+    success_url: z.ZodOptional<z.ZodString>;
+    customer_data: z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string | null | undefined;
+        email?: string | null | undefined;
+        fingerprint?: string | null | undefined;
+    }, {
+        name?: string | null | undefined;
+        email?: string | null | undefined;
+        fingerprint?: string | null | undefined;
+    }>>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        feature_id: z.ZodString;
+        quantity: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        feature_id: string;
+        quantity: number;
+    }, {
+        feature_id: string;
+        quantity: number;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    customer_id: string;
+    product_id: string;
+    entity_id?: string | undefined;
+    options?: {
+        feature_id: string;
+        quantity: number;
+    }[] | undefined;
+    success_url?: string | undefined;
+    customer_data?: {
+        name?: string | null | undefined;
+        email?: string | null | undefined;
+        fingerprint?: string | null | undefined;
+    } | undefined;
+}, {
+    customer_id: string;
+    product_id: string;
+    entity_id?: string | undefined;
+    options?: {
+        feature_id: string;
+        quantity: number;
+    }[] | undefined;
+    success_url?: string | undefined;
+    customer_data?: {
+        name?: string | null | undefined;
+        email?: string | null | undefined;
+        fingerprint?: string | null | undefined;
+    } | undefined;
+}>;
+type CheckoutParams = z.infer<typeof CheckoutParamsSchema>;
+type CheckoutResult = {
+    url?: string;
+    customer_id: string;
+    has_prorations: boolean;
+    lines: {
+        description: string;
+        amount: number;
+        item: ProductItem;
+    }[];
+    total: number;
+    currency: string;
+    options: AttachFeatureOptions[];
+    product: Product;
+    current_product: Product;
+    next_cycle?: {
+        starts_at: number;
+        total: number;
+    };
+};
+
 type Success<T> = {
     data: T;
     error: null;
@@ -576,7 +692,7 @@ declare class Autumn {
         create: (params?: CreateCustomerParams) => Promise<Result<Customer, AutumnError>>;
         update: (id: string, params: UpdateCustomerParams) => Promise<Result<Customer, AutumnError>>;
         delete: (id: string) => Promise<Result<Customer, AutumnError>>;
-        billingPortal: (id: string, params?: BillingPortalParams) => Promise<Result<BillingPortalResponse, AutumnError>>;
+        billingPortal: (id: string, params?: BillingPortalParams) => Promise<Result<BillingPortalResult, AutumnError>>;
     };
     static products: {
         get: (id: string) => Promise<Result<Product, AutumnError>>;
@@ -599,7 +715,7 @@ declare class Autumn {
         create: (params?: CreateCustomerParams) => Promise<Result<Customer, AutumnError>>;
         update: (id: string, params: UpdateCustomerParams) => Promise<Result<Customer, AutumnError>>;
         delete: (id: string) => Promise<Result<Customer, AutumnError>>;
-        billingPortal: (id: string, params?: BillingPortalParams) => Promise<Result<BillingPortalResponse, AutumnError>>;
+        billingPortal: (id: string, params?: BillingPortalParams) => Promise<Result<BillingPortalResult, AutumnError>>;
     };
     products: {
         get: (id: string) => Promise<Result<Product, AutumnError>>;
@@ -617,6 +733,8 @@ declare class Autumn {
         createCode: (params: CreateReferralCodeParams) => Promise<Result<any, AutumnError>>;
         redeemCode: (params: RedeemReferralCodeParams) => Promise<Result<any, AutumnError>>;
     };
+    static checkout: (params: CheckoutParams) => Promise<Result<CheckoutResult, AutumnError>>;
+    checkout(params: CheckoutParams): Promise<Result<CheckoutResult, AutumnError>>;
     static attach: (params: AttachParams) => Promise<Result<{
         customer_id: string;
         code: string;
@@ -646,40 +764,8 @@ declare class Autumn {
         product_id: string;
         success: boolean;
     }, AutumnError>>;
-    /**
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * Please use the new check() method instead.
-     */
-    static entitled: (params: CheckParams) => Promise<Result<CheckResult, AutumnError>>;
-    /**
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * Please use the new check() method instead.
-     */
-    entitled(params: CheckParams): Promise<Result<CheckResult, AutumnError>>;
     static check: (params: CheckParams) => Promise<Result<CheckResult, AutumnError>>;
     check(params: CheckParams): Promise<Result<CheckResult, AutumnError>>;
-    /**
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * Please use the new track() method instead.
-     */
-    static event: (params: TrackParams) => Promise<Result<{
-        customer_id: string;
-        code: string;
-        id: string;
-        feature_id?: string | undefined;
-        event_name?: string | undefined;
-    }, AutumnError>>;
-    /**
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * Please use the new track() method instead.
-     */
-    event(params: TrackParams): Promise<Result<{
-        customer_id: string;
-        code: string;
-        id: string;
-        feature_id?: string | undefined;
-        event_name?: string | undefined;
-    }, AutumnError>>;
     static track: (params: TrackParams) => Promise<Result<{
         customer_id: string;
         code: string;
@@ -796,4 +882,4 @@ interface RedeemReferralCodeResult {
     applied: boolean;
 }
 
-export { AppEnv, type AttachFeatureOptions, AttachFeatureOptionsSchema, type AttachParams, AttachParamsSchema, type AttachResult, AttachResultSchema, Autumn, AutumnError, type AutumnPromise, type BillingPortalParams, BillingPortalParamsSchema, type BillingPortalResult, type CancelParams, CancelParamsSchema, type CancelResult, CancelResultSchema, type CheckFeaturePreview, type CheckFeatureResult, type CheckFeatureScenario, type CheckParams, CheckParamsSchema, type CheckProductPreview, type CheckProductResult, type CheckResult, type CoreCustomerFeature, type CreateCustomerParams, CreateCustomerParamsSchema, type CreateEntityParams, type CreateEntityResult, type CreateProductParams, type CreateReferralCodeParams, CreateReferralCodeParamsSchema, type CreateReferralCodeResult, type Customer, type CustomerData, CustomerExpandEnum, type CustomerExpandOption, type CustomerFeature, type CustomerInvoice, type CustomerProduct, type DeleteEntityResult, type Entity, type EntityData, EntityDataSchema, 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, RedeemReferralCodeParamsSchema, type RedeemReferralCodeResult, type SetupPaymentParams, type SetupPaymentResult, type TrackParams, TrackParamsSchema, type TrackResult, TrackResultSchema, type UpdateCustomerParams, UsageModel, type UsageModelType, type UsageParams, type UsageResult, fetchPricingTable, toContainerResult };
+export { AppEnv, type AttachFeatureOptions, AttachFeatureOptionsSchema, type AttachParams, AttachParamsSchema, type AttachResult, AttachResultSchema, Autumn, AutumnError, type AutumnPromise, type BillingPortalParams, BillingPortalParamsSchema, type BillingPortalResult, type CancelParams, CancelParamsSchema, type CancelResult, CancelResultSchema, type CheckFeaturePreview, type CheckFeatureResult, type CheckFeatureScenario, type CheckParams, CheckParamsSchema, type CheckProductPreview, type CheckProductResult, type CheckResult, type CheckoutParams, CheckoutParamsSchema, type CheckoutResult, type CoreCustomerFeature, type CreateCustomerParams, CreateCustomerParamsSchema, type CreateEntityParams, type CreateEntityResult, type CreateProductParams, type CreateReferralCodeParams, CreateReferralCodeParamsSchema, type CreateReferralCodeResult, type Customer, type CustomerData, CustomerDataSchema, CustomerExpandEnum, type CustomerExpandOption, type CustomerFeature, type CustomerInvoice, type CustomerProduct, type DeleteEntityResult, type Entity, type EntityData, EntityDataSchema, type EntityExpandOption, type ErrorResponse, type Feature, 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, RedeemReferralCodeParamsSchema, type RedeemReferralCodeResult, type SetupPaymentParams, type SetupPaymentResult, type TrackParams, TrackParamsSchema, type TrackResult, TrackResultSchema, type UpdateCustomerParams, UsageModel, type UsageModelType, type UsageParams, type UsageResult, fetchPricingTable, toContainerResult };