@d19n/youfibre-odin-sdk 2.0.17 → 2.0.18

package/README.md

@@ -294,7 +294,7 @@ This SDK includes **164** entities across **12** modules.
 | **Email** | Email Entity Definition | REFERRAL, SUPPORT, TRANSACTIONAL |
 | **EmailSender** | EmailSender Entity Definition | DEFAULT |
 | **EmailTemplate** | EmailTemplate Entity Definition | DEFAULT |
-| **Message** | Message Entity Definition | EVENT |
+| **Message** | Message Entity Definition | CLOSE, EVENT, NUDGE |
 | **NotificationTemplate** | NotificationTemplate Entity Definition | DEFAULT |
 | **PushNotification** | PushNotification Entity Definition | DEFAULT |
 | **SmsMessage** | SmsMessage Entity Definition | INBOUND, OUTBOUND |

package/dist/entities-v2/Message.d.ts

@@ -18,10 +18,14 @@ import { PushNotificationProperties } from './PushNotification';
  * Available types for Message records
  */
 export declare enum MessageEntityTypes {
+    /** Close type message */
+    CLOSE = "CLOSE",
     /** This is the default record type */
     DEFAULT = "DEFAULT",
     /** event */
-    EVENT = "EVENT"
+    EVENT = "EVENT",
+    /** Nudge type message */
+    NUDGE = "NUDGE"
 }
 /**
  * Valid values for Message.SenderType
@@ -138,6 +142,65 @@ export interface MessageProperties {
      */
     MessageType: MessageMessageType;
 }
+/**
+ * Properties for CLOSE Message records
+ *
+ * @see NotificationModule:Message
+ */
+export interface CloseMessageProperties {
+    /** External ID of the message (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    ExternalId: string;
+    /** Who sent the message (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    From: string;
+    /** Message that indicates reason of not sending message (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    ErrorMessage: string;
+    /** Status of the message (CREATED,DELETED) (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    Status: string;
+    /** Attachments of the message (Communications - Message)
+     *
+     * @type {FILE_MULTIPLE}
+     */
+    Files: string;
+    /** Content of the message (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    Body: string;
+    /** Who receive the message (if needed) (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    To: string;
+    /** Title field for the record
+     *
+     * @type {TEXT}
+     */
+    Title: string;
+    /** sender type (Communications - Message)
+     *
+     * @type {ENUM}
+     * @enum {MessageSenderType}
+     */
+    SenderType: MessageSenderType;
+    /** The type of the message
+     *
+     * @type {ENUM}
+     * @enum {MessageMessageType}
+     */
+    MessageType: MessageMessageType;
+}
 /**
  * Properties for EVENT Message records
  *
@@ -197,6 +260,65 @@ export interface EventMessageProperties {
      */
     MessageType: MessageMessageType;
 }
+/**
+ * Properties for NUDGE Message records
+ *
+ * @see NotificationModule:Message
+ */
+export interface NudgeMessageProperties {
+    /** External ID of the message (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    ExternalId: string;
+    /** Who sent the message (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    From: string;
+    /** Message that indicates reason of not sending message (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    ErrorMessage: string;
+    /** Status of the message (CREATED,DELETED) (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    Status: string;
+    /** Attachments of the message (Communications - Message)
+     *
+     * @type {FILE_MULTIPLE}
+     */
+    Files: string;
+    /** Content of the message (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    Body: string;
+    /** Who receive the message (if needed) (Communications - Message)
+     *
+     * @type {TEXT}
+     */
+    To: string;
+    /** Title field for the record
+     *
+     * @type {TEXT}
+     */
+    Title: string;
+    /** sender type (Communications - Message)
+     *
+     * @type {ENUM}
+     * @enum {MessageSenderType}
+     */
+    SenderType: MessageSenderType;
+    /** The type of the message
+     *
+     * @type {ENUM}
+     * @enum {MessageMessageType}
+     */
+    MessageType: MessageMessageType;
+}
 /**
  * Message entity from NotificationModule
  *
@@ -229,6 +351,12 @@ export declare const ROUTING_KEY_MESSAGE_DELETED = "NotificationModule.Message.S
  * Type-specific routing keys for Message events
  * Subscribe to these for events on specific entity types only
  */
+/** Close type message created */
+export declare const ROUTING_KEY_MESSAGE_CLOSE_CREATED = "NotificationModule.Message.CLOSE.SubDbRecordCreated";
+/** Close type message updated */
+export declare const ROUTING_KEY_MESSAGE_CLOSE_UPDATED = "NotificationModule.Message.CLOSE.SubDbRecordUpdated";
+/** Close type message deleted */
+export declare const ROUTING_KEY_MESSAGE_CLOSE_DELETED = "NotificationModule.Message.CLOSE.SubDbRecordDeleted";
 /** This is the default record type created */
 export declare const ROUTING_KEY_MESSAGE_DEFAULT_CREATED = "NotificationModule.Message.DEFAULT.SubDbRecordCreated";
 /** This is the default record type updated */
@@ -241,6 +369,12 @@ export declare const ROUTING_KEY_MESSAGE_EVENT_CREATED = "NotificationModule.Mes
 export declare const ROUTING_KEY_MESSAGE_EVENT_UPDATED = "NotificationModule.Message.EVENT.SubDbRecordUpdated";
 /** event deleted */
 export declare const ROUTING_KEY_MESSAGE_EVENT_DELETED = "NotificationModule.Message.EVENT.SubDbRecordDeleted";
+/** Nudge type message created */
+export declare const ROUTING_KEY_MESSAGE_NUDGE_CREATED = "NotificationModule.Message.NUDGE.SubDbRecordCreated";
+/** Nudge type message updated */
+export declare const ROUTING_KEY_MESSAGE_NUDGE_UPDATED = "NotificationModule.Message.NUDGE.SubDbRecordUpdated";
+/** Nudge type message deleted */
+export declare const ROUTING_KEY_MESSAGE_NUDGE_DELETED = "NotificationModule.Message.NUDGE.SubDbRecordDeleted";
 /** Event: Message_File link created */
 export declare const ROUTING_KEY_LINK_MESSAGE_FILE_CREATED = "NotificationModule.Message.File.SubDbRecordAssociationCreated";
 /** Event: Message_File link deleted */

package/dist/entities-v2/Message.js

@@ -12,17 +12,21 @@
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_MESSAGE_PUSH_NOTIFICATION_DELETED = exports.ROUTING_KEY_LINK_MESSAGE_PUSH_NOTIFICATION_CREATED = exports.ROUTING_KEY_LINK_MESSAGE_FILE_DELETED = exports.ROUTING_KEY_LINK_MESSAGE_FILE_CREATED = exports.ROUTING_KEY_MESSAGE_EVENT_DELETED = exports.ROUTING_KEY_MESSAGE_EVENT_UPDATED = exports.ROUTING_KEY_MESSAGE_EVENT_CREATED = exports.ROUTING_KEY_MESSAGE_DEFAULT_DELETED = exports.ROUTING_KEY_MESSAGE_DEFAULT_UPDATED = exports.ROUTING_KEY_MESSAGE_DEFAULT_CREATED = exports.ROUTING_KEY_MESSAGE_DELETED = exports.ROUTING_KEY_MESSAGE_UPDATED = exports.ROUTING_KEY_MESSAGE_CREATED = exports.Message = exports.MessagePropertyKeys = exports.MessageMessageType = exports.MessageSenderType = exports.MessageEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_MESSAGE_PUSH_NOTIFICATION_DELETED = exports.ROUTING_KEY_LINK_MESSAGE_PUSH_NOTIFICATION_CREATED = exports.ROUTING_KEY_LINK_MESSAGE_FILE_DELETED = exports.ROUTING_KEY_LINK_MESSAGE_FILE_CREATED = exports.ROUTING_KEY_MESSAGE_NUDGE_DELETED = exports.ROUTING_KEY_MESSAGE_NUDGE_UPDATED = exports.ROUTING_KEY_MESSAGE_NUDGE_CREATED = exports.ROUTING_KEY_MESSAGE_EVENT_DELETED = exports.ROUTING_KEY_MESSAGE_EVENT_UPDATED = exports.ROUTING_KEY_MESSAGE_EVENT_CREATED = exports.ROUTING_KEY_MESSAGE_DEFAULT_DELETED = exports.ROUTING_KEY_MESSAGE_DEFAULT_UPDATED = exports.ROUTING_KEY_MESSAGE_DEFAULT_CREATED = exports.ROUTING_KEY_MESSAGE_CLOSE_DELETED = exports.ROUTING_KEY_MESSAGE_CLOSE_UPDATED = exports.ROUTING_KEY_MESSAGE_CLOSE_CREATED = exports.ROUTING_KEY_MESSAGE_DELETED = exports.ROUTING_KEY_MESSAGE_UPDATED = exports.ROUTING_KEY_MESSAGE_CREATED = exports.Message = exports.MessagePropertyKeys = exports.MessageMessageType = exports.MessageSenderType = exports.MessageEntityTypes = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for Message records
  */
 var MessageEntityTypes;
 (function (MessageEntityTypes) {
+    /** Close type message */
+    MessageEntityTypes["CLOSE"] = "CLOSE";
     /** This is the default record type */
     MessageEntityTypes["DEFAULT"] = "DEFAULT";
     /** event */
     MessageEntityTypes["EVENT"] = "EVENT";
+    /** Nudge type message */
+    MessageEntityTypes["NUDGE"] = "NUDGE";
 })(MessageEntityTypes = exports.MessageEntityTypes || (exports.MessageEntityTypes = {}));
 /**
  * Valid values for Message.SenderType
@@ -109,6 +113,12 @@ exports.ROUTING_KEY_MESSAGE_DELETED = 'NotificationModule.Message.SubDbRecordDel
  * Type-specific routing keys for Message events
  * Subscribe to these for events on specific entity types only
  */
+/** Close type message created */
+exports.ROUTING_KEY_MESSAGE_CLOSE_CREATED = 'NotificationModule.Message.CLOSE.SubDbRecordCreated';
+/** Close type message updated */
+exports.ROUTING_KEY_MESSAGE_CLOSE_UPDATED = 'NotificationModule.Message.CLOSE.SubDbRecordUpdated';
+/** Close type message deleted */
+exports.ROUTING_KEY_MESSAGE_CLOSE_DELETED = 'NotificationModule.Message.CLOSE.SubDbRecordDeleted';
 /** This is the default record type created */
 exports.ROUTING_KEY_MESSAGE_DEFAULT_CREATED = 'NotificationModule.Message.DEFAULT.SubDbRecordCreated';
 /** This is the default record type updated */
@@ -121,6 +131,12 @@ exports.ROUTING_KEY_MESSAGE_EVENT_CREATED = 'NotificationModule.Message.EVENT.Su
 exports.ROUTING_KEY_MESSAGE_EVENT_UPDATED = 'NotificationModule.Message.EVENT.SubDbRecordUpdated';
 /** event deleted */
 exports.ROUTING_KEY_MESSAGE_EVENT_DELETED = 'NotificationModule.Message.EVENT.SubDbRecordDeleted';
+/** Nudge type message created */
+exports.ROUTING_KEY_MESSAGE_NUDGE_CREATED = 'NotificationModule.Message.NUDGE.SubDbRecordCreated';
+/** Nudge type message updated */
+exports.ROUTING_KEY_MESSAGE_NUDGE_UPDATED = 'NotificationModule.Message.NUDGE.SubDbRecordUpdated';
+/** Nudge type message deleted */
+exports.ROUTING_KEY_MESSAGE_NUDGE_DELETED = 'NotificationModule.Message.NUDGE.SubDbRecordDeleted';
 /** Event: Message_File link created */
 exports.ROUTING_KEY_LINK_MESSAGE_FILE_CREATED = 'NotificationModule.Message.File.SubDbRecordAssociationCreated';
 /** Event: Message_File link deleted */

package/dist/records-v2/MessageRecord.d.ts

@@ -13,7 +13,7 @@
  * await record.createMessage({ ... }).execute();
  * ```
  *
- * Entity Types: DEFAULT, EVENT
+ * Entity Types: CLOSE, DEFAULT, EVENT, NUDGE
  *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
@@ -22,13 +22,13 @@ import { PipelineStageEntity } from '@d19n/odin-types/dist/core';
 import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/v1.db.interfaces';
 import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
 import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
-import { MessageProperties, EventMessageProperties } from '../entities-v2/Message';
+import { MessageProperties, CloseMessageProperties, EventMessageProperties, NudgeMessageProperties } from '../entities-v2/Message';
 import { CreateMessageProperties } from '../actions-v2/CreateMessageDto';
 import { ConversationRecord } from './ConversationRecord';
 import { FileRecord } from './FileRecord';
 import { PushNotificationRecord } from './PushNotificationRecord';
 /** Valid entity types for Message */
-export declare type MessageType = 'DEFAULT' | 'EVENT';
+export declare type MessageType = 'CLOSE' | 'DEFAULT' | 'EVENT' | 'NUDGE';
 /**
  * Builder for action execution with dryRun support
  *
@@ -120,6 +120,22 @@ export declare class MessageRecord<TProps = MessageProperties> {
     get groups(): string[];
     /** Access the underlying OdinRecord (null for new records) */
     get record(): OdinRecord<TProps> | null;
+    /**
+     * Type guard: check if this record is of type CLOSE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to CLOSE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isClose()) {
+     *   // TypeScript knows record.properties is CloseMessageProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Close type message
+     */
+    isClose(): this is MessageRecord<CloseMessageProperties>;
     /**
      * Type guard: check if this record is of type DEFAULT
      *
@@ -152,6 +168,22 @@ export declare class MessageRecord<TProps = MessageProperties> {
      * @remarks event
      */
     isEvent(): this is MessageRecord<EventMessageProperties>;
+    /**
+     * Type guard: check if this record is of type NUDGE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to NUDGE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isNudge()) {
+     *   // TypeScript knows record.properties is NudgeMessageProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Nudge type message
+     */
+    isNudge(): this is MessageRecord<NudgeMessageProperties>;
     /** Valid labels for Conversation associations */
     static readonly conversationsLabels: readonly ["Conversation_Message"];
     /**

package/dist/records-v2/MessageRecord.js

@@ -14,7 +14,7 @@
  * await record.createMessage({ ... }).execute();
  * ```
  *
- * Entity Types: DEFAULT, EVENT
+ * Entity Types: CLOSE, DEFAULT, EVENT, NUDGE
  *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
@@ -148,6 +148,22 @@ class MessageRecord {
     // ============================================
     // TYPE GUARDS (with TypeScript type predicates)
     // ============================================
+    /**
+     * Type guard: check if this record is of type CLOSE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to CLOSE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isClose()) {
+     *   // TypeScript knows record.properties is CloseMessageProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Close type message
+     */
+    isClose() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'CLOSE'; }
     /**
      * Type guard: check if this record is of type DEFAULT
      *
@@ -180,6 +196,22 @@ class MessageRecord {
      * @remarks event
      */
     isEvent() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'EVENT'; }
+    /**
+     * Type guard: check if this record is of type NUDGE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to NUDGE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isNudge()) {
+     *   // TypeScript knows record.properties is NudgeMessageProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Nudge type message
+     */
+    isNudge() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'NUDGE'; }
     /**
      * Access linked Conversation records
      * @remarks Available labels: Conversation_Message

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d19n/youfibre-odin-sdk",
-  "version": "2.0.17",
+  "version": "2.0.18",
   "description": "",
   "author": "@d19n",
   "license": "UNLICENSED",