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

package/README.md

@@ -11,8 +11,11 @@ npm install @deliverart/sdk-js-email-notification-configuration @deliverart/sdk-
 ## Exported Types
 
 ### Core Types
-- `EmailNotificationConfiguration` - Email notification configuration
-- `EmailNotificationConfigConfig` - Configuration object containing notification settings
+- `EmailNotificationConfiguration` - Email notification configuration with all details
+- `EmailNotificationConfigurationListItem` - Email notification configuration list item
+- `EmailNotificationConfigurationConfig` - Configuration object containing notification settings
+- `WritableEmailNotificationConfiguration` - Writable email notification configuration
+- `WritableCreateEmailNotificationConfiguration` - Writable create email notification configuration
 
 ### Template Keys
 Available email template keys:
@@ -23,19 +26,30 @@ Available email template keys:
 - `order_in_preparation` - Notification when order enters preparation
 - `order_preparation_done` - Notification when order preparation is complete
 
+### Order Sources
+Configuration supports the following order sources:
+- `application` - Orders from mobile/web application
+- `ecommerce` - Orders from ecommerce platform
+- `partner` - Orders from partner integrations
+
 ### IRI Types
 - `EmailNotificationConfigurationIri` - Email notification configuration IRI (`/email_notification_configurations/:id`)
 
-## Configuration
+## Configuration Structure
+
+Each email notification configuration contains a `config` object with template-specific settings. The configuration structure is designed to be extensible for future template-specific fields.
 
-Each email notification configuration contains a `config` object with template-specific settings:
+### Config Object
 
 ```typescript
 {
-  sourcesEnabled: string[] // Array of enabled order sources: 'application', 'ecommerce', 'partner'
+  sourcesEnabled: string[] // Array of enabled order sources
 }
 ```
 
+**Fields:**
+- `sourcesEnabled?: string[]` - Array of order sources for which the notification should be sent
+
 ## Available Requests
 
 ### CreateEmailNotificationConfiguration
@@ -44,10 +58,10 @@ import { CreateEmailNotificationConfiguration } from '@deliverart/sdk-js-email-n
 
 const config = await sdk.call(new CreateEmailNotificationConfiguration({
   pointOfSale: '/point_of_sales/123',
-  templateKey: 'order_created',
+  templateKey: 'order_preparation_done',
   isActive: true,
   config: {
-    sourcesEnabled: ['application', 'ecommerce']
+    sourcesEnabled: ['application']
   }
 }));
 ```
@@ -55,9 +69,8 @@ const config = await sdk.call(new CreateEmailNotificationConfiguration({
 **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
+- `isActive: boolean` (required) - Enable/disable notification
+- `config: object` (required) - Configuration object with sourcesEnabled
 
 ---
 
@@ -67,16 +80,22 @@ import { GetEmailNotificationConfigurations } from '@deliverart/sdk-js-email-not
 
 const configs = await sdk.call(new GetEmailNotificationConfigurations({
   query: {
-    pointOfSale: '/point_of_sales/123',
+    templateKey: 'order_created',
     page: 1
   }
 }));
 ```
 
 **Query Parameters:**
-- `pointOfSale?: string` - Filter by point of sale
-- `templateKey?: string` - Filter by template key
+- `id?: string | string[]` - Filter by configuration ID
+- `templateKey?: string | string[]` - Filter by template key
+- `order[createdAt]?: string` - Sort by creation date
+- `order[updatedAt]?: string` - Sort by update date
 - `page?: number` - Page number
+- `createdAtFrom?: string` - Filter by creation date (from)
+- `createdAtTo?: string` - Filter by creation date (to)
+- `updatedAtFrom?: string` - Filter by update date (from)
+- `updatedAtTo?: string` - Filter by update date (to)
 
 ---
 
@@ -94,13 +113,20 @@ const config = await sdk.call(new GetEmailNotificationConfigurationDetails('conf
 import { UpdateEmailNotificationConfiguration } from '@deliverart/sdk-js-email-notification-configuration';
 
 const updated = await sdk.call(new UpdateEmailNotificationConfiguration('config-123', {
+  templateKey: 'order_preparation_done',
   isActive: false,
   config: {
-    sourcesEnabled: ['partner']
+    sourcesEnabled: ['application', 'ecommerce']
   }
 }));
 ```
 
+**Input Parameters:**
+- `templateKey: string` (required) - Email template key
+- `isActive: boolean` (required) - Enable/disable notification
+- `config: object` (required) - Configuration object
+  - `sourcesEnabled: string[]` - Array of enabled order sources
+
 ---
 
 ### DeleteEmailNotificationConfiguration

package/dist/index.cjs

@@ -11199,63 +11199,185 @@ function date4(params) {
 config(en_default());
 
 // src/models.ts
-var baseConfigSchema = external_exports.object({
+var emailNotificationConfigurationConfigSchema = external_exports.object({
   sourcesEnabled: external_exports.array(import_sdk_js_global_types.orderSourceSchema)
 });
-var emailNotificationConfigurationConfigSchema = external_exports.discriminatedUnion("templateKey", [
+var emailNotificationConfigurationSchema = external_exports.discriminatedUnion("templateKey", [
   external_exports.object({
+    id: external_exports.string(),
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
     templateKey: external_exports.literal("delivery_started"),
-    ...baseConfigSchema.shape
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
   }),
   external_exports.object({
+    id: external_exports.string(),
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
     templateKey: external_exports.literal("delivery_taken_over"),
-    ...baseConfigSchema.shape
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
   }),
   external_exports.object({
+    id: external_exports.string(),
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
     templateKey: external_exports.literal("order_created"),
-    ...baseConfigSchema.shape
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
   }),
   external_exports.object({
+    id: external_exports.string(),
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
     templateKey: external_exports.literal("order_delivered"),
-    ...baseConfigSchema.shape
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
   }),
   external_exports.object({
+    id: external_exports.string(),
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
     templateKey: external_exports.literal("order_in_preparation"),
-    ...baseConfigSchema.shape
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
   }),
   external_exports.object({
+    id: external_exports.string(),
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
     templateKey: external_exports.literal("order_preparation_done"),
-    ...baseConfigSchema.shape
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
+  })
+]);
+var emailNotificationConfigurationSchemaListItem = external_exports.discriminatedUnion("templateKey", [
+  external_exports.object({
+    id: external_exports.string(),
+    templateKey: external_exports.literal("delivery_started"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
+  }),
+  external_exports.object({
+    id: external_exports.string(),
+    templateKey: external_exports.literal("delivery_taken_over"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
+  }),
+  external_exports.object({
+    id: external_exports.string(),
+    templateKey: external_exports.literal("order_created"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
+  }),
+  external_exports.object({
+    id: external_exports.string(),
+    templateKey: external_exports.literal("order_delivered"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
+  }),
+  external_exports.object({
+    id: external_exports.string(),
+    templateKey: external_exports.literal("order_in_preparation"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
+  }),
+  external_exports.object({
+    id: external_exports.string(),
+    templateKey: external_exports.literal("order_preparation_done"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean(),
+    createdAt: import_sdk_js_global_types.datetimeSchema,
+    updatedAt: import_sdk_js_global_types.datetimeSchema
+  })
+]);
+var writableEmailNotificationConfigurationSchema = external_exports.union([
+  external_exports.object({
+    templateKey: external_exports.literal("delivery_started"),
+    config: emailNotificationConfigurationConfigSchema.optional(),
+    isActive: external_exports.boolean().optional()
+  }),
+  external_exports.object({
+    templateKey: external_exports.literal("delivery_taken_over"),
+    config: emailNotificationConfigurationConfigSchema.optional(),
+    isActive: external_exports.boolean().optional()
+  }),
+  external_exports.object({
+    templateKey: external_exports.literal("order_created"),
+    config: emailNotificationConfigurationConfigSchema.optional(),
+    isActive: external_exports.boolean().optional()
+  }),
+  external_exports.object({
+    templateKey: external_exports.literal("order_delivered"),
+    config: emailNotificationConfigurationConfigSchema.optional(),
+    isActive: external_exports.boolean().optional()
+  }),
+  external_exports.object({
+    templateKey: external_exports.literal("order_in_preparation"),
+    config: emailNotificationConfigurationConfigSchema.optional(),
+    isActive: external_exports.boolean().optional()
+  }),
+  external_exports.object({
+    templateKey: external_exports.literal("order_preparation_done"),
+    config: emailNotificationConfigurationConfigSchema.optional(),
+    isActive: external_exports.boolean().optional()
+  })
+]);
+var writableCreateEmailNotificationConfigurationSchema = external_exports.union([
+  external_exports.object({
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
+    templateKey: external_exports.literal("delivery_started"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean()
+  }),
+  external_exports.object({
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
+    templateKey: external_exports.literal("delivery_taken_over"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean()
+  }),
+  external_exports.object({
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
+    templateKey: external_exports.literal("order_created"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean()
+  }),
+  external_exports.object({
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
+    templateKey: external_exports.literal("order_delivered"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean()
+  }),
+  external_exports.object({
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
+    templateKey: external_exports.literal("order_in_preparation"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean()
+  }),
+  external_exports.object({
+    pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
+    templateKey: external_exports.literal("order_preparation_done"),
+    config: emailNotificationConfigurationConfigSchema,
+    isActive: external_exports.boolean()
   })
 ]);
-var emailNotificationConfigurationSchema = external_exports.object({
-  id: external_exports.string(),
-  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
-  templateKey: import_sdk_js_global_types.emailTemplateKeySchema,
-  config: emailNotificationConfigurationConfigSchema,
-  isActive: external_exports.boolean(),
-  createdAt: import_sdk_js_global_types.datetimeSchema,
-  updatedAt: import_sdk_js_global_types.datetimeSchema
-});
-var emailNotificationConfigurationSchemaListItem = external_exports.object({
-  id: external_exports.string(),
-  templateKey: import_sdk_js_global_types.emailTemplateKeySchema,
-  config: emailNotificationConfigurationConfigSchema,
-  isActive: external_exports.boolean(),
-  createdAt: import_sdk_js_global_types.datetimeSchema,
-  updatedAt: import_sdk_js_global_types.datetimeSchema
-});
-var writableEmailNotificationConfigBaseSchema = external_exports.object({
-  config: baseConfigSchema,
-  isActive: external_exports.boolean()
-});
-var writableEmailNotificationConfigurationSchema = writableEmailNotificationConfigBaseSchema;
-var writableCreateEmailNotificationConfigurationSchema = external_exports.object({
-  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
-  templateKey: import_sdk_js_global_types.emailTemplateKeySchema,
-  config: baseConfigSchema,
-  isActive: external_exports.boolean()
-});
 var emailNotificationConfigurationsQuerySchema = external_exports.object({
   id: external_exports.union([external_exports.string(), external_exports.array(external_exports.string())]).optional(),
   templateKey: external_exports.union([import_sdk_js_global_types.emailTemplateKeySchema, external_exports.array(import_sdk_js_global_types.emailTemplateKeySchema)]).optional(),
@@ -11266,7 +11388,7 @@ var emailNotificationConfigurationsQuerySchema = external_exports.object({
 
 // src/requests/CreateEmailNotificationConfiguration.ts
 var import_sdk_js_core = require("@deliverart/sdk-js-core");
-var createEmailNotificationConfigurationInputSchema = writableCreateEmailNotificationConfigurationSchema.required();
+var createEmailNotificationConfigurationInputSchema = writableCreateEmailNotificationConfigurationSchema;
 var createEmailNotificationConfigurationResponseSchema = emailNotificationConfigurationSchema;
 var CreateEmailNotificationConfiguration = class extends import_sdk_js_core.AbstractApiRequest {
   constructor(input) {
@@ -11381,7 +11503,7 @@ var GetEmailNotificationConfigurationsFromPointOfSale = class extends import_sdk
 
 // src/requests/UpdateEmailNotificationConfiguration.ts
 var import_sdk_js_core6 = require("@deliverart/sdk-js-core");
-var updateEmailNotificationConfigurationInputSchema = writableEmailNotificationConfigurationSchema.partial();
+var updateEmailNotificationConfigurationInputSchema = writableEmailNotificationConfigurationSchema;
 var updateEmailNotificationConfigurationResponseSchema = emailNotificationConfigurationSchema;
 var UpdateEmailNotificationConfiguration = class extends import_sdk_js_core6.AbstractApiRequest {
   constructor(emailNotificationConfigurationId, input) {