@open-loyalty/mcp-server 1.14.0 → 1.16.1

package/dist/tools/campaign/schemas.js

@@ -11,7 +11,7 @@ const TranslationsInputSchema = z.object({
 const CampaignEffectInputSchema = z.object({
     effect: z.enum(["give_points", "give_reward", "deduct_unit", "assign_member_custom_attribute", "remove_member_custom_attribute"])
         .describe("Effect type: give_points, give_reward, deduct_unit, etc. Use key `effect` (not `type`)."),
-    pointsRule: z.string().optional().describe("Points calculation expression (required for give_points). Must be a STRING. " +
+    pointsRule: z.union([z.string(), z.number()]).optional().describe("Points calculation expression (required for give_points). Prefer a STRING; numeric values are converted to strings. " +
         "Fixed: '100'. Dynamic: 'transaction.grossValue * 10'. " +
         "Category: 'transaction.category(\"electronics\").grossValue * 5'. " +
         "Capped: '(transaction.grossValue * 2 >= 100) ? 100 : transaction.grossValue * 2'. " +
@@ -59,7 +59,8 @@ const CampaignActivityInputSchema = z.object({
 });
 // Visibility input schema
 const CampaignVisibilityInputSchema = z.object({
-    target: z.enum(["all", "tier", "segment"]).describe("Who can see the campaign: all, tier (specific tiers), or segment (specific segments)."),
+    target: z.enum(["none", "tier", "segment", "all"]).describe("Who can see the campaign: tier (specific tiers), segment (specific segments), or none (invisible to everyone). " +
+        "Omit visibility for all members. Legacy 'all' is accepted and normalized by omitting visibility before calling the API."),
     tiers: z.array(z.string()).optional().describe("Array of tier level IDs (required if target is 'tier')."),
     segments: z.array(z.string()).optional().describe("Array of segment IDs (required if target is 'segment')."),
 }).optional();
@@ -73,20 +74,31 @@ const CampaignAudienceInputSchema = z.object({
 // Limit value input schema
 // NOTE: Interval types must use "calendar" prefix (calendarDays, not days)
 // Omitting interval entirely means "forever" (lifetime limit)
+const CampaignLimitIntervalTypeSchema = z.enum([
+    "calendarHours",
+    "calendarDays",
+    "calendarWeeks",
+    "calendarMonths",
+    "calendarYears",
+]);
 const CampaignLimitValueInputSchema = z.object({
     value: z.number().describe("Limit value."),
     interval: z.object({
-        type: z.enum(["calendarDays", "calendarWeeks", "calendarMonths", "calendarYears"])
-            .describe("Interval type. Use 'calendarDays' for daily, 'calendarWeeks' for weekly, etc. Omit interval entirely for lifetime limit."),
-        value: z.number().optional().describe("Interval value (e.g., 1 for 'every 1 day', 7 for 'every 7 days')."),
+        type: CampaignLimitIntervalTypeSchema.describe("Interval type: calendarHours, calendarDays, calendarWeeks, calendarMonths, calendarYears. Omit interval entirely for lifetime limit."),
+        value: z.number().describe("Interval value (e.g., 1 for 'every 1 day'). Required when interval is present."),
     }).optional().describe("Time interval for limit reset. If omitted, limit applies forever (lifetime)."),
 });
+const CampaignLimitInputSchema = z.union([
+    CampaignLimitValueInputSchema,
+    z.number().describe("Numeric shorthand for a lifetime limit; normalized to { value: number }."),
+]);
 // Limits input schema
 const CampaignLimitsInputSchema = z.object({
-    points: CampaignLimitValueInputSchema.optional().describe("Total points limit for the campaign."),
-    pointsPerMember: CampaignLimitValueInputSchema.optional().describe("Points limit per member."),
-    executionsPerMember: CampaignLimitValueInputSchema.optional().describe("Execution limit per member."),
-}).optional();
+    points: CampaignLimitInputSchema.optional().describe("Total points limit for the campaign."),
+    pointsPerMember: CampaignLimitInputSchema.optional().describe("Points limit per member."),
+    executionsPerMember: CampaignLimitInputSchema.optional().describe("Execution limit per member."),
+    perTransaction: z.unknown().optional().describe("Unsupported. Campaign limits do not support perTransaction; cap pointsRule for per-transaction point caps."),
+}).passthrough().optional();
 // Label input schema
 const CampaignLabelInputSchema = z.object({
     key: z.string().describe("Label key (e.g., 'category', 'channel', 'season')."),
@@ -189,7 +201,7 @@ export const CampaignUpdateInputSchema = {
         })).optional().describe("Array of conditions that must match for rule to apply."),
     })).describe("Campaign rules with effects and optional conditions."),
     visibility: z.object({
-        target: z.enum(["all", "tier", "segment"]).describe("Who can see the campaign: all, tier (specific tiers), or segment (specific segments)."),
+        target: z.enum(["none", "tier", "segment"]).describe("Who can see the campaign: tier, segment, or none (invisible to everyone). Omit visibility for everyone."),
         tiers: z.array(z.string()).optional().describe("Array of tier level IDs (required if target is 'tier'). Use ol_tierset_get_tiers to find IDs."),
         segments: z.array(z.string()).optional().describe("Array of segment IDs (required if target is 'segment'). Use ol_segment_list to find IDs."),
     }).optional().describe("Who can see the campaign."),
@@ -202,25 +214,25 @@ export const CampaignUpdateInputSchema = {
         points: z.object({
             value: z.number().describe("Maximum total points."),
             interval: z.object({
-                type: z.enum(["calendarDays", "calendarWeeks", "calendarMonths", "calendarYears"])
-                    .describe("Interval type: calendarDays, calendarWeeks, calendarMonths, calendarYears. Omit interval for lifetime limit."),
-                value: z.number().optional().describe("Interval value (e.g., 1 for every 1 day)."),
+                type: CampaignLimitIntervalTypeSchema
+                    .describe("Interval type: calendarHours, calendarDays, calendarWeeks, calendarMonths, calendarYears. Omit interval for lifetime limit."),
+                value: z.number().describe("Interval value (e.g., 1 for every 1 day). Required when interval is present."),
             }).optional().describe("Time interval for limit reset. Omit for lifetime limit."),
         }).optional().describe("Total points limit for the campaign."),
         pointsPerMember: z.object({
             value: z.number().describe("Maximum points per member."),
             interval: z.object({
-                type: z.enum(["calendarDays", "calendarWeeks", "calendarMonths", "calendarYears"])
-                    .describe("Interval type: calendarDays, calendarWeeks, calendarMonths, calendarYears."),
-                value: z.number().optional().describe("Interval value."),
+                type: CampaignLimitIntervalTypeSchema
+                    .describe("Interval type: calendarHours, calendarDays, calendarWeeks, calendarMonths, calendarYears."),
+                value: z.number().describe("Interval value. Required when interval is present."),
             }).optional().describe("Time interval for limit reset. Omit for lifetime limit."),
         }).optional().describe("Points limit per member."),
         executionsPerMember: z.object({
             value: z.number().describe("Maximum executions per member."),
             interval: z.object({
-                type: z.enum(["calendarDays", "calendarWeeks", "calendarMonths", "calendarYears"])
-                    .describe("Interval type: calendarDays, calendarWeeks, calendarMonths, calendarYears."),
-                value: z.number().optional().describe("Interval value."),
+                type: CampaignLimitIntervalTypeSchema
+                    .describe("Interval type: calendarHours, calendarDays, calendarWeeks, calendarMonths, calendarYears."),
+                value: z.number().describe("Interval value. Required when interval is present."),
             }).optional().describe("Time interval for limit reset. Omit for lifetime limit."),
         }).optional().describe("Execution limit per member."),
     }).optional().describe("Campaign limits for points and executions."),
@@ -298,7 +310,9 @@ export const CampaignCreateInputSchema = {
     limits: CampaignLimitsInputSchema.describe("Budget controls for the campaign. " +
         "BUSINESS IMPACT: Without limits, a campaign running 12 months on 10K txn/month at 100 pts each = 12M points liability. " +
         "BUSINESS DECISION: Set points (total cap), pointsPerMember (per-member cap), and/or executionsPerMember (frequency). " +
-        "Omit interval for lifetime limit, or use { type: 'calendarDays', value: 1 } for daily reset."),
+        "Supported keys: points, pointsPerMember, executionsPerMember. Do NOT use perTransaction; cap pointsRule instead. " +
+        "Omit interval for lifetime limit, or use { type: 'calendarDays', value: 1 } for daily reset. " +
+        "Valid interval types: calendarHours, calendarDays, calendarWeeks, calendarMonths, calendarYears."),
     active: z.boolean().optional().describe("Whether campaign is active (default: false)."),
     displayOrder: z.number().optional().describe("Display order for sorting campaigns."),
     labels: z.array(CampaignLabelInputSchema).optional().describe("Custom labels/tags for the campaign."),

package/dist/tools/campaign/types.d.ts

@@ -105,7 +105,7 @@ export interface CampaignCreateInput {
         target?: string;
         effects: Array<{
             effect: string;
-            pointsRule?: string;
+            pointsRule?: string | number;
             walletCode?: string;
             rewardId?: string;
             customAttributeKey?: string;
@@ -128,27 +128,29 @@ export interface CampaignCreateInput {
         segments?: string[];
     };
     limits?: {
-        points?: {
+        points?: number | {
             value: number;
             interval?: {
                 type: string;
-                value?: number;
+                value: number;
             };
         };
-        pointsPerMember?: {
+        pointsPerMember?: number | {
             value: number;
             interval?: {
                 type: string;
-                value?: number;
+                value: number;
             };
         };
-        executionsPerMember?: {
+        executionsPerMember?: number | {
             value: number;
             interval?: {
                 type: string;
-                value?: number;
+                value: number;
             };
         };
+        perTransaction?: unknown;
+        [key: string]: unknown;
     };
     active?: boolean;
     displayOrder?: number;

package/dist/types/schemas/analytics.d.ts

@@ -363,6 +363,10 @@ export declare const DashboardHeaderSchema: z.ZodObject<{
     transactions: z.ZodOptional<z.ZodNumber>;
     avgTransactionValue: z.ZodOptional<z.ZodNumber>;
     avgNumberOfTransactions: z.ZodOptional<z.ZodNumber>;
+    returnTransactions: z.ZodOptional<z.ZodNumber>;
+    totalReturns: z.ZodOptional<z.ZodNumber>;
+    avgReturnValue: z.ZodOptional<z.ZodNumber>;
+    avgNumberOfReturnTransactions: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     transactions?: number | undefined;
     registeredMembers?: number | undefined;
@@ -371,6 +375,10 @@ export declare const DashboardHeaderSchema: z.ZodObject<{
     avgSpending?: number | undefined;
     avgTransactionValue?: number | undefined;
     avgNumberOfTransactions?: number | undefined;
+    returnTransactions?: number | undefined;
+    totalReturns?: number | undefined;
+    avgReturnValue?: number | undefined;
+    avgNumberOfReturnTransactions?: number | undefined;
 }, {
     transactions?: number | undefined;
     registeredMembers?: number | undefined;
@@ -379,6 +387,10 @@ export declare const DashboardHeaderSchema: z.ZodObject<{
     avgSpending?: number | undefined;
     avgTransactionValue?: number | undefined;
     avgNumberOfTransactions?: number | undefined;
+    returnTransactions?: number | undefined;
+    totalReturns?: number | undefined;
+    avgReturnValue?: number | undefined;
+    avgNumberOfReturnTransactions?: number | undefined;
 }>;
 export type DashboardHeader = z.infer<typeof DashboardHeaderSchema>;
 export declare const DashboardOverviewSchema: z.ZodObject<{
@@ -392,6 +404,10 @@ export declare const DashboardOverviewSchema: z.ZodObject<{
         transactions: z.ZodOptional<z.ZodNumber>;
         avgTransactionValue: z.ZodOptional<z.ZodNumber>;
         avgNumberOfTransactions: z.ZodOptional<z.ZodNumber>;
+        returnTransactions: z.ZodOptional<z.ZodNumber>;
+        totalReturns: z.ZodOptional<z.ZodNumber>;
+        avgReturnValue: z.ZodOptional<z.ZodNumber>;
+        avgNumberOfReturnTransactions: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         transactions?: number | undefined;
         registeredMembers?: number | undefined;
@@ -400,6 +416,10 @@ export declare const DashboardOverviewSchema: z.ZodObject<{
         avgSpending?: number | undefined;
         avgTransactionValue?: number | undefined;
         avgNumberOfTransactions?: number | undefined;
+        returnTransactions?: number | undefined;
+        totalReturns?: number | undefined;
+        avgReturnValue?: number | undefined;
+        avgNumberOfReturnTransactions?: number | undefined;
     }, {
         transactions?: number | undefined;
         registeredMembers?: number | undefined;
@@ -408,9 +428,13 @@ export declare const DashboardOverviewSchema: z.ZodObject<{
         avgSpending?: number | undefined;
         avgTransactionValue?: number | undefined;
         avgNumberOfTransactions?: number | undefined;
+        returnTransactions?: number | undefined;
+        totalReturns?: number | undefined;
+        avgReturnValue?: number | undefined;
+        avgNumberOfReturnTransactions?: number | undefined;
     }>>;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
+    aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month", "year"]>>;
     dataType: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     data?: Record<string, unknown> | undefined;
@@ -422,10 +446,14 @@ export declare const DashboardOverviewSchema: z.ZodObject<{
         avgSpending?: number | undefined;
         avgTransactionValue?: number | undefined;
         avgNumberOfTransactions?: number | undefined;
+        returnTransactions?: number | undefined;
+        totalReturns?: number | undefined;
+        avgReturnValue?: number | undefined;
+        avgNumberOfReturnTransactions?: number | undefined;
     } | undefined;
     intervalStartDate?: string | undefined;
     intervalEndDate?: string | undefined;
-    aggregationType?: "day" | "week" | "month" | undefined;
+    aggregationType?: "day" | "week" | "month" | "year" | undefined;
     dataType?: string | undefined;
 }, {
     data?: Record<string, unknown> | undefined;
@@ -437,10 +465,14 @@ export declare const DashboardOverviewSchema: z.ZodObject<{
         avgSpending?: number | undefined;
         avgTransactionValue?: number | undefined;
         avgNumberOfTransactions?: number | undefined;
+        returnTransactions?: number | undefined;
+        totalReturns?: number | undefined;
+        avgReturnValue?: number | undefined;
+        avgNumberOfReturnTransactions?: number | undefined;
     } | undefined;
     intervalStartDate?: string | undefined;
     intervalEndDate?: string | undefined;
-    aggregationType?: "day" | "week" | "month" | undefined;
+    aggregationType?: "day" | "week" | "month" | "year" | undefined;
     dataType?: string | undefined;
 }>;
 export type DashboardOverview = z.infer<typeof DashboardOverviewSchema>;
@@ -504,7 +536,7 @@ export declare const UnitsOverviewSchema: z.ZodObject<{
         breakageRate?: number | undefined;
     }>>;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
+    aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month", "year"]>>;
     dataType: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     data?: Record<string, unknown> | undefined;
@@ -519,7 +551,7 @@ export declare const UnitsOverviewSchema: z.ZodObject<{
     } | undefined;
     intervalStartDate?: string | undefined;
     intervalEndDate?: string | undefined;
-    aggregationType?: "day" | "week" | "month" | undefined;
+    aggregationType?: "day" | "week" | "month" | "year" | undefined;
     dataType?: string | undefined;
     walletTypeCode?: string | undefined;
 }, {
@@ -535,7 +567,7 @@ export declare const UnitsOverviewSchema: z.ZodObject<{
     } | undefined;
     intervalStartDate?: string | undefined;
     intervalEndDate?: string | undefined;
-    aggregationType?: "day" | "week" | "month" | undefined;
+    aggregationType?: "day" | "week" | "month" | "year" | undefined;
     dataType?: string | undefined;
     walletTypeCode?: string | undefined;
 }>;

package/dist/types/schemas/analytics.js

@@ -97,13 +97,17 @@ export const DashboardHeaderSchema = z.object({
     transactions: z.number().optional().describe("Total transactions."),
     avgTransactionValue: z.number().optional().describe("Average transaction value."),
     avgNumberOfTransactions: z.number().optional().describe("Average number of transactions per member."),
+    returnTransactions: z.number().optional().describe("Total return transactions."),
+    totalReturns: z.number().optional().describe("Total returned value."),
+    avgReturnValue: z.number().optional().describe("Average return value."),
+    avgNumberOfReturnTransactions: z.number().optional().describe("Average number of return transactions per member."),
 });
 export const DashboardOverviewSchema = z.object({
     intervalStartDate: z.string().optional().describe("Start date of data interval."),
     intervalEndDate: z.string().optional().describe("End date of data interval."),
     header: DashboardHeaderSchema.optional().describe("Summary header metrics."),
     data: z.record(z.string(), z.unknown()).optional().describe("Time-series data points."),
-    aggregationType: z.enum(["day", "week", "month"]).optional().describe("Aggregation granularity."),
+    aggregationType: z.enum(["day", "week", "month", "year"]).optional().describe("Aggregation granularity."),
     dataType: z.string().optional().describe("Type of data returned."),
 });
 /**
@@ -125,6 +129,6 @@ export const UnitsOverviewSchema = z.object({
     walletTypeCode: z.string().optional().describe("Wallet type code."),
     header: UnitsOverviewHeaderSchema.optional().describe("Summary header metrics."),
     data: z.record(z.string(), z.unknown()).optional().describe("Time-series data points."),
-    aggregationType: z.enum(["day", "week", "month"]).optional().describe("Aggregation granularity."),
+    aggregationType: z.enum(["day", "week", "month", "year"]).optional().describe("Aggregation granularity."),
     dataType: z.string().optional().describe("Type of data returned."),
 });