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

Email notification configuration management package for the DeliverArt JavaScript SDK.

Installation

npm install @deliverart/sdk-js-email-notification-configuration @deliverart/sdk-js-core

Exported Types

Core Types

• 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:

• delivery_started - Notification when delivery starts
• delivery_taken_over - Notification when delivery is taken over
• order_created - Notification when order is created
• order_amended - Material amendment notification to the original ecommerce buyer or reviewed Hub contact; source filters apply
• order_delivered - Notification when order is delivered
• order_in_preparation - Notification when order enters preparation
• order_preparation_done - Notification when order preparation is complete
• subscription_expiring - Reminder when a time-based subscription is close to expiration
• subscription_low_credits - Reminder when a consumption subscription is low on credits
• subscription_pending_renewal - Reminder when a subscription has a pending renewal
• subscription_payment_pending_verification - Notification for subscription payments that require central admin verification

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 Structure

Each email notification configuration contains a config object with template-specific settings. The structure depends on the template key.

Config Object

Order and delivery templates use:

{
  sourcesEnabled: string[]
}

Subscription reminder templates use:

{}

The same empty config is also used by subscription billing verification notifications.

Fields:

• sourcesEnabled?: string[] - Array of order sources for which the notification should be sent on order and delivery templates

Available Requests

CreateEmailNotificationConfiguration

import { CreateEmailNotificationConfiguration } from '@deliverart/sdk-js-email-notification-configuration';

const config = await sdk.call(new CreateEmailNotificationConfiguration({
  pointOfSale: '/point_of_sales/123',
  templateKey: 'order_preparation_done',
  isActive: true,
  config: {
    sourcesEnabled: ['application']
  }
}));

Subscription reminder example:

const config = await sdk.call(new CreateEmailNotificationConfiguration({
  pointOfSale: '/point_of_sales/123',
  templateKey: 'subscription_low_credits',
  isActive: true,
  config: {}
}));

Subscription billing verification example:

const config = await sdk.call(new CreateEmailNotificationConfiguration({
  pointOfSale: '/point_of_sales/123',
  templateKey: 'subscription_payment_pending_verification',
  isActive: true,
  config: {}
}));

Input Parameters:

• pointOfSale: string (required) - Point of sale IRI
• templateKey: string (required) - Email template key
• isActive: boolean (required) - Enable/disable notification
• config: object (required) - Configuration object with sourcesEnabled

GetEmailNotificationConfigurations

import { GetEmailNotificationConfigurations } from '@deliverart/sdk-js-email-notification-configuration';

const configs = await sdk.call(new GetEmailNotificationConfigurations({
  query: {
    templateKey: 'order_created',
    page: 1
  }
}));

Query Parameters:

• 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)

GetEmailNotificationConfigurationDetails

import { GetEmailNotificationConfigurationDetails } from '@deliverart/sdk-js-email-notification-configuration';

const config = await sdk.call(new GetEmailNotificationConfigurationDetails('config-123'));

UpdateEmailNotificationConfiguration

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: ['application', 'ecommerce']
  }
}));

Input Parameters:

• templateKey: string (required) - Email template key
• isActive: boolean (required) - Enable/disable notification
• config: object (required) - Configuration object
  • order/delivery templates: sourcesEnabled: string[]
  • subscription reminder templates: empty object {}

DeleteEmailNotificationConfiguration

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.