@twin.org/messaging-connector-entity-storage 0.0.1-next.7 → 0.0.1-next.8

package/dist/cjs/index.cjs

@@ -45,35 +45,35 @@ exports.EmailEntry = class EmailEntry {
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], exports.EmailEntry.prototype, "id", void 0);
+], exports.EmailEntry.prototype, "id", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.EmailEntry.prototype, "sender", void 0);
+], exports.EmailEntry.prototype, "sender", undefined);
 __decorate([
     entity.property({ type: "array", itemType: "string" }),
     __metadata("design:type", Array)
-], exports.EmailEntry.prototype, "recipients", void 0);
+], exports.EmailEntry.prototype, "recipients", undefined);
 __decorate([
     entity.property({ type: "integer" }),
     __metadata("design:type", Number)
-], exports.EmailEntry.prototype, "ts", void 0);
+], exports.EmailEntry.prototype, "ts", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.EmailEntry.prototype, "message", void 0);
+], exports.EmailEntry.prototype, "message", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.EmailEntry.prototype, "subject", void 0);
+], exports.EmailEntry.prototype, "subject", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.EmailEntry.prototype, "status", void 0);
+], exports.EmailEntry.prototype, "status", undefined);
 __decorate([
     entity.property({ type: "object" }),
     __metadata("design:type", Object)
-], exports.EmailEntry.prototype, "error", void 0);
+], exports.EmailEntry.prototype, "error", undefined);
 exports.EmailEntry = __decorate([
     entity.entity()
 ], exports.EmailEntry);
@@ -110,27 +110,27 @@ exports.PushNotificationDeviceEntry = class PushNotificationDeviceEntry {
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], exports.PushNotificationDeviceEntry.prototype, "id", void 0);
+], exports.PushNotificationDeviceEntry.prototype, "id", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.PushNotificationDeviceEntry.prototype, "applicationId", void 0);
+], exports.PushNotificationDeviceEntry.prototype, "applicationId", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.PushNotificationDeviceEntry.prototype, "deviceToken", void 0);
+], exports.PushNotificationDeviceEntry.prototype, "deviceToken", undefined);
 __decorate([
     entity.property({ type: "integer" }),
     __metadata("design:type", Number)
-], exports.PushNotificationDeviceEntry.prototype, "ts", void 0);
+], exports.PushNotificationDeviceEntry.prototype, "ts", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.PushNotificationDeviceEntry.prototype, "status", void 0);
+], exports.PushNotificationDeviceEntry.prototype, "status", undefined);
 __decorate([
     entity.property({ type: "object" }),
     __metadata("design:type", Object)
-], exports.PushNotificationDeviceEntry.prototype, "error", void 0);
+], exports.PushNotificationDeviceEntry.prototype, "error", undefined);
 exports.PushNotificationDeviceEntry = __decorate([
     entity.entity()
 ], exports.PushNotificationDeviceEntry);
@@ -171,31 +171,31 @@ exports.PushNotificationMessageEntry = class PushNotificationMessageEntry {
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], exports.PushNotificationMessageEntry.prototype, "id", void 0);
+], exports.PushNotificationMessageEntry.prototype, "id", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.PushNotificationMessageEntry.prototype, "deviceAddress", void 0);
+], exports.PushNotificationMessageEntry.prototype, "deviceAddress", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.PushNotificationMessageEntry.prototype, "title", void 0);
+], exports.PushNotificationMessageEntry.prototype, "title", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.PushNotificationMessageEntry.prototype, "message", void 0);
+], exports.PushNotificationMessageEntry.prototype, "message", undefined);
 __decorate([
     entity.property({ type: "integer" }),
     __metadata("design:type", Number)
-], exports.PushNotificationMessageEntry.prototype, "ts", void 0);
+], exports.PushNotificationMessageEntry.prototype, "ts", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.PushNotificationMessageEntry.prototype, "status", void 0);
+], exports.PushNotificationMessageEntry.prototype, "status", undefined);
 __decorate([
     entity.property({ type: "object" }),
     __metadata("design:type", Object)
-], exports.PushNotificationMessageEntry.prototype, "error", void 0);
+], exports.PushNotificationMessageEntry.prototype, "error", undefined);
 exports.PushNotificationMessageEntry = __decorate([
     entity.entity()
 ], exports.PushNotificationMessageEntry);
@@ -232,27 +232,27 @@ exports.SmsEntry = class SmsEntry {
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], exports.SmsEntry.prototype, "id", void 0);
+], exports.SmsEntry.prototype, "id", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.SmsEntry.prototype, "phoneNumber", void 0);
+], exports.SmsEntry.prototype, "phoneNumber", undefined);
 __decorate([
     entity.property({ type: "integer" }),
     __metadata("design:type", Number)
-], exports.SmsEntry.prototype, "ts", void 0);
+], exports.SmsEntry.prototype, "ts", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.SmsEntry.prototype, "message", void 0);
+], exports.SmsEntry.prototype, "message", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.SmsEntry.prototype, "status", void 0);
+], exports.SmsEntry.prototype, "status", undefined);
 __decorate([
     entity.property({ type: "object" }),
     __metadata("design:type", Object)
-], exports.SmsEntry.prototype, "error", void 0);
+], exports.SmsEntry.prototype, "error", undefined);
 exports.SmsEntry = __decorate([
     entity.entity()
 ], exports.SmsEntry);
@@ -284,8 +284,6 @@ class EntityStorageMessagingEmailConnector {
     /**
      * Create a new instance of EntityStorageMessagingEmailConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.messagingEmailEntryStorageConnectorType The type of entity storage connector to use for the email entries, defaults to "email-entry".
      */
     constructor(options) {
         if (core.Is.stringValue(options?.loggingConnectorType)) {
@@ -368,9 +366,6 @@ class EntityStorageMessagingPushNotificationConnector {
     /**
      * Create a new instance of EntityStorageMessagingPushNotificationConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.messagingDeviceEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-device-entry".
-     * @param options.messagingMessageEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-message-entry".
      */
     constructor(options) {
         if (core.Is.stringValue(options?.loggingConnectorType)) {
@@ -475,8 +470,6 @@ class EntityStorageMessagingSmsConnector {
     /**
      * Create a new instance of EntityStorageMessagingSmsConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.messagingSmsEntryStorageConnectorType The type of entity storage connector to use for the sms entries, defaults to "sms-entry".
      */
     constructor(options) {
         if (core.Is.stringValue(options?.loggingConnectorType)) {

package/dist/esm/index.mjs

@@ -43,35 +43,35 @@ let EmailEntry = class EmailEntry {
 __decorate([
     property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], EmailEntry.prototype, "id", void 0);
+], EmailEntry.prototype, "id", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], EmailEntry.prototype, "sender", void 0);
+], EmailEntry.prototype, "sender", undefined);
 __decorate([
     property({ type: "array", itemType: "string" }),
     __metadata("design:type", Array)
-], EmailEntry.prototype, "recipients", void 0);
+], EmailEntry.prototype, "recipients", undefined);
 __decorate([
     property({ type: "integer" }),
     __metadata("design:type", Number)
-], EmailEntry.prototype, "ts", void 0);
+], EmailEntry.prototype, "ts", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], EmailEntry.prototype, "message", void 0);
+], EmailEntry.prototype, "message", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], EmailEntry.prototype, "subject", void 0);
+], EmailEntry.prototype, "subject", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], EmailEntry.prototype, "status", void 0);
+], EmailEntry.prototype, "status", undefined);
 __decorate([
     property({ type: "object" }),
     __metadata("design:type", Object)
-], EmailEntry.prototype, "error", void 0);
+], EmailEntry.prototype, "error", undefined);
 EmailEntry = __decorate([
     entity()
 ], EmailEntry);
@@ -108,27 +108,27 @@ let PushNotificationDeviceEntry = class PushNotificationDeviceEntry {
 __decorate([
     property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], PushNotificationDeviceEntry.prototype, "id", void 0);
+], PushNotificationDeviceEntry.prototype, "id", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], PushNotificationDeviceEntry.prototype, "applicationId", void 0);
+], PushNotificationDeviceEntry.prototype, "applicationId", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], PushNotificationDeviceEntry.prototype, "deviceToken", void 0);
+], PushNotificationDeviceEntry.prototype, "deviceToken", undefined);
 __decorate([
     property({ type: "integer" }),
     __metadata("design:type", Number)
-], PushNotificationDeviceEntry.prototype, "ts", void 0);
+], PushNotificationDeviceEntry.prototype, "ts", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], PushNotificationDeviceEntry.prototype, "status", void 0);
+], PushNotificationDeviceEntry.prototype, "status", undefined);
 __decorate([
     property({ type: "object" }),
     __metadata("design:type", Object)
-], PushNotificationDeviceEntry.prototype, "error", void 0);
+], PushNotificationDeviceEntry.prototype, "error", undefined);
 PushNotificationDeviceEntry = __decorate([
     entity()
 ], PushNotificationDeviceEntry);
@@ -169,31 +169,31 @@ let PushNotificationMessageEntry = class PushNotificationMessageEntry {
 __decorate([
     property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], PushNotificationMessageEntry.prototype, "id", void 0);
+], PushNotificationMessageEntry.prototype, "id", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], PushNotificationMessageEntry.prototype, "deviceAddress", void 0);
+], PushNotificationMessageEntry.prototype, "deviceAddress", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], PushNotificationMessageEntry.prototype, "title", void 0);
+], PushNotificationMessageEntry.prototype, "title", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], PushNotificationMessageEntry.prototype, "message", void 0);
+], PushNotificationMessageEntry.prototype, "message", undefined);
 __decorate([
     property({ type: "integer" }),
     __metadata("design:type", Number)
-], PushNotificationMessageEntry.prototype, "ts", void 0);
+], PushNotificationMessageEntry.prototype, "ts", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], PushNotificationMessageEntry.prototype, "status", void 0);
+], PushNotificationMessageEntry.prototype, "status", undefined);
 __decorate([
     property({ type: "object" }),
     __metadata("design:type", Object)
-], PushNotificationMessageEntry.prototype, "error", void 0);
+], PushNotificationMessageEntry.prototype, "error", undefined);
 PushNotificationMessageEntry = __decorate([
     entity()
 ], PushNotificationMessageEntry);
@@ -230,27 +230,27 @@ let SmsEntry = class SmsEntry {
 __decorate([
     property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], SmsEntry.prototype, "id", void 0);
+], SmsEntry.prototype, "id", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], SmsEntry.prototype, "phoneNumber", void 0);
+], SmsEntry.prototype, "phoneNumber", undefined);
 __decorate([
     property({ type: "integer" }),
     __metadata("design:type", Number)
-], SmsEntry.prototype, "ts", void 0);
+], SmsEntry.prototype, "ts", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], SmsEntry.prototype, "message", void 0);
+], SmsEntry.prototype, "message", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], SmsEntry.prototype, "status", void 0);
+], SmsEntry.prototype, "status", undefined);
 __decorate([
     property({ type: "object" }),
     __metadata("design:type", Object)
-], SmsEntry.prototype, "error", void 0);
+], SmsEntry.prototype, "error", undefined);
 SmsEntry = __decorate([
     entity()
 ], SmsEntry);
@@ -282,8 +282,6 @@ class EntityStorageMessagingEmailConnector {
     /**
      * Create a new instance of EntityStorageMessagingEmailConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.messagingEmailEntryStorageConnectorType The type of entity storage connector to use for the email entries, defaults to "email-entry".
      */
     constructor(options) {
         if (Is.stringValue(options?.loggingConnectorType)) {
@@ -366,9 +364,6 @@ class EntityStorageMessagingPushNotificationConnector {
     /**
      * Create a new instance of EntityStorageMessagingPushNotificationConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.messagingDeviceEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-device-entry".
-     * @param options.messagingMessageEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-message-entry".
      */
     constructor(options) {
         if (Is.stringValue(options?.loggingConnectorType)) {
@@ -473,8 +468,6 @@ class EntityStorageMessagingSmsConnector {
     /**
      * Create a new instance of EntityStorageMessagingSmsConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.messagingSmsEntryStorageConnectorType The type of entity storage connector to use for the sms entries, defaults to "sms-entry".
      */
     constructor(options) {
         if (Is.stringValue(options?.loggingConnectorType)) {

package/dist/types/entityStorageMessagingEmailConnector.d.ts

@@ -1,4 +1,5 @@
 import type { IMessagingEmailConnector } from "@twin.org/messaging-models";
+import type { IEntityStorageMessagingEmailConnectorConstructorOptions } from "./models/IEntityStorageMessagingEmailConnectorConstructorOptions";
 /**
  * Class for connecting to the email messaging operations of the Entity Storage.
  */
@@ -14,13 +15,8 @@ export declare class EntityStorageMessagingEmailConnector implements IMessagingE
     /**
      * Create a new instance of EntityStorageMessagingEmailConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.messagingEmailEntryStorageConnectorType The type of entity storage connector to use for the email entries, defaults to "email-entry".
      */
-    constructor(options?: {
-        loggingConnectorType?: string;
-        messagingEmailEntryStorageConnectorType?: string;
-    });
+    constructor(options?: IEntityStorageMessagingEmailConnectorConstructorOptions);
     /**
      * Store a custom email using Entity Storage.
      * @param sender The sender email address.

package/dist/types/entityStorageMessagingPushNotificationConnector.d.ts

@@ -1,4 +1,5 @@
 import type { IMessagingPushNotificationsConnector } from "@twin.org/messaging-models";
+import type { IEntityStorageMessagingPushNotificationConnectorConstructorOptions } from "./models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions";
 /**
  * Class for connecting to the push notifications messaging operations of the Entity Storage.
  */
@@ -14,15 +15,8 @@ export declare class EntityStorageMessagingPushNotificationConnector implements
     /**
      * Create a new instance of EntityStorageMessagingPushNotificationConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.messagingDeviceEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-device-entry".
-     * @param options.messagingMessageEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-message-entry".
      */
-    constructor(options?: {
-        loggingConnectorType?: string;
-        messagingDeviceEntryStorageConnectorType?: string;
-        messagingMessageEntryStorageConnectorType?: string;
-    });
+    constructor(options?: IEntityStorageMessagingPushNotificationConnectorConstructorOptions);
     /**
      * Registers a device to an specific app in order to send notifications to it.
      * @param applicationId The application address.

package/dist/types/entityStorageMessagingSmsConnector.d.ts

@@ -1,4 +1,5 @@
 import type { IMessagingSmsConnector } from "@twin.org/messaging-models";
+import type { IEntityStorageMessagingSmsConnectorConstructorOptions } from "./models/IEntityStorageMessagingSmsConnectorConstructorOptions";
 /**
  * Class for connecting to the SMS messaging operations of the Entity Storage.
  */
@@ -14,13 +15,8 @@ export declare class EntityStorageMessagingSmsConnector implements IMessagingSms
     /**
      * Create a new instance of EntityStorageMessagingSmsConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.messagingSmsEntryStorageConnectorType The type of entity storage connector to use for the sms entries, defaults to "sms-entry".
      */
-    constructor(options?: {
-        loggingConnectorType?: string;
-        messagingSmsEntryStorageConnectorType?: string;
-    });
+    constructor(options?: IEntityStorageMessagingSmsConnectorConstructorOptions);
     /**
      * Send a SMS message to a phone number.
      * @param phoneNumber The recipient phone number.

package/dist/types/index.d.ts

@@ -5,4 +5,7 @@ export * from "./entities/smsEntry";
 export * from "./entityStorageMessagingEmailConnector";
 export * from "./entityStorageMessagingPushNotificationConnector";
 export * from "./entityStorageMessagingSmsConnector";
+export * from "./models/IEntityStorageMessagingEmailConnectorConstructorOptions";
+export * from "./models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions";
+export * from "./models/IEntityStorageMessagingSmsConnectorConstructorOptions";
 export * from "./schema";

package/dist/types/models/IEntityStorageMessagingEmailConnectorConstructorOptions.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Options for the entity storage messaging email connector.
+ */
+export interface IEntityStorageMessagingEmailConnectorConstructorOptions {
+    /**
+     * The type of logging connector to use, defaults to no logging.
+     */
+    loggingConnectorType?: string;
+    /**
+     * The type of entity storage connector to use for the email entries.
+     * @default email-entry
+     */
+    messagingEmailEntryStorageConnectorType?: string;
+}

package/dist/types/models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Options for the entity storage messaging push notification connector.
+ */
+export interface IEntityStorageMessagingPushNotificationConnectorConstructorOptions {
+    /**
+     * The type of logging connector to use, defaults to no logging.
+     */
+    loggingConnectorType?: string;
+    /**
+     * The type of entity storage connector to use for the push notifications entries.
+     * @default push-notification-device-entry
+     */
+    messagingDeviceEntryStorageConnectorType?: string;
+    /**
+     * The type of entity storage connector to use for the push notifications entries.
+     * @default push-notification-message-entry
+     */
+    messagingMessageEntryStorageConnectorType?: string;
+}

package/dist/types/models/IEntityStorageMessagingSmsConnectorConstructorOptions.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Options for the entity storage messaging SMS connector.
+ */
+export interface IEntityStorageMessagingSmsConnectorConstructorOptions {
+    /**
+     * The type of logging connector to use, defaults to no logging.
+     */
+    loggingConnectorType?: string;
+    /**
+     * The type of entity storage connector to use for the sms entries.
+     * @default sms-entry
+     */
+    messagingSmsEntryStorageConnectorType?: string;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/messaging-connector-entity-storage - Changelog
 
-## v0.0.1-next.7
+## v0.0.1-next.8
 
 - Initial Release

package/docs/reference/classes/EntityStorageMessagingEmailConnector.md

@@ -16,17 +16,11 @@ Create a new instance of EntityStorageMessagingEmailConnector.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The options for the connector.
-
-• **options.loggingConnectorType?**: `string`
-
-The type of logging connector to use, defaults to no logging.
+[`IEntityStorageMessagingEmailConnectorConstructorOptions`](../interfaces/IEntityStorageMessagingEmailConnectorConstructorOptions.md)
 
-• **options.messagingEmailEntryStorageConnectorType?**: `string`
-
-The type of entity storage connector to use for the email entries, defaults to "email-entry".
+The options for the connector.
 
 #### Returns
 
@@ -62,19 +56,27 @@ Store a custom email using Entity Storage.
 
 #### Parameters
 
-• **sender**: `string`
+##### sender
+
+`string`
 
 The sender email address.
 
-• **recipients**: `string`[]
+##### recipients
+
+`string`[]
 
 An array of recipients email addresses.
 
-• **subject**: `string`
+##### subject
+
+`string`
 
 The subject of the email.
 
-• **content**: `string`
+##### content
+
+`string`
 
 The html content of the email.
 

package/docs/reference/classes/EntityStorageMessagingPushNotificationConnector.md

@@ -16,21 +16,11 @@ Create a new instance of EntityStorageMessagingPushNotificationConnector.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The options for the connector.
-
-• **options.loggingConnectorType?**: `string`
-
-The type of logging connector to use, defaults to no logging.
-
-• **options.messagingDeviceEntryStorageConnectorType?**: `string`
-
-The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-device-entry".
-
-• **options.messagingMessageEntryStorageConnectorType?**: `string`
+[`IEntityStorageMessagingPushNotificationConnectorConstructorOptions`](../interfaces/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.md)
 
-The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-message-entry".
+The options for the connector.
 
 #### Returns
 
@@ -66,11 +56,15 @@ Registers a device to an specific app in order to send notifications to it.
 
 #### Parameters
 
-• **applicationId**: `string`
+##### applicationId
+
+`string`
 
 The application address.
 
-• **deviceToken**: `string`
+##### deviceToken
+
+`string`
 
 The device token.
 
@@ -94,15 +88,21 @@ Send a push notification to a device.
 
 #### Parameters
 
-• **deviceAddress**: `string`
+##### deviceAddress
+
+`string`
 
 The address of the device.
 
-• **title**: `string`
+##### title
+
+`string`
 
 The title of the notification.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message to send.
 

package/docs/reference/classes/EntityStorageMessagingSmsConnector.md

@@ -16,17 +16,11 @@ Create a new instance of EntityStorageMessagingSmsConnector.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The options for the connector.
-
-• **options.loggingConnectorType?**: `string`
-
-The type of logging connector to use, defaults to no logging.
-
-• **options.messagingSmsEntryStorageConnectorType?**: `string`
+[`IEntityStorageMessagingSmsConnectorConstructorOptions`](../interfaces/IEntityStorageMessagingSmsConnectorConstructorOptions.md)
 
-The type of entity storage connector to use for the sms entries, defaults to "sms-entry".
+The options for the connector.
 
 #### Returns
 
@@ -62,11 +56,15 @@ Send a SMS message to a phone number.
 
 #### Parameters
 
-• **phoneNumber**: `string`
+##### phoneNumber
+
+`string`
 
 The recipient phone number.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message to send.
 

package/docs/reference/functions/initSchema.md

@@ -6,19 +6,25 @@ Initialize the schema for the messaging connector entity storage.
 
 ## Parameters
 
-• **options?**
+### options?
 
 The options for the initialisation.
 
-• **options.email?**: `boolean`
+#### email
+
+`boolean`
 
 Should we register email schemas.
 
-• **options.sms?**: `boolean`
+#### sms
+
+`boolean`
 
 Should we register sms schemas.
 
-• **options.pushNotification?**: `boolean`
+#### pushNotification
+
+`boolean`
 
 Should we register push notification schemas.
 

package/docs/reference/index.md

@@ -10,6 +10,12 @@
 - [EntityStorageMessagingPushNotificationConnector](classes/EntityStorageMessagingPushNotificationConnector.md)
 - [EntityStorageMessagingSmsConnector](classes/EntityStorageMessagingSmsConnector.md)
 
+## Interfaces
+
+- [IEntityStorageMessagingEmailConnectorConstructorOptions](interfaces/IEntityStorageMessagingEmailConnectorConstructorOptions.md)
+- [IEntityStorageMessagingPushNotificationConnectorConstructorOptions](interfaces/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.md)
+- [IEntityStorageMessagingSmsConnectorConstructorOptions](interfaces/IEntityStorageMessagingSmsConnectorConstructorOptions.md)
+
 ## Functions
 
 - [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/IEntityStorageMessagingEmailConnectorConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IEntityStorageMessagingEmailConnectorConstructorOptions
+
+Options for the entity storage messaging email connector.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+***
+
+### messagingEmailEntryStorageConnectorType?
+
+> `optional` **messagingEmailEntryStorageConnectorType**: `string`
+
+The type of entity storage connector to use for the email entries.
+
+#### Default
+
+```ts
+email-entry
+```

package/docs/reference/interfaces/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.md

@@ -0,0 +1,39 @@
+# Interface: IEntityStorageMessagingPushNotificationConnectorConstructorOptions
+
+Options for the entity storage messaging push notification connector.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+***
+
+### messagingDeviceEntryStorageConnectorType?
+
+> `optional` **messagingDeviceEntryStorageConnectorType**: `string`
+
+The type of entity storage connector to use for the push notifications entries.
+
+#### Default
+
+```ts
+push-notification-device-entry
+```
+
+***
+
+### messagingMessageEntryStorageConnectorType?
+
+> `optional` **messagingMessageEntryStorageConnectorType**: `string`
+
+The type of entity storage connector to use for the push notifications entries.
+
+#### Default
+
+```ts
+push-notification-message-entry
+```

package/docs/reference/interfaces/IEntityStorageMessagingSmsConnectorConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IEntityStorageMessagingSmsConnectorConstructorOptions
+
+Options for the entity storage messaging SMS connector.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+***
+
+### messagingSmsEntryStorageConnectorType?
+
+> `optional` **messagingSmsEntryStorageConnectorType**: `string`
+
+The type of entity storage connector to use for the sms entries.
+
+#### Default
+
+```ts
+sms-entry
+```

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/messaging-connector-entity-storage",
-	"version": "0.0.1-next.7",
+	"version": "0.0.1-next.8",
 	"description": "Messaging connector implementation using the Entity Storage",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/logging-models": "next",
-		"@twin.org/messaging-models": "0.0.1-next.7",
+		"@twin.org/messaging-models": "0.0.1-next.8",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",