autumn-js 0.0.107 → 0.0.109

package/dist/libraries/backend/{referralTypes-BpOamxCs.d.ts → referralTypes-PV0SFnx_.d.ts}

@@ -23,31 +23,108 @@ declare enum ProductItemInterval {
 }
 type ProductItemIntervalType = "minute" | "hour" | "day" | "week" | "month" | "quarter" | "semi_annual" | "year" | "multiple";
 
-type CheckFeatureScenario = "usage_limit" | "feature_flag";
-interface CheckFeatureResult extends CoreCustomerFeature {
-    allowed: boolean;
-    feature_id: string;
+declare const CheckFeatureResultSchema: z.ZodObject<{
+    allowed: z.ZodBoolean;
+    feature_id: z.ZodString;
+    customer_id: z.ZodString;
+    entity_id: z.ZodOptional<z.ZodString>;
+    required_balance: z.ZodNumber;
+} & {
+    unlimited: z.ZodOptional<z.ZodBoolean>;
+    interval: z.ZodOptional<z.ZodNativeEnum<typeof ProductItemInterval>>;
+    balance: z.ZodOptional<z.ZodNumber>;
+    usage: z.ZodOptional<z.ZodNumber>;
+    included_usage: z.ZodOptional<z.ZodNumber>;
+    next_reset_at: z.ZodOptional<z.ZodNumber>;
+    overage_allowed: z.ZodOptional<z.ZodBoolean>;
+    usage_limit: z.ZodOptional<z.ZodNumber>;
+    breakdown: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        interval: z.ZodNativeEnum<typeof ProductItemInterval>;
+        balance: z.ZodOptional<z.ZodNumber>;
+        usage: z.ZodOptional<z.ZodNumber>;
+        included_usage: z.ZodOptional<z.ZodNumber>;
+        next_reset_at: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        interval: ProductItemInterval;
+        balance?: number | undefined;
+        usage?: number | undefined;
+        included_usage?: number | undefined;
+        next_reset_at?: number | undefined;
+    }, {
+        interval: ProductItemInterval;
+        balance?: number | undefined;
+        usage?: number | undefined;
+        included_usage?: number | undefined;
+        next_reset_at?: number | undefined;
+    }>, "many">>;
+    credit_schema: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        feature_id: z.ZodString;
+        credit_amount: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        feature_id: string;
+        credit_amount: number;
+    }, {
+        feature_id: string;
+        credit_amount: number;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
     customer_id: string;
-    entity_id?: string;
+    feature_id: string;
     required_balance: number;
-    code: string;
-    usage_limit?: number;
-    preview?: CheckFeaturePreview;
-}
-interface CheckFeaturePreview {
-    scenario: CheckFeatureScenario;
-    title: string;
-    message: string;
+    allowed: boolean;
+    entity_id?: string | undefined;
+    usage_limit?: number | undefined;
+    unlimited?: boolean | undefined;
+    interval?: ProductItemInterval | undefined;
+    balance?: number | undefined;
+    usage?: number | undefined;
+    included_usage?: number | undefined;
+    next_reset_at?: number | undefined;
+    overage_allowed?: boolean | undefined;
+    breakdown?: {
+        interval: ProductItemInterval;
+        balance?: number | undefined;
+        usage?: number | undefined;
+        included_usage?: number | undefined;
+        next_reset_at?: number | undefined;
+    }[] | undefined;
+    credit_schema?: {
+        feature_id: string;
+        credit_amount: number;
+    }[] | undefined;
+}, {
+    customer_id: string;
     feature_id: string;
-    feature_name: string;
-    products: Product[];
-}
+    required_balance: number;
+    allowed: boolean;
+    entity_id?: string | undefined;
+    usage_limit?: number | undefined;
+    unlimited?: boolean | undefined;
+    interval?: ProductItemInterval | undefined;
+    balance?: number | undefined;
+    usage?: number | undefined;
+    included_usage?: number | undefined;
+    next_reset_at?: number | undefined;
+    overage_allowed?: boolean | undefined;
+    breakdown?: {
+        interval: ProductItemInterval;
+        balance?: number | undefined;
+        usage?: number | undefined;
+        included_usage?: number | undefined;
+        next_reset_at?: number | undefined;
+    }[] | undefined;
+    credit_schema?: {
+        feature_id: string;
+        credit_amount: number;
+    }[] | undefined;
+}>;
+type CheckFeatureResult = z.infer<typeof CheckFeatureResultSchema>;
 type ProductScenario = "scheduled" | "active" | "new" | "renew" | "upgrade" | "downgrade" | "cancel";
 interface CheckProductResult {
     allowed: boolean;
     customer_id: string;
     product_id: string;
-    code: string;
+    entity_id?: string;
     status?: string;
     preview?: CheckProductPreview;
 }
@@ -168,27 +245,86 @@ declare enum ProductStatus {
 }
 type CustomerExpandOption = "invoices" | "rewards" | "trials_used" | "entities" | "referrals" | "payment_method";
 
-interface CoreCustomerFeature {
-    unlimited?: boolean;
-    interval?: ProductItemInterval | null;
-    balance?: number;
-    usage?: number;
-    included_usage?: number;
-    next_reset_at?: number | null;
-    overage_allowed?: boolean;
-    usage_limit?: number;
+declare const CoreCusFeatureSchema: z.ZodObject<{
+    unlimited: z.ZodOptional<z.ZodBoolean>;
+    interval: z.ZodOptional<z.ZodNativeEnum<typeof ProductItemInterval>>;
+    balance: z.ZodOptional<z.ZodNumber>;
+    usage: z.ZodOptional<z.ZodNumber>;
+    included_usage: z.ZodOptional<z.ZodNumber>;
+    next_reset_at: z.ZodOptional<z.ZodNumber>;
+    overage_allowed: z.ZodOptional<z.ZodBoolean>;
+    usage_limit: z.ZodOptional<z.ZodNumber>;
+    breakdown: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        interval: z.ZodNativeEnum<typeof ProductItemInterval>;
+        balance: z.ZodOptional<z.ZodNumber>;
+        usage: z.ZodOptional<z.ZodNumber>;
+        included_usage: z.ZodOptional<z.ZodNumber>;
+        next_reset_at: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        interval: ProductItemInterval;
+        balance?: number | undefined;
+        usage?: number | undefined;
+        included_usage?: number | undefined;
+        next_reset_at?: number | undefined;
+    }, {
+        interval: ProductItemInterval;
+        balance?: number | undefined;
+        usage?: number | undefined;
+        included_usage?: number | undefined;
+        next_reset_at?: number | undefined;
+    }>, "many">>;
+    credit_schema: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        feature_id: z.ZodString;
+        credit_amount: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        feature_id: string;
+        credit_amount: number;
+    }, {
+        feature_id: string;
+        credit_amount: number;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    usage_limit?: number | undefined;
+    unlimited?: boolean | undefined;
+    interval?: ProductItemInterval | undefined;
+    balance?: number | undefined;
+    usage?: number | undefined;
+    included_usage?: number | undefined;
+    next_reset_at?: number | undefined;
+    overage_allowed?: boolean | undefined;
     breakdown?: {
         interval: ProductItemInterval;
-        balance?: number;
-        usage?: number;
-        included_usage?: number;
-        next_reset_at?: number;
-    }[];
+        balance?: number | undefined;
+        usage?: number | undefined;
+        included_usage?: number | undefined;
+        next_reset_at?: number | undefined;
+    }[] | undefined;
     credit_schema?: {
         feature_id: string;
         credit_amount: number;
-    }[];
-}
+    }[] | undefined;
+}, {
+    usage_limit?: number | undefined;
+    unlimited?: boolean | undefined;
+    interval?: ProductItemInterval | undefined;
+    balance?: number | undefined;
+    usage?: number | undefined;
+    included_usage?: number | undefined;
+    next_reset_at?: number | undefined;
+    overage_allowed?: boolean | undefined;
+    breakdown?: {
+        interval: ProductItemInterval;
+        balance?: number | undefined;
+        usage?: number | undefined;
+        included_usage?: number | undefined;
+        next_reset_at?: number | undefined;
+    }[] | undefined;
+    credit_schema?: {
+        feature_id: string;
+        credit_amount: number;
+    }[] | undefined;
+}>;
+type CoreCustomerFeature = z.infer<typeof CoreCusFeatureSchema>;
 interface CustomerFeature extends CoreCustomerFeature {
     id: string;
     name: string;
@@ -249,19 +385,19 @@ declare const CreateCustomerParamsSchema: z.ZodObject<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     expand: z.ZodOptional<z.ZodArray<z.ZodEnum<["invoices", "rewards", "trials_used", "entities", "referrals", "payment_method"]>, "many">>;
 }, "strip", z.ZodTypeAny, {
-    id?: string | null | undefined;
+    metadata?: Record<string, any> | undefined;
+    expand?: ("invoices" | "rewards" | "trials_used" | "entities" | "referrals" | "payment_method")[] | undefined;
     name?: string | null | undefined;
     email?: string | null | undefined;
     fingerprint?: string | null | undefined;
+    id?: string | null | undefined;
+}, {
     metadata?: Record<string, any> | undefined;
     expand?: ("invoices" | "rewards" | "trials_used" | "entities" | "referrals" | "payment_method")[] | undefined;
-}, {
-    id?: string | null | undefined;
     name?: string | null | undefined;
     email?: string | null | undefined;
     fingerprint?: string | null | undefined;
-    metadata?: Record<string, any> | undefined;
-    expand?: ("invoices" | "rewards" | "trials_used" | "entities" | "referrals" | "payment_method")[] | undefined;
+    id?: string | null | undefined;
 }>;
 type CreateCustomerParams = z.infer<typeof CreateCustomerParamsSchema>;
 interface UpdateCustomerParams {
@@ -320,18 +456,18 @@ declare const TrackParamsSchema: z.ZodObject<{
     entity_data: z.ZodOptional<z.ZodAny>;
 }, "strip", z.ZodTypeAny, {
     customer_id: string;
-    feature_id?: string | undefined;
-    entity_id?: string | undefined;
     value?: number | undefined;
+    entity_id?: string | undefined;
+    feature_id?: string | undefined;
     customer_data?: any;
     entity_data?: any;
     event_name?: string | undefined;
     idempotency_key?: string | undefined;
 }, {
     customer_id: string;
-    feature_id?: string | undefined;
-    entity_id?: string | undefined;
     value?: number | undefined;
+    entity_id?: string | undefined;
+    feature_id?: string | undefined;
     customer_data?: any;
     entity_data?: any;
     event_name?: string | undefined;
@@ -359,28 +495,28 @@ declare const CheckParamsSchema: z.ZodObject<{
     }>>;
 }, "strip", z.ZodTypeAny, {
     customer_id: string;
-    feature_id?: string | undefined;
-    entity_id?: string | undefined;
-    required_balance?: number | undefined;
     product_id?: string | undefined;
+    entity_id?: string | undefined;
+    feature_id?: string | undefined;
     customer_data?: any;
     entity_data?: {
         feature_id: string;
         name?: string | undefined;
     } | undefined;
+    required_balance?: number | undefined;
     send_event?: boolean | undefined;
     with_preview?: boolean | undefined;
 }, {
     customer_id: string;
-    feature_id?: string | undefined;
-    entity_id?: string | undefined;
-    required_balance?: number | undefined;
     product_id?: string | undefined;
+    entity_id?: string | undefined;
+    feature_id?: string | undefined;
     customer_data?: any;
     entity_data?: {
         feature_id: string;
         name?: string | undefined;
     } | undefined;
+    required_balance?: number | undefined;
     send_event?: boolean | undefined;
     with_preview?: boolean | undefined;
 }>;
@@ -406,6 +542,27 @@ interface SetupPaymentResult {
     customer_id: string;
     url: string;
 }
+declare const QueryParamsSchema: z.ZodObject<{
+    customer_id: z.ZodString;
+    feature_id: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+    range: z.ZodOptional<z.ZodEnum<["24h", "7d", "30d", "90d", "last_cycle"]>>;
+}, "strip", z.ZodTypeAny, {
+    customer_id: string;
+    feature_id: string | string[];
+    range?: "24h" | "7d" | "30d" | "90d" | "last_cycle" | undefined;
+}, {
+    customer_id: string;
+    feature_id: string | string[];
+    range?: "24h" | "7d" | "30d" | "90d" | "last_cycle" | undefined;
+}>;
+type QueryParams = z.infer<typeof QueryParamsSchema>;
+type QueryResult = {
+    list: Array<{
+        period: string;
+    } & {
+        [key: string]: number;
+    }>;
+};
 
 declare const AttachFeatureOptionsSchema: z.ZodObject<{
     feature_id: z.ZodString;
@@ -455,13 +612,13 @@ declare const AttachParamsSchema: z.ZodObject<{
     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;
+    entity_id?: string | undefined;
     product_ids?: string[] | undefined;
     free_trial?: boolean | undefined;
     success_url?: string | undefined;
@@ -476,13 +633,13 @@ declare const AttachParamsSchema: z.ZodObject<{
     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;
+    entity_id?: string | undefined;
     product_ids?: string[] | undefined;
     free_trial?: boolean | undefined;
     success_url?: string | undefined;
@@ -528,11 +685,11 @@ declare const CheckoutParamsSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     customer_id: string;
     product_id: string;
-    entity_id?: string | undefined;
     options?: {
         feature_id: string;
         quantity: number;
     }[] | undefined;
+    entity_id?: string | undefined;
     success_url?: string | undefined;
     customer_data?: {
         name?: string | null | undefined;
@@ -542,11 +699,11 @@ declare const CheckoutParamsSchema: z.ZodObject<{
 }, {
     customer_id: string;
     product_id: string;
-    entity_id?: string | undefined;
     options?: {
         feature_id: string;
         quantity: number;
     }[] | undefined;
+    entity_id?: string | undefined;
     success_url?: string | undefined;
     customer_data?: {
         name?: string | null | undefined;
@@ -641,18 +798,18 @@ declare class Autumn {
     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;
         message: string;
+        code: string;
+        customer_id: string;
         product_ids: string[];
         customer_data?: any;
         checkout_url?: string | undefined;
     }, AutumnError>>;
     static usage: (params: UsageParams) => Promise<Result<UsageResult, AutumnError>>;
     attach(params: AttachParams): Promise<Result<{
-        customer_id: string;
-        code: string;
         message: string;
+        code: string;
+        customer_id: string;
         product_ids: string[];
         customer_data?: any;
         checkout_url?: string | undefined;
@@ -672,20 +829,22 @@ declare class Autumn {
     static check: (params: CheckParams) => Promise<Result<CheckResult, AutumnError>>;
     check(params: CheckParams): Promise<Result<CheckResult, AutumnError>>;
     static track: (params: TrackParams) => Promise<Result<{
-        customer_id: string;
         code: string;
+        customer_id: string;
         id: string;
         feature_id?: string | undefined;
         event_name?: string | undefined;
     }, AutumnError>>;
     track(params: TrackParams): Promise<Result<{
-        customer_id: string;
         code: string;
+        customer_id: string;
         id: string;
         feature_id?: string | undefined;
         event_name?: string | undefined;
     }, AutumnError>>;
     usage(params: UsageParams): Promise<Result<UsageResult, AutumnError>>;
+    static query: (params: QueryParams) => Promise<Result<QueryResult, AutumnError>>;
+    query(params: QueryParams): Promise<Result<QueryResult, AutumnError>>;
 }
 
 type EntityExpandOption = "invoices";
@@ -731,11 +890,11 @@ declare const RedeemReferralCodeParamsSchema: z.ZodObject<{
     code: z.ZodString;
     customer_id: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    customer_id: string;
     code: string;
-}, {
     customer_id: string;
+}, {
     code: string;
+    customer_id: string;
 }>;
 type RedeemReferralCodeParams = z.infer<typeof RedeemReferralCodeParamsSchema>;