@open-loyalty/mcp-server 1.1.0 → 1.3.3

package/dist/tools/achievement.d.ts

@@ -70,42 +70,45 @@ export declare const AchievementCreateInputSchema: {
             name: string;
             description?: string | undefined;
         }>>>;
-        trigger: z.ZodOptional<z.ZodString>;
-        type: z.ZodOptional<z.ZodString>;
+        trigger: z.ZodOptional<z.ZodEnum<["transaction", "custom_event", "points_transfer", "reward_redemption", "referral", "achievement", "tier_change", "registration", "profile_update"]>>;
+        type: z.ZodOptional<z.ZodEnum<["direct", "referral"]>>;
         event: z.ZodOptional<z.ZodString>;
         completeRule: z.ZodObject<{
             periodGoal: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
-            period: z.ZodOptional<z.ZodObject<{
-                consecutive: z.ZodOptional<z.ZodNumber>;
-                value: z.ZodOptional<z.ZodNumber>;
+            period: z.ZodObject<{
+                type: z.ZodEnum<["day", "week", "month", "year", "last_day", "calendarDays", "calendarWeeks", "calendarMonths", "calendarYears"]>;
+                consecutive: z.ZodNumber;
             }, "strip", z.ZodTypeAny, {
-                value?: number | undefined;
-                consecutive?: number | undefined;
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
             }, {
-                value?: number | undefined;
-                consecutive?: number | undefined;
-            }>>;
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
+            }>;
             uniqueAttribute: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             periodGoal: string | number;
-            period?: {
-                value?: number | undefined;
-                consecutive?: number | undefined;
-            } | undefined;
+            period: {
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
+            };
             uniqueAttribute?: string | undefined;
         }, {
             periodGoal: string | number;
-            period?: {
-                value?: number | undefined;
-                consecutive?: number | undefined;
-            } | undefined;
+            period: {
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
+            };
             uniqueAttribute?: string | undefined;
         }>;
         aggregation: z.ZodOptional<z.ZodObject<{
+            type: z.ZodEnum<["quantity", "sum", "average", "min", "max"]>;
             rule: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
+            type: "quantity" | "min" | "max" | "sum" | "average";
             rule?: string | undefined;
         }, {
+            type: "quantity" | "min" | "max" | "sum" | "average";
             rule?: string | undefined;
         }>>;
         conditions: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
@@ -138,22 +141,23 @@ export declare const AchievementCreateInputSchema: {
     }, "strip", z.ZodTypeAny, {
         completeRule: {
             periodGoal: string | number;
-            period?: {
-                value?: number | undefined;
-                consecutive?: number | undefined;
-            } | undefined;
+            period: {
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
+            };
             uniqueAttribute?: string | undefined;
         };
-        type?: string | undefined;
+        type?: "direct" | "referral" | undefined;
         conditions?: Record<string, unknown>[] | undefined;
         translations?: Record<string, {
             name: string;
             description?: string | undefined;
         }> | undefined;
-        trigger?: string | undefined;
+        trigger?: "referral" | "transaction" | "custom_event" | "achievement" | "points_transfer" | "reward_redemption" | "tier_change" | "registration" | "profile_update" | undefined;
         event?: string | undefined;
         achievementRuleId?: string | undefined;
         aggregation?: {
+            type: "quantity" | "min" | "max" | "sum" | "average";
             rule?: string | undefined;
         } | undefined;
         limit?: {
@@ -167,22 +171,23 @@ export declare const AchievementCreateInputSchema: {
     }, {
         completeRule: {
             periodGoal: string | number;
-            period?: {
-                value?: number | undefined;
-                consecutive?: number | undefined;
-            } | undefined;
+            period: {
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
+            };
             uniqueAttribute?: string | undefined;
         };
-        type?: string | undefined;
+        type?: "direct" | "referral" | undefined;
         conditions?: Record<string, unknown>[] | undefined;
         translations?: Record<string, {
             name: string;
             description?: string | undefined;
         }> | undefined;
-        trigger?: string | undefined;
+        trigger?: "referral" | "transaction" | "custom_event" | "achievement" | "points_transfer" | "reward_redemption" | "tier_change" | "registration" | "profile_update" | undefined;
         event?: string | undefined;
         achievementRuleId?: string | undefined;
         aggregation?: {
+            type: "quantity" | "min" | "max" | "sum" | "average";
             rule?: string | undefined;
         } | undefined;
         limit?: {
@@ -264,42 +269,45 @@ export declare const AchievementUpdateInputSchema: {
             name: string;
             description?: string | undefined;
         }>>>;
-        trigger: z.ZodOptional<z.ZodString>;
-        type: z.ZodOptional<z.ZodString>;
+        trigger: z.ZodOptional<z.ZodEnum<["transaction", "custom_event", "points_transfer", "reward_redemption", "referral", "achievement", "tier_change", "registration", "profile_update"]>>;
+        type: z.ZodOptional<z.ZodEnum<["direct", "referral"]>>;
         event: z.ZodOptional<z.ZodString>;
         completeRule: z.ZodObject<{
             periodGoal: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
-            period: z.ZodOptional<z.ZodObject<{
-                consecutive: z.ZodOptional<z.ZodNumber>;
-                value: z.ZodOptional<z.ZodNumber>;
+            period: z.ZodObject<{
+                type: z.ZodEnum<["day", "week", "month", "year", "last_day", "calendarDays", "calendarWeeks", "calendarMonths", "calendarYears"]>;
+                consecutive: z.ZodNumber;
             }, "strip", z.ZodTypeAny, {
-                value?: number | undefined;
-                consecutive?: number | undefined;
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
             }, {
-                value?: number | undefined;
-                consecutive?: number | undefined;
-            }>>;
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
+            }>;
             uniqueAttribute: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             periodGoal: string | number;
-            period?: {
-                value?: number | undefined;
-                consecutive?: number | undefined;
-            } | undefined;
+            period: {
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
+            };
             uniqueAttribute?: string | undefined;
         }, {
             periodGoal: string | number;
-            period?: {
-                value?: number | undefined;
-                consecutive?: number | undefined;
-            } | undefined;
+            period: {
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
+            };
             uniqueAttribute?: string | undefined;
         }>;
         aggregation: z.ZodOptional<z.ZodObject<{
+            type: z.ZodEnum<["quantity", "sum", "average", "min", "max"]>;
             rule: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
+            type: "quantity" | "min" | "max" | "sum" | "average";
             rule?: string | undefined;
         }, {
+            type: "quantity" | "min" | "max" | "sum" | "average";
             rule?: string | undefined;
         }>>;
         conditions: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
@@ -332,22 +340,23 @@ export declare const AchievementUpdateInputSchema: {
     }, "strip", z.ZodTypeAny, {
         completeRule: {
             periodGoal: string | number;
-            period?: {
-                value?: number | undefined;
-                consecutive?: number | undefined;
-            } | undefined;
+            period: {
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
+            };
             uniqueAttribute?: string | undefined;
         };
-        type?: string | undefined;
+        type?: "direct" | "referral" | undefined;
         conditions?: Record<string, unknown>[] | undefined;
         translations?: Record<string, {
             name: string;
             description?: string | undefined;
         }> | undefined;
-        trigger?: string | undefined;
+        trigger?: "referral" | "transaction" | "custom_event" | "achievement" | "points_transfer" | "reward_redemption" | "tier_change" | "registration" | "profile_update" | undefined;
         event?: string | undefined;
         achievementRuleId?: string | undefined;
         aggregation?: {
+            type: "quantity" | "min" | "max" | "sum" | "average";
             rule?: string | undefined;
         } | undefined;
         limit?: {
@@ -361,22 +370,23 @@ export declare const AchievementUpdateInputSchema: {
     }, {
         completeRule: {
             periodGoal: string | number;
-            period?: {
-                value?: number | undefined;
-                consecutive?: number | undefined;
-            } | undefined;
+            period: {
+                type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                consecutive: number;
+            };
             uniqueAttribute?: string | undefined;
         };
-        type?: string | undefined;
+        type?: "direct" | "referral" | undefined;
         conditions?: Record<string, unknown>[] | undefined;
         translations?: Record<string, {
             name: string;
             description?: string | undefined;
         }> | undefined;
-        trigger?: string | undefined;
+        trigger?: "referral" | "transaction" | "custom_event" | "achievement" | "points_transfer" | "reward_redemption" | "tier_change" | "registration" | "profile_update" | undefined;
         event?: string | undefined;
         achievementRuleId?: string | undefined;
         aggregation?: {
+            type: "quantity" | "min" | "max" | "sum" | "average";
             rule?: string | undefined;
         } | undefined;
         limit?: {
@@ -549,7 +559,7 @@ export declare const achievementToolDefinitions: readonly [{
 }, {
     readonly name: "openloyalty_achievement_create";
     readonly title: "Create Achievement";
-    readonly description: "Create achievement with rules that track member progress. Triggers: transaction (purchases), custom_event (custom actions), points_transfer, referral, etc. CompleteRule sets the goal: periodGoal (target value) with optional period (consecutive periods). Example - '5 purchases/month': rules: [{ trigger: 'transaction', completeRule: { periodGoal: 5, period: { value: 1, consecutive: 1 } } }]";
+    readonly description: string;
     readonly readOnly: false;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
@@ -614,42 +624,45 @@ export declare const achievementToolDefinitions: readonly [{
                 name: string;
                 description?: string | undefined;
             }>>>;
-            trigger: z.ZodOptional<z.ZodString>;
-            type: z.ZodOptional<z.ZodString>;
+            trigger: z.ZodOptional<z.ZodEnum<["transaction", "custom_event", "points_transfer", "reward_redemption", "referral", "achievement", "tier_change", "registration", "profile_update"]>>;
+            type: z.ZodOptional<z.ZodEnum<["direct", "referral"]>>;
             event: z.ZodOptional<z.ZodString>;
             completeRule: z.ZodObject<{
                 periodGoal: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
-                period: z.ZodOptional<z.ZodObject<{
-                    consecutive: z.ZodOptional<z.ZodNumber>;
-                    value: z.ZodOptional<z.ZodNumber>;
+                period: z.ZodObject<{
+                    type: z.ZodEnum<["day", "week", "month", "year", "last_day", "calendarDays", "calendarWeeks", "calendarMonths", "calendarYears"]>;
+                    consecutive: z.ZodNumber;
                 }, "strip", z.ZodTypeAny, {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
                 }, {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
-                }>>;
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
+                }>;
                 uniqueAttribute: z.ZodOptional<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
                 periodGoal: string | number;
-                period?: {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
-                } | undefined;
+                period: {
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
+                };
                 uniqueAttribute?: string | undefined;
             }, {
                 periodGoal: string | number;
-                period?: {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
-                } | undefined;
+                period: {
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
+                };
                 uniqueAttribute?: string | undefined;
             }>;
             aggregation: z.ZodOptional<z.ZodObject<{
+                type: z.ZodEnum<["quantity", "sum", "average", "min", "max"]>;
                 rule: z.ZodOptional<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
+                type: "quantity" | "min" | "max" | "sum" | "average";
                 rule?: string | undefined;
             }, {
+                type: "quantity" | "min" | "max" | "sum" | "average";
                 rule?: string | undefined;
             }>>;
             conditions: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
@@ -682,22 +695,23 @@ export declare const achievementToolDefinitions: readonly [{
         }, "strip", z.ZodTypeAny, {
             completeRule: {
                 periodGoal: string | number;
-                period?: {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
-                } | undefined;
+                period: {
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
+                };
                 uniqueAttribute?: string | undefined;
             };
-            type?: string | undefined;
+            type?: "direct" | "referral" | undefined;
             conditions?: Record<string, unknown>[] | undefined;
             translations?: Record<string, {
                 name: string;
                 description?: string | undefined;
             }> | undefined;
-            trigger?: string | undefined;
+            trigger?: "referral" | "transaction" | "custom_event" | "achievement" | "points_transfer" | "reward_redemption" | "tier_change" | "registration" | "profile_update" | undefined;
             event?: string | undefined;
             achievementRuleId?: string | undefined;
             aggregation?: {
+                type: "quantity" | "min" | "max" | "sum" | "average";
                 rule?: string | undefined;
             } | undefined;
             limit?: {
@@ -711,22 +725,23 @@ export declare const achievementToolDefinitions: readonly [{
         }, {
             completeRule: {
                 periodGoal: string | number;
-                period?: {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
-                } | undefined;
+                period: {
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
+                };
                 uniqueAttribute?: string | undefined;
             };
-            type?: string | undefined;
+            type?: "direct" | "referral" | undefined;
             conditions?: Record<string, unknown>[] | undefined;
             translations?: Record<string, {
                 name: string;
                 description?: string | undefined;
             }> | undefined;
-            trigger?: string | undefined;
+            trigger?: "referral" | "transaction" | "custom_event" | "achievement" | "points_transfer" | "reward_redemption" | "tier_change" | "registration" | "profile_update" | undefined;
             event?: string | undefined;
             achievementRuleId?: string | undefined;
             aggregation?: {
+                type: "quantity" | "min" | "max" | "sum" | "average";
                 rule?: string | undefined;
             } | undefined;
             limit?: {
@@ -820,42 +835,45 @@ export declare const achievementToolDefinitions: readonly [{
                 name: string;
                 description?: string | undefined;
             }>>>;
-            trigger: z.ZodOptional<z.ZodString>;
-            type: z.ZodOptional<z.ZodString>;
+            trigger: z.ZodOptional<z.ZodEnum<["transaction", "custom_event", "points_transfer", "reward_redemption", "referral", "achievement", "tier_change", "registration", "profile_update"]>>;
+            type: z.ZodOptional<z.ZodEnum<["direct", "referral"]>>;
             event: z.ZodOptional<z.ZodString>;
             completeRule: z.ZodObject<{
                 periodGoal: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
-                period: z.ZodOptional<z.ZodObject<{
-                    consecutive: z.ZodOptional<z.ZodNumber>;
-                    value: z.ZodOptional<z.ZodNumber>;
+                period: z.ZodObject<{
+                    type: z.ZodEnum<["day", "week", "month", "year", "last_day", "calendarDays", "calendarWeeks", "calendarMonths", "calendarYears"]>;
+                    consecutive: z.ZodNumber;
                 }, "strip", z.ZodTypeAny, {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
                 }, {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
-                }>>;
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
+                }>;
                 uniqueAttribute: z.ZodOptional<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
                 periodGoal: string | number;
-                period?: {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
-                } | undefined;
+                period: {
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
+                };
                 uniqueAttribute?: string | undefined;
             }, {
                 periodGoal: string | number;
-                period?: {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
-                } | undefined;
+                period: {
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
+                };
                 uniqueAttribute?: string | undefined;
             }>;
             aggregation: z.ZodOptional<z.ZodObject<{
+                type: z.ZodEnum<["quantity", "sum", "average", "min", "max"]>;
                 rule: z.ZodOptional<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
+                type: "quantity" | "min" | "max" | "sum" | "average";
                 rule?: string | undefined;
             }, {
+                type: "quantity" | "min" | "max" | "sum" | "average";
                 rule?: string | undefined;
             }>>;
             conditions: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
@@ -888,22 +906,23 @@ export declare const achievementToolDefinitions: readonly [{
         }, "strip", z.ZodTypeAny, {
             completeRule: {
                 periodGoal: string | number;
-                period?: {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
-                } | undefined;
+                period: {
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
+                };
                 uniqueAttribute?: string | undefined;
             };
-            type?: string | undefined;
+            type?: "direct" | "referral" | undefined;
             conditions?: Record<string, unknown>[] | undefined;
             translations?: Record<string, {
                 name: string;
                 description?: string | undefined;
             }> | undefined;
-            trigger?: string | undefined;
+            trigger?: "referral" | "transaction" | "custom_event" | "achievement" | "points_transfer" | "reward_redemption" | "tier_change" | "registration" | "profile_update" | undefined;
             event?: string | undefined;
             achievementRuleId?: string | undefined;
             aggregation?: {
+                type: "quantity" | "min" | "max" | "sum" | "average";
                 rule?: string | undefined;
             } | undefined;
             limit?: {
@@ -917,22 +936,23 @@ export declare const achievementToolDefinitions: readonly [{
         }, {
             completeRule: {
                 periodGoal: string | number;
-                period?: {
-                    value?: number | undefined;
-                    consecutive?: number | undefined;
-                } | undefined;
+                period: {
+                    type: "day" | "week" | "month" | "year" | "calendarDays" | "calendarWeeks" | "calendarMonths" | "calendarYears" | "last_day";
+                    consecutive: number;
+                };
                 uniqueAttribute?: string | undefined;
             };
-            type?: string | undefined;
+            type?: "direct" | "referral" | undefined;
             conditions?: Record<string, unknown>[] | undefined;
             translations?: Record<string, {
                 name: string;
                 description?: string | undefined;
             }> | undefined;
-            trigger?: string | undefined;
+            trigger?: "referral" | "transaction" | "custom_event" | "achievement" | "points_transfer" | "reward_redemption" | "tier_change" | "registration" | "profile_update" | undefined;
             event?: string | undefined;
             achievementRuleId?: string | undefined;
             aggregation?: {
+                type: "quantity" | "min" | "max" | "sum" | "average";
                 rule?: string | undefined;
             } | undefined;
             limit?: {