@d19n/youfibre-odin-sdk 1.0.281 → 1.0.282-beta.0

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

@@ -0,0 +1,68 @@
+/**
+ * UpdateReferralCode Action DTO
+ *
+ * Set referral code for a contact
+ *
+ * @module CrmModule
+ * @entity Contact
+ * @actionKey UpdateReferralCode
+ * @event ReferralCodeUpdated
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * Properties for UpdateReferralCode action
+ *
+ * @property Required fields: 1
+ * @property Optional fields: 0
+ */
+export interface UpdateReferralCodeProperties {
+    /**
+     * ReferralCode
+     *
+     * Referral Code (Sales - Contact)
+     * @type {TEXT}
+     * @required
+     */
+    ReferralCode: string;
+}
+/**
+ * UpdateReferralCode
+ *
+ * Set referral code for a contact
+ *
+ * @actionType UPDATE - Updates an existing Contact record
+ * @module CrmModule
+ * @entity Contact
+ * @event CrmModule.Contact.Update.UpdateReferralCode
+ * @permission schema.action.updatereferralcode.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class UpdateReferralCodeDto extends OdinRecordUpdateDto<UpdateReferralCodeProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "UpdateReferralCode";
+    static readonly MODULE_NAME = "CrmModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "CrmModule.Contact.Update.UpdateReferralCode";
+    static readonly PERMISSION = "schema.action.updatereferralcode.trigger";
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(record: OdinRecord<any> | {
+        id: string;
+        entity: string;
+        type?: string;
+    }, properties: UpdateReferralCodeProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    });
+}
+/**
+ * RabbitMQ message payload for UpdateReferralCode updated events
+ *
+ * @event CrmModule.Contact.Update.UpdateReferralCode
+ */
+export interface UpdateReferralCodeMessage extends OdinRecordUpdatedEvent<UpdateReferralCodeDto, UpdateReferralCodeProperties> {
+}

package/dist/actions-v2/UpdateReferralCodeDto.js

@@ -0,0 +1,51 @@
+"use strict";
+/**
+ * UpdateReferralCode Action DTO
+ *
+ * Set referral code for a contact
+ *
+ * @module CrmModule
+ * @entity Contact
+ * @actionKey UpdateReferralCode
+ * @event ReferralCodeUpdated
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateReferralCodeDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * UpdateReferralCode
+ *
+ * Set referral code for a contact
+ *
+ * @actionType UPDATE - Updates an existing Contact record
+ * @module CrmModule
+ * @entity Contact
+ * @event CrmModule.Contact.Update.UpdateReferralCode
+ * @permission schema.action.updatereferralcode.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class UpdateReferralCodeDto 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 = 'UpdateReferralCode';
+        this.schemaActionId = '1b4f41b7-c146-49d8-8f3e-a9be184d2a0b';
+        this.entity = 'CrmModule:Contact';
+    }
+}
+exports.UpdateReferralCodeDto = UpdateReferralCodeDto;
+/** Used by SDK generators to identify action type */
+UpdateReferralCodeDto.ACTION_TYPE = 'UPDATE';
+UpdateReferralCodeDto.ACTION_KEY = 'UpdateReferralCode';
+UpdateReferralCodeDto.MODULE_NAME = 'CrmModule';
+UpdateReferralCodeDto.ENTITIES = ['Contact'];
+UpdateReferralCodeDto.EVENT_NAME = 'CrmModule.Contact.Update.UpdateReferralCode';
+UpdateReferralCodeDto.PERMISSION = 'schema.action.updatereferralcode.trigger';

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

@@ -323,12 +323,12 @@ export declare enum ContactPropertyKeys {
     Phone = "Phone",
     /** previous other (Sales - Contact) */
     PreviousProviderOther = "PreviousProviderOther",
-    /** Referral Code (Sales - Contact) */
-    ReferralCode = "ReferralCode",
     /** the referral link from Aklamio (Sales - Contact) */
     ReferralLink = "ReferralLink",
     /** is the phone number verified by twilio (Sales - Contact) */
     TwilioVerifiedPhone = "TwilioVerifiedPhone",
+    /** Referral Code (Sales - Contact) */
+    ReferralCode = "ReferralCode",
     /** FingerprintID (Sales - Contact) */
     FingerprintId = "FingerprintID",
     /** Send if true otherwise they have opted-out if false (Sales - Contact) */
@@ -565,12 +565,6 @@ export interface ContactProperties {
      * @hidden This field is hidden in the UI
      */
     PreviousProviderOther: string;
-    /** Referral Code (Sales - Contact)
-     *
-     * @type {TEXT}
-     * @hidden This field is hidden in the UI
-     */
-    ReferralCode: string;
     /** the referral link from Aklamio (Sales - Contact)
      *
      * @type {TEXT}
@@ -583,6 +577,11 @@ export interface ContactProperties {
      * @hidden This field is hidden in the UI
      */
     TwilioVerifiedPhone: boolean;
+    /** Referral Code (Sales - Contact)
+     *
+     * @type {TEXT}
+     */
+    ReferralCode: string;
     /** FingerprintID (Sales - Contact)
      *
      * @type {TEXT}

package/dist/entities-v2/Contact.js

@@ -307,12 +307,12 @@ var ContactPropertyKeys;
     ContactPropertyKeys["Phone"] = "Phone";
     /** previous other (Sales - Contact) */
     ContactPropertyKeys["PreviousProviderOther"] = "PreviousProviderOther";
-    /** Referral Code (Sales - Contact) */
-    ContactPropertyKeys["ReferralCode"] = "ReferralCode";
     /** the referral link from Aklamio (Sales - Contact) */
     ContactPropertyKeys["ReferralLink"] = "ReferralLink";
     /** is the phone number verified by twilio (Sales - Contact) */
     ContactPropertyKeys["TwilioVerifiedPhone"] = "TwilioVerifiedPhone";
+    /** Referral Code (Sales - Contact) */
+    ContactPropertyKeys["ReferralCode"] = "ReferralCode";
     /** FingerprintID (Sales - Contact) */
     ContactPropertyKeys["FingerprintId"] = "FingerprintID";
     /** Send if true otherwise they have opted-out if false (Sales - Contact) */