@d19n/youfibre-odin-sdk 2.0.19-beta.0 → 2.0.20

package/README.md

@@ -352,7 +352,7 @@ This SDK includes **164** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **584** actions.
+This SDK includes **585** actions.
 
 ### Action Types
 
@@ -735,6 +735,7 @@ This SDK includes **584** actions.
 | `MoveDefaultCaseFromOpenToClosed` | STAGE_TRANSITION | k1.t-hEOJjsDb.SupportModule.Case.Update.MarkCaseClosed |
 | `MovetoClosed` | STAGE_TRANSITION | k1.t-hEOJjsDb.SupportModule.Case.Transition.MovetoClosed |
 | `RemoveAssignmentFromCase` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.RemoveAssignmentFromCase |
+| `UpdateCaseCsat` | UPDATE | k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat |
 | `UpdateFormalComplaint` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateFormalComplaint |
 | `UpdateSentiment` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateSentiment |
 | `UpdateTags` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateTags |

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

@@ -0,0 +1,135 @@
+/**
+ * UpdateCaseCsat Action DTO
+ *
+ * Updates the customer satisfaction fields
+ *
+ * @module SupportModule
+ * @entity Case
+ * @actionKey UpdateCaseCsat
+ * @event k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for UpdateCaseCsat updated events
+ *
+ * @event k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat
+ */
+export interface UpdateCaseCsatMessage extends OdinRecordUpdatedEvent<UpdateCaseCsatDto, UpdateCaseCsatProperties> {
+}
+/**
+ * Properties for UpdateCaseCsat action
+ *
+ * @property Required fields: 0
+ * @property Optional fields: 10
+ */
+export interface UpdateCaseCsatProperties {
+    /**
+     * Resolution CSAT Score
+     *
+     * Customer satisfaction score for the resolution of the case.
+     * @type {NUMBER}
+     */
+    CsatResolutionScore?: number | null;
+    /**
+     * Resolution CSAT Reason
+     *
+     * Main reason for the resolution CSAT score.
+     * @type {ENUM}
+     */
+    CsatResolutionReason?: string | null;
+    /**
+     * Other Resolution CSAT Reason
+     *
+     * Reason when Resolution CSAT Reason is OTHER.
+     * @type {TEXT_LONG}
+     */
+    CsatResolutionOtherReason?: string | null;
+    /**
+     * Resolution CSAT Comment
+     *
+     * Optional customer comment about the resolution.
+     * @type {TEXT_LONG}
+     */
+    CsatResolutionComment?: string | null;
+    /**
+     * Agent CSAT Comment
+     *
+     * Optional customer comment about the agent.
+     * @type {TEXT_LONG}
+     */
+    CsatAgentComment?: string | null;
+    /**
+     * Other Agent CSAT Reason
+     *
+     * Reason when Agent CSAT Reason is OTHER.
+     * @type {TEXT_LONG}
+     */
+    CsatAgentOtherReason?: string | null;
+    /**
+     * Agent CSAT Reason
+     *
+     * Main reason for the agent CSAT score.
+     * @type {ENUM}
+     */
+    CsatAgentReason?: string | null;
+    /**
+     * Agent CSAT Score
+     *
+     * Customer satisfaction score for the agent who handled the case.
+     * @type {NUMBER}
+     */
+    CsatAgentScore?: number | null;
+    /**
+     * CSAT Response Date
+     *
+     * Timestamp of the CSAT response
+     * @type {DATE_TIME}
+     */
+    CsatResponseAt?: string | null;
+    /**
+     * CSAT Sent At
+     *
+     * Indicates when the CSAT has been sent
+     * @type {DATE_TIME}
+     */
+    CsatSentAt?: string | null;
+}
+/**
+ * UpdateCaseCsat
+ *
+ * Updates the customer satisfaction fields
+ *
+ * @actionType UPDATE - Updates an existing Case record
+ * @module SupportModule
+ * @entity Case
+ * @event k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat
+ * @permission schema.action.updatecasecsat.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class UpdateCaseCsatDto extends OdinRecordUpdateDto<UpdateCaseCsatProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "UpdateCaseCsat";
+    static readonly MODULE_NAME = "SupportModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat";
+    static readonly PERMISSION = "schema.action.updatecasecsat.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "SupportModule:Case";
+    static readonly STEP_SCHEMA_ID = "be8173eb-269b-4a67-be0c-11ce6af5d561";
+    static readonly STEP_SCHEMA_ACTION_ID = "69f8e454-d840-4dce-8484-321c2146f5f3";
+    static readonly AUTO_LINK_PARENT = false;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(record: OdinRecord<any> | {
+        id: string;
+        entity: string;
+        type?: string;
+    }, properties: UpdateCaseCsatProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    });
+}

package/dist/actions-v2/UpdateCaseCsatDto.js

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * UpdateCaseCsat Action DTO
+ *
+ * Updates the customer satisfaction fields
+ *
+ * @module SupportModule
+ * @entity Case
+ * @actionKey UpdateCaseCsat
+ * @event k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateCaseCsatDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * UpdateCaseCsat
+ *
+ * Updates the customer satisfaction fields
+ *
+ * @actionType UPDATE - Updates an existing Case record
+ * @module SupportModule
+ * @entity Case
+ * @event k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat
+ * @permission schema.action.updatecasecsat.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class UpdateCaseCsatDto extends core_1.OdinRecordUpdateDto {
+    constructor(record, properties, options) {
+        super({
+            id: record.id,
+            entity: record.entity,
+            type: record.type,
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+            stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
+        });
+        this.actionName = 'UpdateCaseCsat';
+        this.schemaActionId = '69f8e454-d840-4dce-8484-321c2146f5f3';
+        this.entity = 'SupportModule:Case';
+    }
+}
+exports.UpdateCaseCsatDto = UpdateCaseCsatDto;
+/** Used by SDK generators to identify action type */
+UpdateCaseCsatDto.ACTION_TYPE = 'UPDATE';
+UpdateCaseCsatDto.ACTION_KEY = 'UpdateCaseCsat';
+UpdateCaseCsatDto.MODULE_NAME = 'SupportModule';
+UpdateCaseCsatDto.ENTITIES = ['Case'];
+UpdateCaseCsatDto.EVENT_NAME = 'k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat';
+UpdateCaseCsatDto.PERMISSION = 'schema.action.updatecasecsat.trigger';
+/** Step metadata - entity this action targets */
+UpdateCaseCsatDto.STEP_ENTITY = 'SupportModule:Case';
+UpdateCaseCsatDto.STEP_SCHEMA_ID = 'be8173eb-269b-4a67-be0c-11ce6af5d561';
+UpdateCaseCsatDto.STEP_SCHEMA_ACTION_ID = '69f8e454-d840-4dce-8484-321c2146f5f3';
+UpdateCaseCsatDto.AUTO_LINK_PARENT = false;

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

@@ -23,12 +23,12 @@ export declare enum ConfigEntityTypes {
  * Use these constants instead of string literals for type safety
  */
 export declare enum ConfigPropertyKeys {
-    /** the name of the app this config relates to (Platform - Config) */
-    AppName = "AppName",
+    /** Data field for Config records. Used by Platform team. */
+    Test = "Test",
     /** object of { key: value } mappings (Platform - Config) */
     Mappings = "Mappings",
-    /** Data field for Config records. Used by Platform team. */
-    Test = "Test"
+    /** the name of the app this config relates to (Platform - Config) */
+    AppName = "AppName"
 }
 /**
  * Properties for Config records
@@ -36,21 +36,21 @@ export declare enum ConfigPropertyKeys {
  * @see SchemaModule:Config
  */
 export interface ConfigProperties {
-    /** the name of the app this config relates to (Platform - Config)
+    /** Data field for Config records. Used by Platform team.
      *
      * @type {TEXT}
      */
-    AppName: string;
+    Test: string;
     /** object of { key: value } mappings (Platform - Config)
      *
      * @type {JSON}
      */
     Mappings: string;
-    /** Data field for Config records. Used by Platform team.
+    /** the name of the app this config relates to (Platform - Config)
      *
      * @type {TEXT}
      */
-    Test: string;
+    AppName: string;
 }
 /**
  * Config entity from SchemaModule

package/dist/entities-v2/Config.js

@@ -28,12 +28,12 @@ var ConfigEntityTypes;
  */
 var ConfigPropertyKeys;
 (function (ConfigPropertyKeys) {
-    /** the name of the app this config relates to (Platform - Config) */
-    ConfigPropertyKeys["AppName"] = "AppName";
-    /** object of { key: value } mappings (Platform - Config) */
-    ConfigPropertyKeys["Mappings"] = "Mappings";
     /** Data field for Config records. Used by Platform team. */
     ConfigPropertyKeys["Test"] = "Test";
+    /** object of { key: value } mappings (Platform - Config) */
+    ConfigPropertyKeys["Mappings"] = "Mappings";
+    /** the name of the app this config relates to (Platform - Config) */
+    ConfigPropertyKeys["AppName"] = "AppName";
 })(ConfigPropertyKeys = exports.ConfigPropertyKeys || (exports.ConfigPropertyKeys = {}));
 /**
  * Config entity from SchemaModule

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

@@ -361,6 +361,8 @@ export declare enum ContactPropertyKeys {
     ActivationDate = "ActivationDate",
     /** Is the customer medically dependant on their broadband (Sales - Contact) */
     MedicallyDependant = "MedicallyDependant",
+    /** vulnerable customer */
+    VulnerableCustomer = "VulnerableCustomer",
     /** Name */
     Name = "Name",
     /** External Reference */
@@ -683,6 +685,11 @@ export interface ContactProperties {
      * @default FALSE
      */
     MedicallyDependant: boolean;
+    /** vulnerable customer
+     *
+     * @type {BOOLEAN}
+     */
+    VulnerableCustomer: boolean;
     /** Name
      *
      * @type {TEXT}

package/dist/entities-v2/Contact.js

@@ -344,6 +344,8 @@ var ContactPropertyKeys;
     ContactPropertyKeys["ActivationDate"] = "ActivationDate";
     /** Is the customer medically dependant on their broadband (Sales - Contact) */
     ContactPropertyKeys["MedicallyDependant"] = "MedicallyDependant";
+    /** vulnerable customer */
+    ContactPropertyKeys["VulnerableCustomer"] = "VulnerableCustomer";
     /** Name */
     ContactPropertyKeys["Name"] = "Name";
     /** External Reference */

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

@@ -38,8 +38,10 @@ export declare enum CustomerDeviceOntEntityTypes {
  * - `621_X` - 621X
  * - `622_V` - 622v
  * - `631_Q` - 631q
+ * - `BRSK_OTHER`
  */
 export declare enum CustomerDeviceOntModel {
+    BRSK_OTHER = "BRSK_OTHER"
 }
 /**
  * Valid values for CustomerDeviceOnt.OltName

package/dist/entities-v2/CustomerDeviceOnt.js

@@ -32,9 +32,11 @@ var CustomerDeviceOntEntityTypes;
  * - `621_X` - 621X
  * - `622_V` - 622v
  * - `631_Q` - 631q
+ * - `BRSK_OTHER`
  */
 var CustomerDeviceOntModel;
 (function (CustomerDeviceOntModel) {
+    CustomerDeviceOntModel["BRSK_OTHER"] = "BRSK_OTHER";
 })(CustomerDeviceOntModel = exports.CustomerDeviceOntModel || (exports.CustomerDeviceOntModel = {}));
 /**
  * Valid values for CustomerDeviceOnt.OltName