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

MCP Server for Franchise API

import { dashboardBaseUrl, makeRequest } from '../../../common/index.js';
/**
 * Method information for dashboard location store item combo endpoints
 */
export const LocationStoreItemComboMethods = {
    list: {
        description: 'List store item combos for a store location',
        method: 'get',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos',
        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: 'ListLocationStoreItemCombosRequest',
        isMultipart: false,
        originalName: 'list',
        isWrite: false,
        permissions: ['store-menu-management:api:read'],
    },
    get: {
        description: 'Get a specific store item combo by unique name',
        method: 'get',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos/{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: 'Combo unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'GetLocationStoreItemComboRequest',
        isMultipart: false,
        originalName: 'get',
        isWrite: false,
        permissions: ['store-menu-management:api:read'],
    },
    getParents: {
        description: 'Get parent categories for a store item combo',
        method: 'get',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos/{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: 'Combo unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'GetLocationStoreItemComboParentsRequest',
        isMultipart: false,
        originalName: 'getParents',
        isWrite: false,
        permissions: ['store-menu-management:api:read'],
    },
    getChildren: {
        description: 'Get child entities for a store item combo',
        method: 'get',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos/{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: 'Combo unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'GetLocationStoreItemComboChildrenRequest',
        isMultipart: false,
        originalName: 'getChildren',
        isWrite: false,
        permissions: ['store-menu-management:api:read'],
    },
    create: {
        description: 'Create a new store item combo',
        method: 'post',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'CreateLocationStoreItemComboRequest',
        isMultipart: false,
        originalName: 'create',
        isWrite: true,
        permissions: ['store-menu-management:api:create'],
    },
    update: {
        description: 'Update a store item combo',
        method: 'put',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos/{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: 'Combo unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'UpdateLocationStoreItemComboRequest',
        isMultipart: false,
        originalName: 'update',
        isWrite: true,
        permissions: ['store-menu-management:api:update'],
    },
    patch: {
        description: 'Partially update a store item combo',
        method: 'patch',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos/{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: 'Combo unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'PatchLocationStoreItemComboRequest',
        isMultipart: false,
        originalName: 'patch',
        isWrite: true,
        permissions: ['store-menu-management:api:update'],
    },
    delete: {
        description: 'Delete a store item combo',
        method: 'delete',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos/{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: 'Combo unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'DeleteLocationStoreItemComboRequest',
        isMultipart: false,
        originalName: 'delete',
        isWrite: true,
        permissions: ['store-menu-management:api:delete'],
    },
    clone: {
        description: 'Clone a store item combo',
        method: 'post',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos/{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: 'Combo unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'CloneLocationStoreItemComboRequest',
        isMultipart: false,
        originalName: 'clone',
        isWrite: true,
        permissions: ['store-menu-management:api:create'],
    },
    updateProperties: {
        description: 'Update properties for a store item combo',
        method: 'put',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos/{uniqueName}/properties',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Combo unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'UpdateLocationStoreItemComboPropertiesRequest',
        isMultipart: false,
        originalName: 'updateProperties',
        isWrite: true,
        permissions: ['store-menu-management:api:update'],
    },
    updateCategories: {
        description: 'Update categories for a store item combo',
        method: 'put',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos/{uniqueName}/categories',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Combo unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'UpdateLocationStoreItemComboCategoriesRequest',
        isMultipart: false,
        originalName: 'updateCategories',
        isWrite: true,
        permissions: ['store-menu-management:api:update'],
    },
    updateItemSets: {
        description: 'Update item sets for a store item combo',
        method: 'put',
        path: '/storeItems/api/v2/merchants/{merchantId}/stores/{storeId}/combos/{uniqueName}/item-sets',
        pathParams: [
            {
                name: 'merchantId',
                type: 'string',
                description: 'Merchant ID',
                required: true,
            },
            {
                name: 'storeId',
                type: 'string',
                description: 'Store ID',
                required: true,
            },
            {
                name: 'uniqueName',
                type: 'string',
                description: 'Combo unique name',
                required: true,
            },
        ],
        queryParams: [],
        requestType: 'UpdateLocationStoreItemComboItemSetsRequest',
        isMultipart: false,
        originalName: 'updateItemSets',
        isWrite: true,
        permissions: ['store-menu-management:api:update'],
    },
};
/**
 * Handlers for dashboard location store item combo endpoints
 */
export const LocationStoreItemComboHandlers = {
    list: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.list, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    get: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.get, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    getParents: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.getParents, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    getChildren: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.getChildren, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    create: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.create, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    update: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.update, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    patch: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.patch, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    delete: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.delete, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    clone: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.clone, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    updateProperties: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.updateProperties, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    updateCategories: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.updateCategories, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
    updateItemSets: async (accessToken, args) => {
        return makeRequest(LocationStoreItemComboMethods.updateItemSets, {
            baseUrl: dashboardBaseUrl,
            accessToken,
            args,
        });
    },
};