@deliverart/sdk-js-menu 2.1.53 → 2.1.55

package/README.md

@@ -0,0 +1,221 @@
+# @deliverart/sdk-js-menu
+
+Menu management package for the DeliverArt JavaScript SDK. Provides methods for managing menu versions, menu items, categories, modifiers, and price overrides.
+
+## Installation
+
+```bash
+npm install @deliverart/sdk-js-menu @deliverart/sdk-js-core
+# or
+pnpm add @deliverart/sdk-js-menu @deliverart/sdk-js-core
+# or
+yarn add @deliverart/sdk-js-menu @deliverart/sdk-js-core
+```
+
+## Features
+
+- **Menu Versions**: Retrieve menu versions and their details
+- **Menu Items**: Full CRUD operations for menu items
+- **Menu Item Categories**: Manage menu item categories
+- **Menu Item Modifiers**: Retrieve menu item modifiers and their details
+- **Menu Item Price Overrides**: Manage price overrides for menu items
+
+## Usage
+
+### Menu Versions
+
+#### Get Menu Versions
+
+```typescript
+import { GetMenuVersions } from '@deliverart/sdk-js-menu'
+
+const menuVersions = await client.call(new GetMenuVersions({
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+  }
+}))
+```
+
+#### Get Menu Version Details
+
+```typescript
+import { GetMenuVersionDetails } from '@deliverart/sdk-js-menu'
+
+const menuVersion = await client.call(new GetMenuVersionDetails('menu-version-id'))
+```
+
+### Menu Items
+
+#### Get Menu Items
+
+```typescript
+import { GetMenuItems } from '@deliverart/sdk-js-menu'
+
+const menuItems = await client.call(new GetMenuItems({
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+  }
+}))
+```
+
+#### Get Menu Item Details
+
+```typescript
+import { GetMenuItemDetails } from '@deliverart/sdk-js-menu'
+
+const menuItem = await client.call(new GetMenuItemDetails('menu-item-id'))
+```
+
+#### Create Menu Item
+
+```typescript
+import { CreateMenuItem } from '@deliverart/sdk-js-menu'
+
+const newMenuItem = await client.call(new CreateMenuItem({
+  name: [
+    { locale: 'en', value: 'Margherita Pizza' },
+    { locale: 'it', value: 'Pizza Margherita' }
+  ],
+  description: [
+    { locale: 'en', value: 'Classic tomato and mozzarella' },
+    { locale: 'it', value: 'Classica pomodoro e mozzarella' }
+  ],
+  price: 12.99,
+  category: '/api/menu-item-categories/123',
+  // ... other fields
+}))
+```
+
+#### Update Menu Item
+
+```typescript
+import { UpdateMenuItem } from '@deliverart/sdk-js-menu'
+
+const updated = await client.call(new UpdateMenuItem('menu-item-id', {
+  price: 13.99,
+}))
+```
+
+#### Delete Menu Item
+
+```typescript
+import { DeleteMenuItem } from '@deliverart/sdk-js-menu'
+
+await client.call(new DeleteMenuItem('menu-item-id'))
+```
+
+### Menu Item Categories
+
+#### Get Menu Item Categories
+
+```typescript
+import { GetMenuItemCategories } from '@deliverart/sdk-js-menu'
+
+const categories = await client.call(new GetMenuItemCategories({
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+  }
+}))
+```
+
+#### Get Menu Item Category Details
+
+```typescript
+import { GetMenuItemCategoryDetails } from '@deliverart/sdk-js-menu'
+
+const category = await client.call(new GetMenuItemCategoryDetails('category-id'))
+```
+
+#### Create Menu Item Category
+
+```typescript
+import { CreateMenuItemCategory } from '@deliverart/sdk-js-menu'
+
+const newCategory = await client.call(new CreateMenuItemCategory({
+  name: [
+    { locale: 'en', value: 'Pizzas' },
+    { locale: 'it', value: 'Pizze' }
+  ],
+  // ... other fields
+}))
+```
+
+#### Update Menu Item Category
+
+```typescript
+import { UpdateMenuItemCategory } from '@deliverart/sdk-js-menu'
+
+const updated = await client.call(new UpdateMenuItemCategory('category-id', {
+  name: [
+    { locale: 'en', value: 'Updated Category' }
+  ]
+}))
+```
+
+#### Delete Menu Item Category
+
+```typescript
+import { DeleteMenuItemCategory } from '@deliverart/sdk-js-menu'
+
+await client.call(new DeleteMenuItemCategory('category-id'))
+```
+
+### Menu Item Modifiers
+
+#### Get Menu Item Modifiers
+
+```typescript
+import { GetMenuItemModifiers } from '@deliverart/sdk-js-menu'
+
+const modifiers = await client.call(new GetMenuItemModifiers({
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+  }
+}))
+```
+
+#### Get Menu Item Modifier Details
+
+```typescript
+import { GetMenuItemModifierDetails } from '@deliverart/sdk-js-menu'
+
+const modifier = await client.call(new GetMenuItemModifierDetails('modifier-id'))
+```
+
+### Menu Item Price Overrides
+
+Manage price overrides for specific menu items, points of sale, or time periods.
+
+```typescript
+import { 
+  GetMenuItemPriceOverrides,
+  GetMenuItemPriceOverrideDetails,
+  CreateMenuItemPriceOverride,
+  UpdateMenuItemPriceOverride,
+  DeleteMenuItemPriceOverride
+} from '@deliverart/sdk-js-menu'
+
+// Get price overrides
+const overrides = await client.call(new GetMenuItemPriceOverrides({
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+  }
+}))
+
+// Create a price override
+const override = await client.call(new CreateMenuItemPriceOverride({
+  menuItem: '/api/menu-items/123',
+  price: 15.99,
+  pointOfSale: '/api/point-of-sales/456',
+  // ... other fields
+}))
+```
+
+## License
+
+MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@deliverart/sdk-js-menu",
   "description": "Deliverart JavaScript SDK for Menu Management",
-  "version": "2.1.53",
+  "version": "2.1.55",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,11 +18,11 @@
     "dist"
   ],
   "dependencies": {
-    "@deliverart/sdk-js-core": "2.1.53",
-    "@deliverart/sdk-js-sales-mode": "2.1.53",
-    "@deliverart/sdk-js-image": "2.1.53",
-    "@deliverart/sdk-js-point-of-sale": "2.1.53",
-    "@deliverart/sdk-js-global-types": "2.1.53"
+    "@deliverart/sdk-js-core": "2.1.55",
+    "@deliverart/sdk-js-global-types": "2.1.55",
+    "@deliverart/sdk-js-image": "2.1.55",
+    "@deliverart/sdk-js-sales-mode": "2.1.55",
+    "@deliverart/sdk-js-point-of-sale": "2.1.55"
   },
   "publishConfig": {
     "access": "public"