@goparrot/franchise-mcp-server
Version:
MCP Server for Franchise API
361 lines (360 loc) • 11.1 kB
JavaScript
import { dashboardBaseUrl, makeRequest } from '../../../common/index.js';
/**
* Method information for dashboard location item base endpoints
*/
export const LocationItemBaseMethods = {
list: {
description: 'List base items for a store location',
method: 'get',
path: '/storeItems/api/v2/merchant/{merchantId}/store/{storeId}/item-base',
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: 'ListLocationItemBasesRequest',
isMultipart: false,
originalName: 'list',
isWrite: false,
permissions: ['store-menu-management:api:read'],
},
get: {
description: 'Get a specific base item by unique name',
method: 'get',
path: '/storeItems/api/v2/merchant/{merchantId}/store/{storeId}/item-base/{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: 'Item unique name',
required: true,
},
],
queryParams: [],
requestType: 'GetLocationItemBaseRequest',
isMultipart: false,
originalName: 'get',
isWrite: false,
permissions: ['store-menu-management:api:read'],
},
getParents: {
description: 'Get parent items for a base item',
method: 'get',
path: '/storeItems/api/v2/merchant/{merchantId}/store/{storeId}/item-base/{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: 'Item unique name',
required: true,
},
],
queryParams: [],
requestType: 'GetLocationItemBaseParentsRequest',
isMultipart: false,
originalName: 'getParents',
isWrite: false,
permissions: ['store-menu-management:api:read'],
},
create: {
description: 'Create a new base item',
method: 'post',
path: '/storeItems/api/v2/merchant/{merchantId}/store/{storeId}/item-base',
pathParams: [
{
name: 'merchantId',
type: 'string',
description: 'Merchant ID',
required: true,
},
{
name: 'storeId',
type: 'string',
description: 'Store ID',
required: true,
},
],
queryParams: [],
requestType: 'CreateLocationItemBaseRequest',
isMultipart: false,
originalName: 'create',
isWrite: true,
permissions: ['store-menu-management:api:create'],
},
update: {
description: 'Update a base item',
method: 'put',
path: '/storeItems/api/v2/merchant/{merchantId}/store/{storeId}/item-base/{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: 'Item unique name',
required: true,
},
],
queryParams: [],
requestType: 'UpdateLocationItemBaseRequest',
isMultipart: false,
originalName: 'update',
isWrite: true,
permissions: ['store-menu-management:api:update'],
},
patch: {
description: 'Partially update a base item',
method: 'patch',
path: '/storeItems/api/v2/merchant/{merchantId}/store/{storeId}/item-base/{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: 'Item unique name',
required: true,
},
],
queryParams: [],
requestType: 'PatchLocationItemBaseRequest',
isMultipart: false,
originalName: 'patch',
isWrite: true,
permissions: ['store-menu-management:api:update'],
},
delete: {
description: 'Delete a base item',
method: 'delete',
path: '/storeItems/api/v2/merchant/{merchantId}/store/{storeId}/item-base/{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: 'Item unique name',
required: true,
},
],
queryParams: [],
requestType: 'DeleteLocationItemBaseRequest',
isMultipart: false,
originalName: 'delete',
isWrite: true,
permissions: ['store-menu-management:api:delete'],
},
clone: {
description: 'Clone a base item',
method: 'post',
path: '/storeItems/api/v2/merchant/{merchantId}/store/{storeId}/item-base/{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: 'Item unique name',
required: true,
},
],
queryParams: [],
requestType: 'CloneLocationItemBaseRequest',
isMultipart: false,
originalName: 'clone',
isWrite: true,
permissions: ['store-menu-management:api:create'],
},
updateItemOptionsSelections: {
description: 'Update item options selections',
method: 'patch',
path: '/storeItems/api/v2/merchant/{merchantId}/store/{storeId}/item-base/{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: 'Item unique name',
required: true,
},
],
queryParams: [],
requestType: 'UpdateItemOptionsSelectionsRequest',
isMultipart: false,
originalName: 'updateItemOptionsSelections',
isWrite: true,
permissions: ['store-menu-management:api:update'],
},
};
/**
* Handlers for dashboard location item base endpoints
*/
export const LocationItemBaseHandlers = {
list: async (accessToken, args) => {
return makeRequest(LocationItemBaseMethods.list, {
baseUrl: dashboardBaseUrl,
accessToken,
args,
});
},
get: async (accessToken, args) => {
return makeRequest(LocationItemBaseMethods.get, {
baseUrl: dashboardBaseUrl,
accessToken,
args,
});
},
getParents: async (accessToken, args) => {
return makeRequest(LocationItemBaseMethods.getParents, {
baseUrl: dashboardBaseUrl,
accessToken,
args,
});
},
create: async (accessToken, args) => {
return makeRequest(LocationItemBaseMethods.create, {
baseUrl: dashboardBaseUrl,
accessToken,
args,
});
},
update: async (accessToken, args) => {
return makeRequest(LocationItemBaseMethods.update, {
baseUrl: dashboardBaseUrl,
accessToken,
args,
});
},
patch: async (accessToken, args) => {
return makeRequest(LocationItemBaseMethods.patch, {
baseUrl: dashboardBaseUrl,
accessToken,
args,
});
},
delete: async (accessToken, args) => {
return makeRequest(LocationItemBaseMethods.delete, {
baseUrl: dashboardBaseUrl,
accessToken,
args,
});
},
clone: async (accessToken, args) => {
return makeRequest(LocationItemBaseMethods.clone, {
baseUrl: dashboardBaseUrl,
accessToken,
args,
});
},
updateItemOptionsSelections: async (accessToken, args) => {
return makeRequest(LocationItemBaseMethods.updateItemOptionsSelections, {
baseUrl: dashboardBaseUrl,
accessToken,
args,
});
},
};