@d19n/youfibre-odin-sdk 2.0.346 → 2.0.348

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

@@ -352,6 +352,7 @@ export declare enum CaseProblem {
  * - `FACEBOOK_COMMENT` - Facebook comment
  * - `FACEBOOK_MESSENGER` - Facebook Messenger
  * - `IN_APP_CHAT` - In-App Chat
+ * - `INSTAGRAM_COMMENT` - Instagram comment
  * - `INSTAGRAM_DM` - Instagram DM
  * - `SMS`
  * - `TLOS_APP` - TLOS App
@@ -359,8 +360,7 @@ export declare enum CaseProblem {
  * - `TRUSTPILOT_SERVICE_REVIEW` - Trustpilot review
  * - `TWITTER_X_DM` - Twitter/X DM
  * - `TWITTER_X_MENTION` - Twitter/X Mention
- * - `WEB_CHAT` - Web chat
- * - ... and 2 more
+ * - ... and 3 more
  */
 export declare enum CaseChannel {
     CALL = "CALL",
@@ -370,6 +370,7 @@ export declare enum CaseChannel {
     FACEBOOK_COMMENT = "FACEBOOK_COMMENT",
     FACEBOOK_MESSENGER = "FACEBOOK_MESSENGER",
     IN_APP_CHAT = "IN_APP_CHAT",
+    INSTAGRAM_COMMENT = "INSTAGRAM_COMMENT",
     INSTAGRAM_DM = "INSTAGRAM_DM",
     SMS = "SMS",
     TLOS_APP = "TLOS_APP",
@@ -1063,6 +1064,19 @@ export declare enum CaseFrustrationBand {
     RED = "RED",
     YELLOW = "YELLOW"
 }
+/**
+ * Valid values for Case.SaveContactMethod
+ *
+ * How an OTS/recontract retention save was made — call or email. Set only when RetentionOutcome is SAVED.
+ *
+ * @remarks Available options:
+ * - `CALL` - Call
+ * - `EMAIL` - Email
+ */
+export declare enum CaseSaveContactMethod {
+    CALL = "CALL",
+    EMAIL = "EMAIL"
+}
 /**
  * Property keys for Case
  * Use these constants instead of string literals for type safety
@@ -1273,7 +1287,9 @@ export declare enum CasePropertyKeys {
     /** A copy of the Account's FrustrationScore.Score when the Case was created or last refreshed. Written only by the frustration engine; the live value is on the FrustrationScore record. */
     FrustrationScore = "FrustrationScore",
     /** A copy of the Account's FrustrationScore stage when the Case was created or last refreshed. Written only by the frustration engine. */
-    FrustrationBand = "FrustrationBand"
+    FrustrationBand = "FrustrationBand",
+    /** How an OTS/recontract retention save was made — call or email. Set only when RetentionOutcome is SAVED. */
+    SaveContactMethod = "SaveContactMethod"
 }
 /**
  * Properties for Case records
@@ -1865,6 +1881,13 @@ export interface CaseProperties {
      * @enum {CaseFrustrationBand}
      */
     FrustrationBand: CaseFrustrationBand;
+    /** How an OTS/recontract retention save was made — call or email. Set only when RetentionOutcome is SAVED.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {CaseSaveContactMethod}
+     */
+    SaveContactMethod: CaseSaveContactMethod;
 }
 /**
  * Properties for OUTAGE Case records
@@ -2456,6 +2479,13 @@ export interface OutageCaseProperties {
      * @enum {CaseFrustrationBand}
      */
     FrustrationBand: CaseFrustrationBand;
+    /** How an OTS/recontract retention save was made — call or email. Set only when RetentionOutcome is SAVED.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {CaseSaveContactMethod}
+     */
+    SaveContactMethod: CaseSaveContactMethod;
 }
 /**
  * Case entity from SupportModule

package/dist/entities-v2/Case.js

@@ -12,8 +12,8 @@
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_CASE_OUTAGE_DELETED = exports.ROUTING_KEY_CASE_OUTAGE_UPDATED = exports.ROUTING_KEY_CASE_OUTAGE_CREATED = exports.ROUTING_KEY_CASE_DEFAULT_DELETED = exports.ROUTING_KEY_CASE_DEFAULT_UPDATED = exports.ROUTING_KEY_CASE_DEFAULT_CREATED = exports.ROUTING_KEY_CASE_DELETED = exports.ROUTING_KEY_CASE_UPDATED = exports.ROUTING_KEY_CASE_CREATED = exports.Case = exports.CasePropertyKeys = exports.CaseFrustrationBand = exports.CaseEnquirySubCategory = exports.CaseEnquiryCategory = exports.CaseDeprecated = exports.CaseRetentionOutcome = exports.CaseVulnerableCustomer = exports.CaseAutoResolutionStatus = exports.CaseLastDialOutcome = exports.CaseEscalationReason = exports.CaseOmbudsmanReason = exports.CaseSource = exports.CaseReasonForReview = exports.CaseImpact = exports.CaseCsatReason = exports.CaseBusinessArea = exports.CaseRetentionOffer = exports.CaseSla = exports.CaseReasonForLeaving = exports.CaseDpaCustomerType = exports.CaseDpaCustomerCategory = exports.CaseConversationStatus = exports.CaseBlockedReason = exports.CaseSubCategory = exports.CaseCategory = exports.CaseChannel = exports.CaseProblem = exports.CasePrimaryExceptionReason = exports.CasePrimaryException = exports.CaseFormalComplaint = exports.CaseOrigin = exports.CaseProviders = exports.CaseCsatResolutionReason = exports.CaseComplaint = exports.CaseCsatAgentReason = exports.OutageCaseStageKeys = exports.OutageCaseStageNames = exports.DefaultCaseStageKeys = exports.DefaultCaseStageNames = exports.CaseEntityTypes = void 0;
-exports.ROUTING_KEY_LINK_CASE_COACHING_SESSION_DELETED = exports.ROUTING_KEY_LINK_CASE_COACHING_SESSION_CREATED = exports.ROUTING_KEY_LINK_CASE_QA_EVALUATION_DELETED = exports.ROUTING_KEY_LINK_CASE_QA_EVALUATION_CREATED = exports.ROUTING_KEY_LINK_CASE_QA_REPORT_DELETED = exports.ROUTING_KEY_LINK_CASE_QA_REPORT_CREATED = exports.ROUTING_KEY_LINK_OUTBOUND_DIAL_SESSION_CASE_DELETED = exports.ROUTING_KEY_LINK_OUTBOUND_DIAL_SESSION_CASE_CREATED = exports.ROUTING_KEY_LINK_CASE_ONE_TOUCH_SWITCH_DELETED = exports.ROUTING_KEY_LINK_CASE_ONE_TOUCH_SWITCH_CREATED = exports.ROUTING_KEY_LINK_CASE_CASE_DELETED = exports.ROUTING_KEY_LINK_CASE_CASE_CREATED = exports.ROUTING_KEY_LINK_CASE_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_CASE_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_CASE_USER_DELETED = exports.ROUTING_KEY_LINK_CASE_USER_CREATED = exports.ROUTING_KEY_LINK_CASE_CONTRACT_BUY_OUT_DELETED = exports.ROUTING_KEY_LINK_CASE_CONTRACT_BUY_OUT_CREATED = exports.ROUTING_KEY_LINK_CASE_QUEUE_CHANGE_DELETED = exports.ROUTING_KEY_LINK_CASE_QUEUE_CHANGE_CREATED = exports.ROUTING_KEY_LINK_CASE_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_CASE_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_CASE_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_CASE_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_CASE_EMAIL_DELETED = exports.ROUTING_KEY_LINK_CASE_EMAIL_CREATED = exports.ROUTING_KEY_LINK_CASE_CONTACT_DELETED = exports.ROUTING_KEY_LINK_CASE_CONTACT_CREATED = exports.ROUTING_KEY_LINK_CASE_PUSH_NOTIFICATION_DELETED = exports.ROUTING_KEY_LINK_CASE_PUSH_NOTIFICATION_CREATED = exports.ROUTING_KEY_LINK_CASE_ORDER_DELETED = exports.ROUTING_KEY_LINK_CASE_ORDER_CREATED = exports.ROUTING_KEY_LINK_CASE_CONVERSATION_DELETED = exports.ROUTING_KEY_LINK_CASE_CONVERSATION_CREATED = exports.ROUTING_KEY_LINK_CASE_TEAM_DELETED = exports.ROUTING_KEY_LINK_CASE_TEAM_CREATED = exports.ROUTING_KEY_LINK_CASE_NOTE_DELETED = exports.ROUTING_KEY_LINK_CASE_NOTE_CREATED = exports.ROUTING_KEY_LINK_CASE_FILE_DELETED = exports.ROUTING_KEY_LINK_CASE_FILE_CREATED = exports.ROUTING_KEY_LINK_CASE_CASE_ACTION_DELETED = exports.ROUTING_KEY_LINK_CASE_CASE_ACTION_CREATED = exports.ROUTING_KEY_LINK_CASE_ACTIVITY_LOG_DELETED = exports.ROUTING_KEY_LINK_CASE_ACTIVITY_LOG_CREATED = void 0;
+exports.ROUTING_KEY_CASE_OUTAGE_UPDATED = exports.ROUTING_KEY_CASE_OUTAGE_CREATED = exports.ROUTING_KEY_CASE_DEFAULT_DELETED = exports.ROUTING_KEY_CASE_DEFAULT_UPDATED = exports.ROUTING_KEY_CASE_DEFAULT_CREATED = exports.ROUTING_KEY_CASE_DELETED = exports.ROUTING_KEY_CASE_UPDATED = exports.ROUTING_KEY_CASE_CREATED = exports.Case = exports.CasePropertyKeys = exports.CaseSaveContactMethod = exports.CaseFrustrationBand = exports.CaseEnquirySubCategory = exports.CaseEnquiryCategory = exports.CaseDeprecated = exports.CaseRetentionOutcome = exports.CaseVulnerableCustomer = exports.CaseAutoResolutionStatus = exports.CaseLastDialOutcome = exports.CaseEscalationReason = exports.CaseOmbudsmanReason = exports.CaseSource = exports.CaseReasonForReview = exports.CaseImpact = exports.CaseCsatReason = exports.CaseBusinessArea = exports.CaseRetentionOffer = exports.CaseSla = exports.CaseReasonForLeaving = exports.CaseDpaCustomerType = exports.CaseDpaCustomerCategory = exports.CaseConversationStatus = exports.CaseBlockedReason = exports.CaseSubCategory = exports.CaseCategory = exports.CaseChannel = exports.CaseProblem = exports.CasePrimaryExceptionReason = exports.CasePrimaryException = exports.CaseFormalComplaint = exports.CaseOrigin = exports.CaseProviders = exports.CaseCsatResolutionReason = exports.CaseComplaint = exports.CaseCsatAgentReason = exports.OutageCaseStageKeys = exports.OutageCaseStageNames = exports.DefaultCaseStageKeys = exports.DefaultCaseStageNames = exports.CaseEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_CASE_COACHING_SESSION_DELETED = exports.ROUTING_KEY_LINK_CASE_COACHING_SESSION_CREATED = exports.ROUTING_KEY_LINK_CASE_QA_EVALUATION_DELETED = exports.ROUTING_KEY_LINK_CASE_QA_EVALUATION_CREATED = exports.ROUTING_KEY_LINK_CASE_QA_REPORT_DELETED = exports.ROUTING_KEY_LINK_CASE_QA_REPORT_CREATED = exports.ROUTING_KEY_LINK_OUTBOUND_DIAL_SESSION_CASE_DELETED = exports.ROUTING_KEY_LINK_OUTBOUND_DIAL_SESSION_CASE_CREATED = exports.ROUTING_KEY_LINK_CASE_ONE_TOUCH_SWITCH_DELETED = exports.ROUTING_KEY_LINK_CASE_ONE_TOUCH_SWITCH_CREATED = exports.ROUTING_KEY_LINK_CASE_CASE_DELETED = exports.ROUTING_KEY_LINK_CASE_CASE_CREATED = exports.ROUTING_KEY_LINK_CASE_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_CASE_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_CASE_USER_DELETED = exports.ROUTING_KEY_LINK_CASE_USER_CREATED = exports.ROUTING_KEY_LINK_CASE_CONTRACT_BUY_OUT_DELETED = exports.ROUTING_KEY_LINK_CASE_CONTRACT_BUY_OUT_CREATED = exports.ROUTING_KEY_LINK_CASE_QUEUE_CHANGE_DELETED = exports.ROUTING_KEY_LINK_CASE_QUEUE_CHANGE_CREATED = exports.ROUTING_KEY_LINK_CASE_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_CASE_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_CASE_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_CASE_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_CASE_EMAIL_DELETED = exports.ROUTING_KEY_LINK_CASE_EMAIL_CREATED = exports.ROUTING_KEY_LINK_CASE_CONTACT_DELETED = exports.ROUTING_KEY_LINK_CASE_CONTACT_CREATED = exports.ROUTING_KEY_LINK_CASE_PUSH_NOTIFICATION_DELETED = exports.ROUTING_KEY_LINK_CASE_PUSH_NOTIFICATION_CREATED = exports.ROUTING_KEY_LINK_CASE_ORDER_DELETED = exports.ROUTING_KEY_LINK_CASE_ORDER_CREATED = exports.ROUTING_KEY_LINK_CASE_CONVERSATION_DELETED = exports.ROUTING_KEY_LINK_CASE_CONVERSATION_CREATED = exports.ROUTING_KEY_LINK_CASE_TEAM_DELETED = exports.ROUTING_KEY_LINK_CASE_TEAM_CREATED = exports.ROUTING_KEY_LINK_CASE_NOTE_DELETED = exports.ROUTING_KEY_LINK_CASE_NOTE_CREATED = exports.ROUTING_KEY_LINK_CASE_FILE_DELETED = exports.ROUTING_KEY_LINK_CASE_FILE_CREATED = exports.ROUTING_KEY_LINK_CASE_CASE_ACTION_DELETED = exports.ROUTING_KEY_LINK_CASE_CASE_ACTION_CREATED = exports.ROUTING_KEY_LINK_CASE_ACTIVITY_LOG_DELETED = exports.ROUTING_KEY_LINK_CASE_ACTIVITY_LOG_CREATED = exports.ROUTING_KEY_CASE_OUTAGE_DELETED = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for Case records
@@ -343,6 +343,7 @@ var CaseProblem;
  * - `FACEBOOK_COMMENT` - Facebook comment
  * - `FACEBOOK_MESSENGER` - Facebook Messenger
  * - `IN_APP_CHAT` - In-App Chat
+ * - `INSTAGRAM_COMMENT` - Instagram comment
  * - `INSTAGRAM_DM` - Instagram DM
  * - `SMS`
  * - `TLOS_APP` - TLOS App
@@ -350,8 +351,7 @@ var CaseProblem;
  * - `TRUSTPILOT_SERVICE_REVIEW` - Trustpilot review
  * - `TWITTER_X_DM` - Twitter/X DM
  * - `TWITTER_X_MENTION` - Twitter/X Mention
- * - `WEB_CHAT` - Web chat
- * - ... and 2 more
+ * - ... and 3 more
  */
 var CaseChannel;
 (function (CaseChannel) {
@@ -362,6 +362,7 @@ var CaseChannel;
     CaseChannel["FACEBOOK_COMMENT"] = "FACEBOOK_COMMENT";
     CaseChannel["FACEBOOK_MESSENGER"] = "FACEBOOK_MESSENGER";
     CaseChannel["IN_APP_CHAT"] = "IN_APP_CHAT";
+    CaseChannel["INSTAGRAM_COMMENT"] = "INSTAGRAM_COMMENT";
     CaseChannel["INSTAGRAM_DM"] = "INSTAGRAM_DM";
     CaseChannel["SMS"] = "SMS";
     CaseChannel["TLOS_APP"] = "TLOS_APP";
@@ -1079,6 +1080,20 @@ var CaseFrustrationBand;
     CaseFrustrationBand["RED"] = "RED";
     CaseFrustrationBand["YELLOW"] = "YELLOW";
 })(CaseFrustrationBand = exports.CaseFrustrationBand || (exports.CaseFrustrationBand = {}));
+/**
+ * Valid values for Case.SaveContactMethod
+ *
+ * How an OTS/recontract retention save was made — call or email. Set only when RetentionOutcome is SAVED.
+ *
+ * @remarks Available options:
+ * - `CALL` - Call
+ * - `EMAIL` - Email
+ */
+var CaseSaveContactMethod;
+(function (CaseSaveContactMethod) {
+    CaseSaveContactMethod["CALL"] = "CALL";
+    CaseSaveContactMethod["EMAIL"] = "EMAIL";
+})(CaseSaveContactMethod = exports.CaseSaveContactMethod || (exports.CaseSaveContactMethod = {}));
 /**
  * Property keys for Case
  * Use these constants instead of string literals for type safety
@@ -1291,6 +1306,8 @@ var CasePropertyKeys;
     CasePropertyKeys["FrustrationScore"] = "FrustrationScore";
     /** A copy of the Account's FrustrationScore stage when the Case was created or last refreshed. Written only by the frustration engine. */
     CasePropertyKeys["FrustrationBand"] = "FrustrationBand";
+    /** How an OTS/recontract retention save was made — call or email. Set only when RetentionOutcome is SAVED. */
+    CasePropertyKeys["SaveContactMethod"] = "SaveContactMethod";
 })(CasePropertyKeys = exports.CasePropertyKeys || (exports.CasePropertyKeys = {}));
 /**
  * Case entity from SupportModule

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

@@ -32,6 +32,7 @@ export declare enum ConversationEntityTypes {
  * - `FACEBOOK_COMMENT` - Facebook comment
  * - `FACEBOOK_MESSENGER` - Facebook Messenger
  * - `IN_APP_CHAT` - In-App Chat
+ * - `INSTAGRAM_COMMENT` - Instagram comment
  * - `INSTAGRAM_DM` - Instagram DM
  * - `SMS`
  * - `TRUSTPILOT_SERVICE_REVIEW` - Trustpilot Service Review
@@ -44,6 +45,7 @@ export declare enum ConversationChannel {
     FACEBOOK_COMMENT = "FACEBOOK_COMMENT",
     FACEBOOK_MESSENGER = "FACEBOOK_MESSENGER",
     IN_APP_CHAT = "IN_APP_CHAT",
+    INSTAGRAM_COMMENT = "INSTAGRAM_COMMENT",
     INSTAGRAM_DM = "INSTAGRAM_DM",
     SMS = "SMS",
     TRUSTPILOT_SERVICE_REVIEW = "TRUSTPILOT_SERVICE_REVIEW",

package/dist/entities-v2/Conversation.js

@@ -32,6 +32,7 @@ var ConversationEntityTypes;
  * - `FACEBOOK_COMMENT` - Facebook comment
  * - `FACEBOOK_MESSENGER` - Facebook Messenger
  * - `IN_APP_CHAT` - In-App Chat
+ * - `INSTAGRAM_COMMENT` - Instagram comment
  * - `INSTAGRAM_DM` - Instagram DM
  * - `SMS`
  * - `TRUSTPILOT_SERVICE_REVIEW` - Trustpilot Service Review
@@ -45,6 +46,7 @@ var ConversationChannel;
     ConversationChannel["FACEBOOK_COMMENT"] = "FACEBOOK_COMMENT";
     ConversationChannel["FACEBOOK_MESSENGER"] = "FACEBOOK_MESSENGER";
     ConversationChannel["IN_APP_CHAT"] = "IN_APP_CHAT";
+    ConversationChannel["INSTAGRAM_COMMENT"] = "INSTAGRAM_COMMENT";
     ConversationChannel["INSTAGRAM_DM"] = "INSTAGRAM_DM";
     ConversationChannel["SMS"] = "SMS";
     ConversationChannel["TRUSTPILOT_SERVICE_REVIEW"] = "TRUSTPILOT_SERVICE_REVIEW";