@deliverart/sdk-js-email-notification-configuration 2.8.9

package/README.md

@@ -0,0 +1,117 @@
+# @deliverart/sdk-js-email-notification-configuration
+
+Email notification configuration management package for the DeliverArt JavaScript SDK.
+
+## Installation
+
+```bash
+npm install @deliverart/sdk-js-email-notification-configuration @deliverart/sdk-js-core
+```
+
+## Exported Types
+
+### Core Types
+- `EmailNotificationConfiguration` - Email notification configuration
+- `EmailNotificationConfigConfig` - Configuration object containing notification settings
+
+### Template Keys
+Available email template keys:
+- `delivery_started` - Notification when delivery starts
+- `delivery_taken_over` - Notification when delivery is taken over
+- `order_created` - Notification when order is created
+- `order_delivered` - Notification when order is delivered
+- `order_in_preparation` - Notification when order enters preparation
+- `order_preparation_done` - Notification when order preparation is complete
+
+### IRI Types
+- `EmailNotificationConfigurationIri` - Email notification configuration IRI (`/email_notification_configurations/:id`)
+
+## Configuration
+
+Each email notification configuration contains a `config` object with template-specific settings:
+
+```typescript
+{
+  sourcesEnabled: string[] // Array of enabled order sources: 'application', 'ecommerce', 'partner'
+}
+```
+
+## Available Requests
+
+### CreateEmailNotificationConfiguration
+```typescript
+import { CreateEmailNotificationConfiguration } from '@deliverart/sdk-js-email-notification-configuration';
+
+const config = await sdk.call(new CreateEmailNotificationConfiguration({
+  pointOfSale: '/point_of_sales/123',
+  templateKey: 'order_created',
+  isActive: true,
+  config: {
+    sourcesEnabled: ['application', 'ecommerce']
+  }
+}));
+```
+
+**Input Parameters:**
+- `pointOfSale: string` (required) - Point of sale IRI
+- `templateKey: string` (required) - Email template key
+- `isActive: boolean` (required) - Enable/disable this notification
+- `config: object` (required) - Configuration settings
+  - `sourcesEnabled: string[]` (required) - Array of enabled order sources
+
+---
+
+### GetEmailNotificationConfigurations
+```typescript
+import { GetEmailNotificationConfigurations } from '@deliverart/sdk-js-email-notification-configuration';
+
+const configs = await sdk.call(new GetEmailNotificationConfigurations({
+  query: {
+    pointOfSale: '/point_of_sales/123',
+    page: 1
+  }
+}));
+```
+
+**Query Parameters:**
+- `pointOfSale?: string` - Filter by point of sale
+- `templateKey?: string` - Filter by template key
+- `page?: number` - Page number
+
+---
+
+### GetEmailNotificationConfigurationDetails
+```typescript
+import { GetEmailNotificationConfigurationDetails } from '@deliverart/sdk-js-email-notification-configuration';
+
+const config = await sdk.call(new GetEmailNotificationConfigurationDetails('config-123'));
+```
+
+---
+
+### UpdateEmailNotificationConfiguration
+```typescript
+import { UpdateEmailNotificationConfiguration } from '@deliverart/sdk-js-email-notification-configuration';
+
+const updated = await sdk.call(new UpdateEmailNotificationConfiguration('config-123', {
+  isActive: false,
+  config: {
+    sourcesEnabled: ['partner']
+  }
+}));
+```
+
+---
+
+### DeleteEmailNotificationConfiguration
+```typescript
+import { DeleteEmailNotificationConfiguration } from '@deliverart/sdk-js-email-notification-configuration';
+
+await sdk.call(new DeleteEmailNotificationConfiguration('config-123'));
+```
+
+---
+
+## License
+
+This package is part of the DeliverArt JavaScript SDK.