@open-loyalty/mcp-server 1.0.0

package/dist/tools/export.d.ts

@@ -0,0 +1,110 @@
+import { z } from "zod";
+export interface Export {
+    exportId: string;
+    type?: string;
+    status?: string;
+    createdAt?: string;
+    finishedAt?: string;
+    criteria?: string;
+    exportedRows?: number;
+    message?: string;
+}
+export interface ExportListResponse {
+    items: Export[];
+    total?: {
+        all?: number | string;
+        filtered?: number | string;
+        estimated?: boolean;
+    };
+}
+export declare const ExportCreateInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    type: z.ZodEnum<["campaignCode", "member", "memberTier", "memberSegment", "rewardFulfillment"]>;
+    filters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    page: z.ZodOptional<z.ZodNumber>;
+    perPage: z.ZodOptional<z.ZodNumber>;
+};
+export declare const ExportListInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    page: z.ZodOptional<z.ZodNumber>;
+    perPage: z.ZodOptional<z.ZodNumber>;
+    exportId: z.ZodOptional<z.ZodString>;
+    type: z.ZodOptional<z.ZodEnum<["campaignCode", "member", "memberTier", "memberSegment", "rewardFulfillment"]>>;
+    status: z.ZodOptional<z.ZodEnum<["pending", "done", "failed", "error"]>>;
+};
+export declare const ExportGetInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    exportId: z.ZodString;
+};
+export declare const ExportDownloadInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    exportId: z.ZodString;
+};
+export declare function exportCreate(input: {
+    storeCode?: string;
+    type: string;
+    filters?: Record<string, unknown>;
+    page?: number;
+    perPage?: number;
+}): Promise<{
+    exportId: string;
+}>;
+export declare function exportList(input: {
+    storeCode?: string;
+    page?: number;
+    perPage?: number;
+    exportId?: string;
+    type?: string;
+    status?: string;
+}): Promise<ExportListResponse>;
+export declare function exportGet(input: {
+    storeCode?: string;
+    exportId: string;
+}): Promise<Export>;
+export declare function exportDownload(input: {
+    storeCode?: string;
+    exportId: string;
+}): Promise<{
+    content: string;
+    contentType: string;
+}>;
+export declare const exportToolDefinitions: readonly [{
+    readonly name: "openloyalty_export_create";
+    readonly description: "Create a new data export. Returns exportId for async tracking. Export types: campaignCode (campaign redemption codes), member (member data), memberTier (member tier assignments), memberSegment (member segment membership), rewardFulfillment (reward fulfillment records). The export runs asynchronously - use export_get to check status and export_download when status is 'done'.";
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        type: z.ZodEnum<["campaignCode", "member", "memberTier", "memberSegment", "rewardFulfillment"]>;
+        filters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        page: z.ZodOptional<z.ZodNumber>;
+        perPage: z.ZodOptional<z.ZodNumber>;
+    };
+    readonly handler: typeof exportCreate;
+}, {
+    readonly name: "openloyalty_export_list";
+    readonly description: "List exports with optional filtering. Returns paginated list of exports with exportId, type, status, createdAt, and finishedAt. Status values: pending, done, failed, error.";
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        page: z.ZodOptional<z.ZodNumber>;
+        perPage: z.ZodOptional<z.ZodNumber>;
+        exportId: z.ZodOptional<z.ZodString>;
+        type: z.ZodOptional<z.ZodEnum<["campaignCode", "member", "memberTier", "memberSegment", "rewardFulfillment"]>>;
+        status: z.ZodOptional<z.ZodEnum<["pending", "done", "failed", "error"]>>;
+    };
+    readonly handler: typeof exportList;
+}, {
+    readonly name: "openloyalty_export_get";
+    readonly description: "Get export details and status. Returns exportId, type, status, createdAt, finishedAt, exportedRows, and message. Check status before downloading - export must have status 'done'.";
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        exportId: z.ZodString;
+    };
+    readonly handler: typeof exportGet;
+}, {
+    readonly name: "openloyalty_export_download";
+    readonly description: "Download export file content. Returns CSV content. IMPORTANT: Only available when export status is 'done'. Check status with export_get first.";
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        exportId: z.ZodString;
+    };
+    readonly handler: typeof exportDownload;
+}];

package/dist/tools/export.js

@@ -0,0 +1,147 @@
+import { z } from "zod";
+import { apiGet, apiPost } from "../client/http.js";
+import { formatApiError } from "../utils/errors.js";
+import { getConfig } from "../config.js";
+import axios from "axios";
+// Input Schemas
+export const ExportCreateInputSchema = {
+    storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
+    type: z.enum([
+        "campaignCode",
+        "member",
+        "memberTier",
+        "memberSegment",
+        "rewardFulfillment",
+    ]).describe("Export type. Options: campaignCode, member, memberTier, memberSegment, rewardFulfillment."),
+    filters: z.record(z.unknown()).optional().describe("Type-specific filters. For campaignCode: { campaignId?, code?, status?, codeId?, usedByMemberId?, createdAt?, usedAt? }. Filters vary by export type."),
+    page: z.number().optional().describe("Page number for export (included in export criteria)."),
+    perPage: z.number().optional().describe("Items per page for export."),
+};
+export const ExportListInputSchema = {
+    storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
+    page: z.number().optional().describe("Page number (default: 1)."),
+    perPage: z.number().optional().describe("Items per page (default: 25)."),
+    exportId: z.string().optional().describe("Filter by export ID."),
+    type: z.enum([
+        "campaignCode",
+        "member",
+        "memberTier",
+        "memberSegment",
+        "rewardFulfillment",
+    ]).optional().describe("Filter by export type."),
+    status: z.enum(["pending", "done", "failed", "error"]).optional().describe("Filter by export status."),
+};
+export const ExportGetInputSchema = {
+    storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
+    exportId: z.string().describe("The export ID (UUID) to retrieve."),
+};
+export const ExportDownloadInputSchema = {
+    storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
+    exportId: z.string().describe("The export ID (UUID) to download. Export must have status 'done'."),
+};
+// Handler functions
+export async function exportCreate(input) {
+    const config = getConfig();
+    const storeCode = input.storeCode || config.defaultStoreCode;
+    // Build the payload with type-specific wrapper
+    // The API expects { [type]: { ...filters, _page?, _itemsOnPage? } }
+    const innerPayload = {
+        ...(input.filters || {}),
+    };
+    if (input.page)
+        innerPayload._page = input.page;
+    if (input.perPage)
+        innerPayload._itemsOnPage = input.perPage;
+    const payload = {
+        [input.type]: innerPayload,
+    };
+    try {
+        const response = await apiPost(`/${storeCode}/export/${input.type}`, payload);
+        return response;
+    }
+    catch (error) {
+        throw formatApiError(error, "openloyalty_export_create");
+    }
+}
+export async function exportList(input) {
+    const config = getConfig();
+    const storeCode = input.storeCode || config.defaultStoreCode;
+    const params = new URLSearchParams();
+    if (input.page)
+        params.append("_page", String(input.page));
+    if (input.perPage)
+        params.append("_itemsOnPage", String(input.perPage));
+    if (input.exportId)
+        params.append("exportId", input.exportId);
+    if (input.type)
+        params.append("type", input.type);
+    if (input.status)
+        params.append("status", input.status);
+    const queryString = params.toString();
+    const url = `/${storeCode}/export${queryString ? `?${queryString}` : ""}`;
+    try {
+        const response = await apiGet(url);
+        return response;
+    }
+    catch (error) {
+        throw formatApiError(error, "openloyalty_export_list");
+    }
+}
+export async function exportGet(input) {
+    const config = getConfig();
+    const storeCode = input.storeCode || config.defaultStoreCode;
+    try {
+        const response = await apiGet(`/${storeCode}/export/${input.exportId}`);
+        return response;
+    }
+    catch (error) {
+        throw formatApiError(error, "openloyalty_export_get");
+    }
+}
+export async function exportDownload(input) {
+    const config = getConfig();
+    const storeCode = input.storeCode || config.defaultStoreCode;
+    try {
+        const response = await axios.get(`${config.apiUrl}/${storeCode}/export/${input.exportId}/download`, {
+            headers: {
+                "X-AUTH-TOKEN": config.apiToken,
+                "Accept": "text/csv",
+            },
+            responseType: "text",
+        });
+        return {
+            content: response.data,
+            contentType: response.headers["content-type"] || "text/csv",
+        };
+    }
+    catch (error) {
+        throw formatApiError(error, "openloyalty_export_download");
+    }
+}
+// Tool definitions
+export const exportToolDefinitions = [
+    {
+        name: "openloyalty_export_create",
+        description: "Create a new data export. Returns exportId for async tracking. Export types: campaignCode (campaign redemption codes), member (member data), memberTier (member tier assignments), memberSegment (member segment membership), rewardFulfillment (reward fulfillment records). The export runs asynchronously - use export_get to check status and export_download when status is 'done'.",
+        inputSchema: ExportCreateInputSchema,
+        handler: exportCreate,
+    },
+    {
+        name: "openloyalty_export_list",
+        description: "List exports with optional filtering. Returns paginated list of exports with exportId, type, status, createdAt, and finishedAt. Status values: pending, done, failed, error.",
+        inputSchema: ExportListInputSchema,
+        handler: exportList,
+    },
+    {
+        name: "openloyalty_export_get",
+        description: "Get export details and status. Returns exportId, type, status, createdAt, finishedAt, exportedRows, and message. Check status before downloading - export must have status 'done'.",
+        inputSchema: ExportGetInputSchema,
+        handler: exportGet,
+    },
+    {
+        name: "openloyalty_export_download",
+        description: "Download export file content. Returns CSV content. IMPORTANT: Only available when export status is 'done'. Check status with export_get first.",
+        inputSchema: ExportDownloadInputSchema,
+        handler: exportDownload,
+    },
+];

package/dist/tools/import.d.ts

@@ -0,0 +1,110 @@
+import { z } from "zod";
+export interface Import {
+    importId: string;
+    type?: string;
+    uploadedDate?: string;
+    fileName?: string;
+    itemsToImport?: number;
+    user?: string;
+    errorMessage?: string;
+    additionalData?: Record<string, string>;
+}
+export interface ImportItem {
+    importId?: string;
+    status?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    message?: string;
+    entity?: {
+        id?: string;
+        data?: Record<string, unknown>;
+    };
+}
+export interface ImportListResponse {
+    items: Import[];
+    total?: {
+        all?: number | string;
+        filtered?: number | string;
+        estimated?: boolean | number;
+    };
+}
+export interface ImportDetailsResponse {
+    items: ImportItem[];
+    total?: {
+        all?: number | string;
+        filtered?: number | string;
+        estimated?: boolean | number;
+    };
+}
+export declare const ImportCreateInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    type: z.ZodEnum<["member", "groupValue", "segmentMembers", "unitTransferAdding", "unitTransferSpending", "transaction", "campaignCode", "rewardCoupon"]>;
+    fileContent: z.ZodString;
+    fileName: z.ZodOptional<z.ZodString>;
+};
+export declare const ImportListInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    page: z.ZodOptional<z.ZodNumber>;
+    perPage: z.ZodOptional<z.ZodNumber>;
+    importId: z.ZodOptional<z.ZodString>;
+    type: z.ZodOptional<z.ZodEnum<["member", "groupValue", "segmentMembers", "unitTransferAdding", "unitTransferSpending", "transaction", "campaignCode", "rewardCoupon"]>>;
+};
+export declare const ImportGetInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    importId: z.ZodString;
+    page: z.ZodOptional<z.ZodNumber>;
+    perPage: z.ZodOptional<z.ZodNumber>;
+};
+export declare function importCreate(input: {
+    storeCode?: string;
+    type: string;
+    fileContent: string;
+    fileName?: string;
+}): Promise<{
+    importId: string;
+}>;
+export declare function importList(input: {
+    storeCode?: string;
+    page?: number;
+    perPage?: number;
+    importId?: string;
+    type?: string;
+}): Promise<ImportListResponse>;
+export declare function importGet(input: {
+    storeCode?: string;
+    importId: string;
+    page?: number;
+    perPage?: number;
+}): Promise<ImportDetailsResponse>;
+export declare const importToolDefinitions: readonly [{
+    readonly name: "openloyalty_import_create";
+    readonly description: "Create a new bulk import from CSV content. Returns importId for async tracking. Import types: member (member data), groupValue (group values), segmentMembers (segment membership), unitTransferAdding (add points), unitTransferSpending (spend points), transaction (transactions), campaignCode (campaign codes), rewardCoupon (reward coupons). CSV format required - provide plain text CSV content.";
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        type: z.ZodEnum<["member", "groupValue", "segmentMembers", "unitTransferAdding", "unitTransferSpending", "transaction", "campaignCode", "rewardCoupon"]>;
+        fileContent: z.ZodString;
+        fileName: z.ZodOptional<z.ZodString>;
+    };
+    readonly handler: typeof importCreate;
+}, {
+    readonly name: "openloyalty_import_list";
+    readonly description: "List imports with optional filtering. Returns paginated list of imports with importId, type, uploadedDate, fileName, and status information.";
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        page: z.ZodOptional<z.ZodNumber>;
+        perPage: z.ZodOptional<z.ZodNumber>;
+        importId: z.ZodOptional<z.ZodString>;
+        type: z.ZodOptional<z.ZodEnum<["member", "groupValue", "segmentMembers", "unitTransferAdding", "unitTransferSpending", "transaction", "campaignCode", "rewardCoupon"]>>;
+    };
+    readonly handler: typeof importList;
+}, {
+    readonly name: "openloyalty_import_get";
+    readonly description: "Get import details and individual item statuses. Returns paginated list of import items with their success/failure status and error messages.";
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        importId: z.ZodString;
+        page: z.ZodOptional<z.ZodNumber>;
+        perPage: z.ZodOptional<z.ZodNumber>;
+    };
+    readonly handler: typeof importGet;
+}];

package/dist/tools/import.js

@@ -0,0 +1,126 @@
+import { z } from "zod";
+import { apiGet } from "../client/http.js";
+import { formatApiError } from "../utils/errors.js";
+import { getConfig } from "../config.js";
+import axios from "axios";
+// Input Schemas
+export const ImportCreateInputSchema = {
+    storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
+    type: z.enum([
+        "member",
+        "groupValue",
+        "segmentMembers",
+        "unitTransferAdding",
+        "unitTransferSpending",
+        "transaction",
+        "campaignCode",
+        "rewardCoupon",
+    ]).describe("Import type. Options: member, groupValue, segmentMembers, unitTransferAdding, unitTransferSpending, transaction, campaignCode, rewardCoupon."),
+    fileContent: z.string().describe("CSV file content (plain text, not base64 encoded). Each line should be a comma-separated row."),
+    fileName: z.string().optional().describe("Optional file name for the import (default: import.csv)."),
+};
+export const ImportListInputSchema = {
+    storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
+    page: z.number().optional().describe("Page number (default: 1)."),
+    perPage: z.number().optional().describe("Items per page (default: 25)."),
+    importId: z.string().optional().describe("Filter by import ID."),
+    type: z.enum([
+        "member",
+        "groupValue",
+        "segmentMembers",
+        "unitTransferAdding",
+        "unitTransferSpending",
+        "transaction",
+        "campaignCode",
+        "rewardCoupon",
+    ]).optional().describe("Filter by import type."),
+};
+export const ImportGetInputSchema = {
+    storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
+    importId: z.string().describe("The import ID (UUID) to retrieve."),
+    page: z.number().optional().describe("Page number for import items (default: 1)."),
+    perPage: z.number().optional().describe("Items per page for import items (default: 25)."),
+};
+// Handler functions
+export async function importCreate(input) {
+    const config = getConfig();
+    const storeCode = input.storeCode || config.defaultStoreCode;
+    const fileName = input.fileName || "import.csv";
+    // Create form data for multipart upload
+    const formData = new FormData();
+    const blob = new Blob([input.fileContent], { type: "text/csv" });
+    formData.append("file", blob, fileName);
+    try {
+        const response = await axios.post(`${config.apiUrl}/${storeCode}/import/${input.type}`, formData, {
+            headers: {
+                "X-AUTH-TOKEN": config.apiToken,
+                "Content-Type": "multipart/form-data",
+            },
+        });
+        return response.data;
+    }
+    catch (error) {
+        throw formatApiError(error, "openloyalty_import_create");
+    }
+}
+export async function importList(input) {
+    const config = getConfig();
+    const storeCode = input.storeCode || config.defaultStoreCode;
+    const params = new URLSearchParams();
+    if (input.page)
+        params.append("_page", String(input.page));
+    if (input.perPage)
+        params.append("_itemsOnPage", String(input.perPage));
+    if (input.importId)
+        params.append("importId", input.importId);
+    if (input.type)
+        params.append("type", input.type);
+    const queryString = params.toString();
+    const url = `/${storeCode}/import${queryString ? `?${queryString}` : ""}`;
+    try {
+        const response = await apiGet(url);
+        return response;
+    }
+    catch (error) {
+        throw formatApiError(error, "openloyalty_import_list");
+    }
+}
+export async function importGet(input) {
+    const config = getConfig();
+    const storeCode = input.storeCode || config.defaultStoreCode;
+    const params = new URLSearchParams();
+    if (input.page)
+        params.append("_page", String(input.page));
+    if (input.perPage)
+        params.append("_itemsOnPage", String(input.perPage));
+    const queryString = params.toString();
+    const url = `/${storeCode}/import/${input.importId}${queryString ? `?${queryString}` : ""}`;
+    try {
+        const response = await apiGet(url);
+        return response;
+    }
+    catch (error) {
+        throw formatApiError(error, "openloyalty_import_get");
+    }
+}
+// Tool definitions
+export const importToolDefinitions = [
+    {
+        name: "openloyalty_import_create",
+        description: "Create a new bulk import from CSV content. Returns importId for async tracking. Import types: member (member data), groupValue (group values), segmentMembers (segment membership), unitTransferAdding (add points), unitTransferSpending (spend points), transaction (transactions), campaignCode (campaign codes), rewardCoupon (reward coupons). CSV format required - provide plain text CSV content.",
+        inputSchema: ImportCreateInputSchema,
+        handler: importCreate,
+    },
+    {
+        name: "openloyalty_import_list",
+        description: "List imports with optional filtering. Returns paginated list of imports with importId, type, uploadedDate, fileName, and status information.",
+        inputSchema: ImportListInputSchema,
+        handler: importList,
+    },
+    {
+        name: "openloyalty_import_get",
+        description: "Get import details and individual item statuses. Returns paginated list of import items with their success/failure status and error messages.",
+        inputSchema: ImportGetInputSchema,
+        handler: importGet,
+    },
+];

package/dist/tools/index.d.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+type ZodShape = Record<string, z.ZodTypeAny>;
+export interface ToolAnnotations {
+    title?: string;
+    readOnlyHint?: boolean;
+    destructiveHint?: boolean;
+    idempotentHint?: boolean;
+    openWorldHint?: boolean;
+}
+export interface ToolDefinition {
+    name: string;
+    description: string;
+    inputSchema: ZodShape;
+    handler: (args: Record<string, unknown>) => Promise<unknown>;
+}
+export declare const toolMetadata: Record<string, {
+    title: string;
+    annotations: ToolAnnotations;
+}>;
+export declare function getAllTools(): ToolDefinition[];
+export declare function getToolHandler(name: string): ((args: Record<string, unknown>) => Promise<unknown>) | undefined;
+export {};