@d19n/youfibre-odin-sdk 1.0.265 → 1.0.267

package/dist/actions-v2/CreateCaseForChatDto.d.ts

@@ -13,21 +13,20 @@
  */
 import { OdinRecord, OdinRecordCreateDto, OdinRecordUpdateDto, OdinRecordUpdatedEvent, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
 /**
- * Properties for CreateCase action
+ * Properties for CreateSocialMediaCase action
  *
- * @property Required fields: 2
- * @property Optional fields: 6
+ * @property Required fields: 5
+ * @property Optional fields: 0
  */
-export interface CreateCaseProperties {
+export interface CreateSocialMediaCaseProperties {
     /**
-     * Sub Category
+     * Channel
      *
-     * SubCategory (Customer Service - Case)
+     * the channel from the source (Customer Service - Case)
      * @type {ENUM}
      * @required
-     * @visibleWhen Category = ["*"]
      */
-    SubCategory: string;
+    Channel: string;
     /**
      * Subject
      *
@@ -37,62 +36,71 @@ export interface CreateCaseProperties {
      */
     Subject: string;
     /**
-     * Channel
+     * Description
      *
-     * the channel from the source (Customer Service - Case)
-     * @type {ENUM}
-     * @default EMAIL
+     * Describe the issue being experienced (Customer Service - Case)
+     * @type {TEXT_LONG}
+     * @required
      */
-    Channel?: string;
+    Description: string;
     /**
-     * Category
+     * SocialMediaExternalId
      *
-     * Data field for Case records. Used by Customer Service team.
-     * @type {ENUM}
+     * This id represents the id receved from social media platforms for a user (Customer Service - Case)
+     * @type {TEXT}
+     * @required
+     */
+    SocialMediaExternalId: string;
+    /**
+     * ContactId
+     *
+     * Reference identifier for Case relationships. Used for data integrity.
+     * @type {LOOKUP}
+     * @required
      */
-    Category?: string;
+    ContactId: string;
 }
 /**
- * CreateCase
+ * CreateSocialMediaCase
  *
- * create a case
+ * Creates a case coming from social media channels
  *
  * @actionType CREATE - Creates a new Case record
  * @module SupportModule
  * @entity Case
- * @event SupportModule.Case.Create.CreateCase
- * @permission schema.action.createcase.trigger
- * @category LIFECYCLE
+ * @entityType DEFAULT (Default)
+ * @event SocialMediaCaseCreated
+ * @permission schema.action.createsocialmediacase.trigger
  * @benchmark This action is tracked for performance benchmarks
- * @benchmarkTags case, customer-service, record-creation
  */
-export declare class CreateCaseDto extends OdinRecordCreateDto<CreateCaseProperties> {
+export declare class CreateSocialMediaCaseDto extends OdinRecordCreateDto<CreateSocialMediaCaseProperties> {
     /** Used by SDK generators to identify action type */
     static readonly ACTION_TYPE = "CREATE";
-    static readonly ACTION_KEY = "CreateCase";
+    static readonly ACTION_KEY = "CreateSocialMediaCase";
     static readonly MODULE_NAME = "SupportModule";
     static readonly ENTITIES: string[];
-    static readonly EVENT_NAME = "SupportModule.Case.Create.CreateCase";
-    static readonly PERMISSION = "schema.action.createcase.trigger";
+    static readonly ENTITY_TYPE = "DEFAULT";
+    static readonly EVENT_NAME = "SocialMediaCaseCreated";
+    static readonly PERMISSION = "schema.action.createsocialmediacase.trigger";
     readonly actionName: string;
     readonly schemaActionId: string;
     readonly entity: string;
-    constructor(properties: CreateCaseProperties, options?: {
+    constructor(properties: CreateSocialMediaCaseProperties, options?: {
         journeyId?: string;
     });
 }
 /**
- * RabbitMQ message payload for CreateCase created events
+ * RabbitMQ message payload for CreateSocialMediaCase created events
  *
- * @event SupportModule.Case.Create.CreateCase
+ * @event SocialMediaCaseCreated
  */
-export interface CreateCaseMessage extends OdinRecordCreatedEvent<CreateCaseDto, CreateCaseProperties> {
+export interface CreateSocialMediaCaseMessage extends OdinRecordCreatedEvent<CreateSocialMediaCaseDto, CreateSocialMediaCaseProperties> {
 }
 /**
  * Properties for CreateConversation action
  *
- * @property Required fields: 1
- * @property Optional fields: 2
+ * @property Required fields: 0
+ * @property Optional fields: 5
  */
 export interface CreateConversationProperties {
     /**
@@ -107,8 +115,23 @@ export interface CreateConversationProperties {
      *
      * the status of the conversation (Communications - Conversation)
      * @type {ENUM}
+     * @default CREATED
      */
     Status?: string;
+    /**
+     * ExternalId
+     *
+     * Unique External ID (Conversation SID / Conversation ID) (Communications - Conversation)
+     * @type {TEXT}
+     */
+    ExternalId?: string;
+    /**
+     * Source
+     *
+     * Source for the conversaion (TWILIO, TRUSTPILOT, and other possible provider) (Communications - Conversation)
+     * @type {ENUM}
+     */
+    Source?: string;
 }
 /**
  * CreateConversation
@@ -149,8 +172,8 @@ export interface CreateConversationMessage extends OdinRecordCreatedEvent<Create
 /**
  * Properties for CreateMessage action
  *
- * @property Required fields: 1
- * @property Optional fields: 0
+ * @property Required fields: 4
+ * @property Optional fields: 2
  */
 export interface CreateMessageProperties {
     /**
@@ -161,6 +184,44 @@ export interface CreateMessageProperties {
      * @required
      */
     Body: string;
+    /**
+     * SenderType
+     *
+     * sender type (Communications - Message)
+     * @type {ENUM}
+     * @required
+     */
+    SenderType: string;
+    /**
+     * From
+     *
+     * Who sent the message (Communications - Message)
+     * @type {TEXT}
+     * @required
+     */
+    From: string;
+    /**
+     * To
+     *
+     * Who receive the message (if needed) (Communications - Message)
+     * @type {TEXT}
+     * @required
+     */
+    To: string;
+    /**
+     * ExternalId
+     *
+     * External ID of the message (Communications - Message)
+     * @type {TEXT}
+     */
+    ExternalId?: string;
+    /**
+     * Files
+     *
+     * Attachments of the message (Communications - Message)
+     * @type {FILE_MULTIPLE}
+     */
+    Files?: undefined;
 }
 /**
  * CreateMessage
@@ -199,7 +260,7 @@ export declare class CreateMessageDto extends OdinRecordCreateDto<CreateMessageP
 export interface CreateMessageMessage extends OdinRecordCreatedEvent<CreateMessageDto, CreateMessageProperties> {
 }
 declare type StepClassMap = {
-    CreateCaseDto: CreateCaseDto;
+    CreateSocialMediaCaseDto: CreateSocialMediaCaseDto;
     CreateConversationDto: CreateConversationDto;
     CreateMessageDto: CreateMessageDto;
 };
@@ -249,7 +310,7 @@ export declare class CreateCaseForChatDto extends OdinRecordUpdateDto<Record<str
         journeyId?: string;
     });
     /** Step classes that can be used with this action */
-    static readonly stepClasses: readonly ["CreateCaseDto", "CreateConversationDto", "CreateMessageDto"];
+    static readonly stepClasses: readonly ["CreateSocialMediaCaseDto", "CreateConversationDto", "CreateMessageDto"];
     steps: StepClassMap[(typeof CreateCaseForChatDto.stepClasses)[number]][];
 }
 /**

package/dist/actions-v2/CreateCaseForChatDto.js

@@ -13,43 +13,43 @@
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_CHAT_CASE_CREATED = exports.CreateCaseForChatDto = exports.CreateMessageDto = exports.CreateConversationDto = exports.CreateCaseDto = void 0;
+exports.ROUTING_KEY_CHAT_CASE_CREATED = exports.CreateCaseForChatDto = exports.CreateMessageDto = exports.CreateConversationDto = exports.CreateSocialMediaCaseDto = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
- * CreateCase
+ * CreateSocialMediaCase
  *
- * create a case
+ * Creates a case coming from social media channels
  *
  * @actionType CREATE - Creates a new Case record
  * @module SupportModule
  * @entity Case
- * @event SupportModule.Case.Create.CreateCase
- * @permission schema.action.createcase.trigger
- * @category LIFECYCLE
+ * @entityType DEFAULT (Default)
+ * @event SocialMediaCaseCreated
+ * @permission schema.action.createsocialmediacase.trigger
  * @benchmark This action is tracked for performance benchmarks
- * @benchmarkTags case, customer-service, record-creation
  */
-class CreateCaseDto extends core_1.OdinRecordCreateDto {
+class CreateSocialMediaCaseDto extends core_1.OdinRecordCreateDto {
     constructor(properties, options) {
         super({
             entity: 'SupportModule:Case',
-            type: undefined,
+            type: 'DEFAULT',
             properties,
             journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
         });
-        this.actionName = 'CreateCase';
-        this.schemaActionId = '4fd9f78b-0d8f-414e-96cf-aedf37b36d23';
+        this.actionName = 'CreateSocialMediaCase';
+        this.schemaActionId = '00ec5203-891a-4378-8a2b-20330e3e0fd5';
         this.entity = 'SupportModule:Case';
     }
 }
-exports.CreateCaseDto = CreateCaseDto;
+exports.CreateSocialMediaCaseDto = CreateSocialMediaCaseDto;
 /** Used by SDK generators to identify action type */
-CreateCaseDto.ACTION_TYPE = 'CREATE';
-CreateCaseDto.ACTION_KEY = 'CreateCase';
-CreateCaseDto.MODULE_NAME = 'SupportModule';
-CreateCaseDto.ENTITIES = ['Case'];
-CreateCaseDto.EVENT_NAME = 'SupportModule.Case.Create.CreateCase';
-CreateCaseDto.PERMISSION = 'schema.action.createcase.trigger';
+CreateSocialMediaCaseDto.ACTION_TYPE = 'CREATE';
+CreateSocialMediaCaseDto.ACTION_KEY = 'CreateSocialMediaCase';
+CreateSocialMediaCaseDto.MODULE_NAME = 'SupportModule';
+CreateSocialMediaCaseDto.ENTITIES = ['Case'];
+CreateSocialMediaCaseDto.ENTITY_TYPE = 'DEFAULT';
+CreateSocialMediaCaseDto.EVENT_NAME = 'SocialMediaCaseCreated';
+CreateSocialMediaCaseDto.PERMISSION = 'schema.action.createsocialmediacase.trigger';
 /**
  * CreateConversation
  *
@@ -157,7 +157,7 @@ CreateCaseForChatDto.ENTITY_TYPE = 'DEFAULT';
 CreateCaseForChatDto.EVENT_NAME = 'ChatCaseCreated';
 CreateCaseForChatDto.PERMISSION = 'schema.action.createcaseforchat.trigger';
 /** Step classes that can be used with this action */
-CreateCaseForChatDto.stepClasses = ['CreateCaseDto', 'CreateConversationDto', 'CreateMessageDto'];
+CreateCaseForChatDto.stepClasses = ['CreateSocialMediaCaseDto', 'CreateConversationDto', 'CreateMessageDto'];
 /**
  * RabbitMQ routing key for CreateCaseForChat events
  *

package/dist/actions-v2/CreateConversationDto.d.ts

@@ -14,8 +14,8 @@ import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/di
 /**
  * Properties for CreateConversation action
  *
- * @property Required fields: 1
- * @property Optional fields: 2
+ * @property Required fields: 0
+ * @property Optional fields: 5
  */
 export interface CreateConversationProperties {
     /**
@@ -30,8 +30,23 @@ export interface CreateConversationProperties {
      *
      * the status of the conversation (Communications - Conversation)
      * @type {ENUM}
+     * @default CREATED
      */
     Status?: string;
+    /**
+     * ExternalId
+     *
+     * Unique External ID (Conversation SID / Conversation ID) (Communications - Conversation)
+     * @type {TEXT}
+     */
+    ExternalId?: string;
+    /**
+     * Source
+     *
+     * Source for the conversaion (TWILIO, TRUSTPILOT, and other possible provider) (Communications - Conversation)
+     * @type {ENUM}
+     */
+    Source?: string;
 }
 /**
  * CreateConversation

package/dist/actions-v2/CreateMessageDto.d.ts

@@ -15,8 +15,8 @@ import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/di
 /**
  * Properties for CreateMessage action
  *
- * @property Required fields: 1
- * @property Optional fields: 0
+ * @property Required fields: 4
+ * @property Optional fields: 2
  */
 export interface CreateMessageProperties {
     /**
@@ -27,6 +27,44 @@ export interface CreateMessageProperties {
      * @required
      */
     Body: string;
+    /**
+     * SenderType
+     *
+     * sender type (Communications - Message)
+     * @type {ENUM}
+     * @required
+     */
+    SenderType: string;
+    /**
+     * From
+     *
+     * Who sent the message (Communications - Message)
+     * @type {TEXT}
+     * @required
+     */
+    From: string;
+    /**
+     * To
+     *
+     * Who receive the message (if needed) (Communications - Message)
+     * @type {TEXT}
+     * @required
+     */
+    To: string;
+    /**
+     * ExternalId
+     *
+     * External ID of the message (Communications - Message)
+     * @type {TEXT}
+     */
+    ExternalId?: string;
+    /**
+     * Files
+     *
+     * Attachments of the message (Communications - Message)
+     * @type {FILE_MULTIPLE}
+     */
+    Files?: undefined;
 }
 /**
  * CreateMessage

package/dist/actions-v2/CreateSocialMediaCaseDto.d.ts

@@ -0,0 +1,105 @@
+/**
+ * CreateSocialMediaCase Action DTO
+ *
+ * Creates a case coming from social media channels
+ *
+ * @module SupportModule
+ * @entity Case
+ * @entityType DEFAULT
+ * @actionKey CreateSocialMediaCase
+ * @event SocialMediaCaseCreated
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * Properties for CreateSocialMediaCase action
+ *
+ * @property Required fields: 5
+ * @property Optional fields: 0
+ */
+export interface CreateSocialMediaCaseProperties {
+    /**
+     * Channel
+     *
+     * the channel from the source (Customer Service - Case)
+     * @type {ENUM}
+     * @required
+     */
+    Channel: string;
+    /**
+     * Subject
+     *
+     * Data field for Case records. Used by Customer Service team.
+     * @type {TEXT}
+     * @required
+     */
+    Subject: string;
+    /**
+     * Description
+     *
+     * Describe the issue being experienced (Customer Service - Case)
+     * @type {TEXT_LONG}
+     * @required
+     */
+    Description: string;
+    /**
+     * SocialMediaExternalId
+     *
+     * This id represents the id receved from social media platforms for a user (Customer Service - Case)
+     * @type {TEXT}
+     * @required
+     */
+    SocialMediaExternalId: string;
+    /**
+     * ContactId
+     *
+     * Reference identifier for Case relationships. Used for data integrity.
+     * @type {LOOKUP}
+     * @required
+     */
+    ContactId: string;
+}
+/**
+ * CreateSocialMediaCase
+ *
+ * Creates a case coming from social media channels
+ *
+ * @actionType CREATE - Creates a new Case record
+ * @module SupportModule
+ * @entity Case
+ * @entityType DEFAULT (Default)
+ * @event SocialMediaCaseCreated
+ * @permission schema.action.createsocialmediacase.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class CreateSocialMediaCaseDto extends OdinRecordCreateDto<CreateSocialMediaCaseProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "CREATE";
+    static readonly ACTION_KEY = "CreateSocialMediaCase";
+    static readonly MODULE_NAME = "SupportModule";
+    static readonly ENTITIES: string[];
+    static readonly ENTITY_TYPE = "DEFAULT";
+    static readonly EVENT_NAME = "SocialMediaCaseCreated";
+    static readonly PERMISSION = "schema.action.createsocialmediacase.trigger";
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(properties: CreateSocialMediaCaseProperties, options?: {
+        journeyId?: string;
+    });
+}
+/**
+ * RabbitMQ message payload for CreateSocialMediaCase created events
+ *
+ * @event SocialMediaCaseCreated
+ */
+export interface CreateSocialMediaCaseMessage extends OdinRecordCreatedEvent<CreateSocialMediaCaseDto, CreateSocialMediaCaseProperties> {
+}
+/**
+ * RabbitMQ routing key for CreateSocialMediaCase events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event SocialMediaCaseCreated
+ */
+export declare const ROUTING_KEY_SOCIAL_MEDIA_CASE_CREATED = "SocialMediaCaseCreated";

package/dist/actions-v2/CreateSocialMediaCaseDto.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * CreateSocialMediaCase Action DTO
+ *
+ * Creates a case coming from social media channels
+ *
+ * @module SupportModule
+ * @entity Case
+ * @entityType DEFAULT
+ * @actionKey CreateSocialMediaCase
+ * @event SocialMediaCaseCreated
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_SOCIAL_MEDIA_CASE_CREATED = exports.CreateSocialMediaCaseDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * CreateSocialMediaCase
+ *
+ * Creates a case coming from social media channels
+ *
+ * @actionType CREATE - Creates a new Case record
+ * @module SupportModule
+ * @entity Case
+ * @entityType DEFAULT (Default)
+ * @event SocialMediaCaseCreated
+ * @permission schema.action.createsocialmediacase.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class CreateSocialMediaCaseDto extends core_1.OdinRecordCreateDto {
+    constructor(properties, options) {
+        super({
+            entity: 'SupportModule:Case',
+            type: 'DEFAULT',
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+        });
+        this.actionName = 'CreateSocialMediaCase';
+        this.schemaActionId = '00ec5203-891a-4378-8a2b-20330e3e0fd5';
+        this.entity = 'SupportModule:Case';
+    }
+}
+exports.CreateSocialMediaCaseDto = CreateSocialMediaCaseDto;
+/** Used by SDK generators to identify action type */
+CreateSocialMediaCaseDto.ACTION_TYPE = 'CREATE';
+CreateSocialMediaCaseDto.ACTION_KEY = 'CreateSocialMediaCase';
+CreateSocialMediaCaseDto.MODULE_NAME = 'SupportModule';
+CreateSocialMediaCaseDto.ENTITIES = ['Case'];
+CreateSocialMediaCaseDto.ENTITY_TYPE = 'DEFAULT';
+CreateSocialMediaCaseDto.EVENT_NAME = 'SocialMediaCaseCreated';
+CreateSocialMediaCaseDto.PERMISSION = 'schema.action.createsocialmediacase.trigger';
+/**
+ * RabbitMQ routing key for CreateSocialMediaCase events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event SocialMediaCaseCreated
+ */
+exports.ROUTING_KEY_SOCIAL_MEDIA_CASE_CREATED = 'SocialMediaCaseCreated';