@deliverart/sdk-js-point-of-sale 2.1.53 → 2.1.55

package/README.md

@@ -0,0 +1,281 @@
+# @deliverart/sdk-js-point-of-sale
+
+Point of Sale (POS) management package for the DeliverArt JavaScript SDK. Provides methods for managing points of sale, their users, menu versions, time overrides, and availability times.
+
+## Installation
+
+```bash
+npm install @deliverart/sdk-js-point-of-sale @deliverart/sdk-js-core
+# or
+pnpm add @deliverart/sdk-js-point-of-sale @deliverart/sdk-js-core
+# or
+yarn add @deliverart/sdk-js-point-of-sale @deliverart/sdk-js-core
+```
+
+## Features
+
+- **Points of Sale**: Full CRUD operations for points of sale with advanced filtering
+- **POS Users**: Manage users associated with points of sale
+- **POS Menu Versions**: Retrieve menu versions for specific points of sale
+- **POS Time Overrides**: Manage special opening hours and closures
+- **Availability Times**: Get available delivery and take-away time slots
+
+## Usage
+
+### Points of Sale
+
+#### Get Points of Sale
+
+```typescript
+import { GetPointOfSales } from '@deliverart/sdk-js-point-of-sale'
+
+const pointsOfSale = await client.call(new GetPointOfSales({
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+    company: 'company-iri',
+    salesMode: ['delivery', 'pickup'],
+  }
+}))
+```
+
+#### Location-Based Search
+
+You can filter points of sale by address or by geographic coordinates:
+
+```typescript
+// Filter by address
+const nearby = await client.call(new GetPointOfSales({
+  query: {
+    address: '123 Main St, New York, NY',
+    maxDistance: 5000, // meters
+  }
+}))
+
+// Filter by coordinates (latitude|longitude)
+const nearbyByCoords = await client.call(new GetPointOfSales({
+  query: {
+    location: '40.7128|-74.0060', // New York coordinates
+    maxDistance: 5000, // meters
+  }
+}))
+```
+
+**Note**: Both `address` and `location` are optional. If neither is provided, distance-based filtering will be skipped and all points of sale will be returned (subject to other filters).
+
+#### Get Company Points of Sale
+
+```typescript
+import { GetCompanyPointOfSales } from '@deliverart/sdk-js-point-of-sale'
+
+const companyPOS = await client.call(new GetCompanyPointOfSales('company-id', {
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+  }
+}))
+```
+
+#### Get Point of Sale Details
+
+```typescript
+import { GetPointOfSaleDetails } from '@deliverart/sdk-js-point-of-sale'
+
+const pos = await client.call(new GetPointOfSaleDetails('pos-id'))
+```
+
+#### Create Point of Sale
+
+```typescript
+import { CreatePointOfSale } from '@deliverart/sdk-js-point-of-sale'
+
+const newPOS = await client.call(new CreatePointOfSale({
+  name: [
+    { locale: 'en', value: 'Downtown Store' },
+    { locale: 'it', value: 'Negozio Centro' }
+  ],
+  company: '/api/companies/123',
+  address: {
+    street: '123 Main St',
+    city: 'New York',
+    postalCode: '10001',
+    country: 'US',
+  },
+  // ... other fields
+}))
+```
+
+#### Update Point of Sale
+
+```typescript
+import { UpdatePointOfSale } from '@deliverart/sdk-js-point-of-sale'
+
+const updated = await client.call(new UpdatePointOfSale('pos-id', {
+  name: [
+    { locale: 'en', value: 'Updated Store Name' }
+  ]
+}))
+```
+
+#### Delete Point of Sale
+
+```typescript
+import { DeletePointOfSale } from '@deliverart/sdk-js-point-of-sale'
+
+await client.call(new DeletePointOfSale('pos-id'))
+```
+
+### POS Menu Versions
+
+#### Get Point of Sale Menu Versions
+
+```typescript
+import { GetPointOfSaleMenuVersions } from '@deliverart/sdk-js-point-of-sale'
+
+const menuVersions = await client.call(new GetPointOfSaleMenuVersions('pos-id', {
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+  }
+}))
+```
+
+#### Get Point of Sale Menu Version Details
+
+```typescript
+import { GetPointOfSaleMenuVersionDetails } from '@deliverart/sdk-js-point-of-sale'
+
+const menuVersion = await client.call(new GetPointOfSaleMenuVersionDetails('pos-id', 'menu-version-id'))
+```
+
+### POS Users
+
+#### Get Point of Sale Users
+
+```typescript
+import { GetPointOfSaleUsers } from '@deliverart/sdk-js-point-of-sale'
+
+const users = await client.call(new GetPointOfSaleUsers({
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+  }
+}))
+```
+
+#### Get Point of Sale Users from Point of Sale
+
+```typescript
+import { GetPointOfSaleUsersFromPointOfSale } from '@deliverart/sdk-js-point-of-sale'
+
+const users = await client.call(new GetPointOfSaleUsersFromPointOfSale('pos-id', {
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+  }
+}))
+```
+
+#### Get Point of Sale Users from User
+
+```typescript
+import { GetPointOfSaleUsersFromUser } from '@deliverart/sdk-js-point-of-sale'
+
+const associations = await client.call(new GetPointOfSaleUsersFromUser('user-id', {
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+  }
+}))
+```
+
+#### Get Point of Sale User Details
+
+```typescript
+import { GetPointOfSaleUserDetails } from '@deliverart/sdk-js-point-of-sale'
+
+const userDetails = await client.call(new GetPointOfSaleUserDetails('pos-user-id'))
+```
+
+#### Update Point of Sale User
+
+```typescript
+import { UpdatePointOfSaleUser } from '@deliverart/sdk-js-point-of-sale'
+
+const updated = await client.call(new UpdatePointOfSaleUser('pos-user-id', {
+  role: 'manager',
+  // ... other fields
+}))
+```
+
+#### Delete Point of Sale User
+
+```typescript
+import { DeletePointOfSaleUser } from '@deliverart/sdk-js-point-of-sale'
+
+await client.call(new DeletePointOfSaleUser('pos-user-id'))
+```
+
+### Availability Times
+
+#### Get Available Delivery Times
+
+```typescript
+import { GetAvailablePointOfSaleDeliveryTimes } from '@deliverart/sdk-js-point-of-sale'
+
+const deliveryTimes = await client.call(new GetAvailablePointOfSaleDeliveryTimes('pos-id', {
+  query: {
+    date: '2025-10-18',
+  }
+}))
+```
+
+#### Get Available Take-Away Times
+
+```typescript
+import { GetAvailablePointOfSaleTakeAwayTimes } from '@deliverart/sdk-js-point-of-sale'
+
+const takeAwayTimes = await client.call(new GetAvailablePointOfSaleTakeAwayTimes('pos-id', {
+  query: {
+    date: '2025-10-18',
+  }
+}))
+```
+
+### POS Time Overrides
+
+Manage special opening hours, closures, and time exceptions for points of sale.
+
+```typescript
+import {
+  GetPointOfTimeOverrides,
+  GetPointOfTimeOverrideDetails,
+  CreatePointOfTimeOverride,
+  UpdatePointOfTimeOverride,
+  DeletePointOfTimeOverride
+} from '@deliverart/sdk-js-point-of-sale'
+
+// Get time overrides
+const overrides = await client.call(new GetPointOfTimeOverrides({
+  query: {
+    page: 1,
+    itemsPerPage: 20,
+    pointOfSale: '/api/point-of-sales/123',
+  }
+}))
+
+// Create a time override (e.g., holiday closure)
+const override = await client.call(new CreatePointOfTimeOverride({
+  pointOfSale: '/api/point-of-sales/123',
+  date: '2025-12-25',
+  closed: true,
+  reason: [
+    { locale: 'en', value: 'Christmas Day' },
+    { locale: 'it', value: 'Natale' }
+  ],
+}))
+```
+
+## License
+
+MIT

package/package.json

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