@goparrot/franchise-mcp-server/dist/src/dashboard/services/storeitems/location-item-base-group.js

MCP Server for Franchise API

import { dashboardBaseUrl, makeRequest } from '../../../common/index.js';
/**
 * Method information for dashboard location item base group endpoints
 */
export const LocationItemBaseGroupMethods = {
    list: {
        description: 'List item base groups for a store location',
        method: 'get',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
        ],
        queryParams: [
            {
                name: 'page',
                type: 'number',
                description: 'Page number',
                required: false,
            },
            {
                name: 'limit',
                type: 'number',
                description: 'Items per page',
                required: false,
            },
            {
                name: 'filter',
                type: 'object',
                description: 'Filter parameters',
                required: false,
            },
        ],
        requestType: 'ListLocationItemBaseGroupsRequest',
        isMultipart: false,
        originalName: 'list',
        isWrite: false,
        permissions: ['store-menu-management:api:read'],
    },
    get: {
        description: 'Get a specific item base group by unique name',
        method: 'get',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups/{uniqueName}',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Group unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'GetLocationItemBaseGroupRequest',
        isMultipart: false,
        originalName: 'get',
        isWrite: false,
        permissions: ['store-menu-management:api:read'],
    },
    getParents: {
        description: 'Get parent items for a base group',
        method: 'get',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups/{uniqueName}/parents',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Group unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'GetLocationItemBaseGroupParentsRequest',
        isMultipart: false,
        originalName: 'getParents',
        isWrite: false,
        permissions: ['store-menu-management:api:read'],
    },
    getChildren: {
        description: 'Get child items for a base group',
        method: 'get',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups/{uniqueName}/children',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Group unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'GetLocationItemBaseGroupChildrenRequest',
        isMultipart: false,
        originalName: 'getChildren',
        isWrite: false,
        permissions: ['store-menu-management:api:read'],
    },
    create: {
        description: 'Create a new item base group',
        method: 'post',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'CreateLocationItemBaseGroupRequest',
        isMultipart: false,
        originalName: 'create',
        isWrite: true,
        permissions: ['store-menu-management:api:create'],
    },
    update: {
        description: 'Update an item base group',
        method: 'put',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups/{uniqueName}',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Group unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'UpdateLocationItemBaseGroupRequest',
        isMultipart: false,
        originalName: 'update',
        isWrite: true,
        permissions: ['store-menu-management:api:update'],
    },
    patch: {
        description: 'Partially update an item base group',
        method: 'patch',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups/{uniqueName}',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Group unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'PatchLocationItemBaseGroupRequest',
        isMultipart: false,
        originalName: 'patch',
        isWrite: true,
        permissions: ['store-menu-management:api:update'],
    },
    delete: {
        description: 'Delete an item base group',
        method: 'delete',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups/{uniqueName}',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Group unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'DeleteLocationItemBaseGroupRequest',
        isMultipart: false,
        originalName: 'delete',
        isWrite: true,
        permissions: ['store-menu-management:api:delete'],
    },
    updateSelections: {
        description: 'Update item base selections for a group',
        method: 'patch',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups/{uniqueName}/item-bases',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Group unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'UpdateLocationItemBaseGroupSelectionsRequest',
        isMultipart: false,
        originalName: 'updateSelections',
        isWrite: true,
        permissions: ['store-menu-management:api:update'],
    },
    updateItemOptionSelections: {
        description: 'Update item option selections for a group',
        method: 'patch',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups/{uniqueName}/item-options',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Group unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'UpdateLocationItemBaseGroupOptionSelectionsRequest',
        isMultipart: false,
        originalName: 'updateItemOptionSelections',
        isWrite: true,
        permissions: ['store-menu-management:api:update'],
    },
    clone: {
        description: 'Clone an item base group',
        method: 'post',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/item-base-groups/{uniqueName}/clone',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Group unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'CloneLocationItemBaseGroupRequest',
        isMultipart: false,
        originalName: 'clone',
        isWrite: true,
        permissions: ['store-menu-management:api:create'],
    },
};
/**
 * Handlers for dashboard location item base group endpoints
 */
export const LocationItemBaseGroupHandlers = {
    list: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.list, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    get: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.get, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    getParents: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.getParents, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    getChildren: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.getChildren, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    create: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.create, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    update: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.update, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    patch: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.patch, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    delete: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.delete, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    updateSelections: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.updateSelections, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    updateItemOptionSelections: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.updateItemOptionSelections, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    clone: async (accessToken, args) => {
        return makeRequest(LocationItemBaseGroupMethods.clone, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
};