@headspace/protos-events 1.782.0 → 1.783.0

package/lib/index.d.ts

@@ -42078,6 +42078,108 @@ export class TaggedCustomField implements ITaggedCustomField {
     public toJSON(): { [k: string]: any };
 }
 
+/** Properties of an UtmParams. */
+export interface IUtmParams {
+
+    /** UtmParams source */
+    source?: (string|null);
+
+    /** UtmParams medium */
+    medium?: (string|null);
+
+    /** UtmParams campaign */
+    campaign?: (string|null);
+}
+
+/** Represents an UtmParams. */
+export class UtmParams implements IUtmParams {
+
+    /**
+     * Constructs a new UtmParams.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: IUtmParams);
+
+    /** UtmParams source. */
+    public source: string;
+
+    /** UtmParams medium. */
+    public medium: string;
+
+    /** UtmParams campaign. */
+    public campaign: string;
+
+    /**
+     * Creates a new UtmParams instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns UtmParams instance
+     */
+    public static create(properties?: IUtmParams): UtmParams;
+
+    /**
+     * Encodes the specified UtmParams message. Does not implicitly {@link UtmParams.verify|verify} messages.
+     * @param message UtmParams message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: IUtmParams, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified UtmParams message, length delimited. Does not implicitly {@link UtmParams.verify|verify} messages.
+     * @param message UtmParams message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: IUtmParams, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes an UtmParams message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns UtmParams
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): UtmParams;
+
+    /**
+     * Decodes an UtmParams message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns UtmParams
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): UtmParams;
+
+    /**
+     * Verifies an UtmParams message.
+     * @param message Plain object to verify
+     * @returns `null` if valid, otherwise the reason why it is not
+     */
+    public static verify(message: { [k: string]: any }): (string|null);
+
+    /**
+     * Creates an UtmParams message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns UtmParams
+     */
+    public static fromObject(object: { [k: string]: any }): UtmParams;
+
+    /**
+     * Creates a plain object from an UtmParams message. Also converts values to other types if specified.
+     * @param message UtmParams
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: UtmParams, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this UtmParams to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
 /** Properties of an EnterpriseUserOnboarded. */
 export interface IEnterpriseUserOnboarded {
 
@@ -42380,6 +42482,9 @@ export interface IEnterpriseUserEnrollmentCreated {
 
     /** EnterpriseUserEnrollmentCreated isTextCoachingDisabled */
     isTextCoachingDisabled?: (boolean|null);
+
+    /** EnterpriseUserEnrollmentCreated utmParams */
+    utmParams?: (IUtmParams|null);
 }
 
 /** Represents an EnterpriseUserEnrollmentCreated. */
@@ -42559,6 +42664,9 @@ export class EnterpriseUserEnrollmentCreated implements IEnterpriseUserEnrollmen
     /** EnterpriseUserEnrollmentCreated isTextCoachingDisabled. */
     public isTextCoachingDisabled: boolean;
 
+    /** EnterpriseUserEnrollmentCreated utmParams. */
+    public utmParams?: (IUtmParams|null);
+
     /**
      * Creates a new EnterpriseUserEnrollmentCreated instance using the specified properties.
      * @param [properties] Properties to set

package/lib/index.js

@@ -118328,6 +118328,238 @@ $root.TaggedCustomField = (function() {
     return TaggedCustomField;
 })();
 
+$root.UtmParams = (function() {
+
+    /**
+     * Properties of an UtmParams.
+     * @name IUtmParams
+     * @interface IUtmParams
+     * @property {string|null} [source] UtmParams source
+     * @property {string|null} [medium] UtmParams medium
+     * @property {string|null} [campaign] UtmParams campaign
+     */
+
+    /**
+     * Constructs a new UtmParams.
+     * @name UtmParams
+     * @classdesc Represents an UtmParams.
+     * @implements IUtmParams
+     * @constructor
+     * @param {IUtmParams=} [properties] Properties to set
+     */
+    function UtmParams(properties) {
+        if (properties)
+            for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
+                if (properties[keys[i]] != null)
+                    this[keys[i]] = properties[keys[i]];
+    }
+
+    /**
+     * UtmParams source.
+     * @member {string} source
+     * @memberof UtmParams
+     * @instance
+     */
+    UtmParams.prototype.source = "";
+
+    /**
+     * UtmParams medium.
+     * @member {string} medium
+     * @memberof UtmParams
+     * @instance
+     */
+    UtmParams.prototype.medium = "";
+
+    /**
+     * UtmParams campaign.
+     * @member {string} campaign
+     * @memberof UtmParams
+     * @instance
+     */
+    UtmParams.prototype.campaign = "";
+
+    /**
+     * Creates a new UtmParams instance using the specified properties.
+     * @function create
+     * @memberof UtmParams
+     * @static
+     * @param {IUtmParams=} [properties] Properties to set
+     * @returns {UtmParams} UtmParams instance
+     */
+    UtmParams.create = function create(properties) {
+        return new UtmParams(properties);
+    };
+
+    /**
+     * Encodes the specified UtmParams message. Does not implicitly {@link UtmParams.verify|verify} messages.
+     * @function encode
+     * @memberof UtmParams
+     * @static
+     * @param {IUtmParams} message UtmParams message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    UtmParams.encode = function encode(message, writer) {
+        if (!writer)
+            writer = $Writer.create();
+        if (message.source != null && message.hasOwnProperty("source"))
+            writer.uint32(/* id 1, wireType 2 =*/10).string(message.source);
+        if (message.medium != null && message.hasOwnProperty("medium"))
+            writer.uint32(/* id 2, wireType 2 =*/18).string(message.medium);
+        if (message.campaign != null && message.hasOwnProperty("campaign"))
+            writer.uint32(/* id 3, wireType 2 =*/26).string(message.campaign);
+        return writer;
+    };
+
+    /**
+     * Encodes the specified UtmParams message, length delimited. Does not implicitly {@link UtmParams.verify|verify} messages.
+     * @function encodeDelimited
+     * @memberof UtmParams
+     * @static
+     * @param {IUtmParams} message UtmParams message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    UtmParams.encodeDelimited = function encodeDelimited(message, writer) {
+        return this.encode(message, writer).ldelim();
+    };
+
+    /**
+     * Decodes an UtmParams message from the specified reader or buffer.
+     * @function decode
+     * @memberof UtmParams
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @param {number} [length] Message length if known beforehand
+     * @returns {UtmParams} UtmParams
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    UtmParams.decode = function decode(reader, length) {
+        if (!(reader instanceof $Reader))
+            reader = $Reader.create(reader);
+        var end = length === undefined ? reader.len : reader.pos + length, message = new $root.UtmParams();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+            case 1:
+                message.source = reader.string();
+                break;
+            case 2:
+                message.medium = reader.string();
+                break;
+            case 3:
+                message.campaign = reader.string();
+                break;
+            default:
+                reader.skipType(tag & 7);
+                break;
+            }
+        }
+        return message;
+    };
+
+    /**
+     * Decodes an UtmParams message from the specified reader or buffer, length delimited.
+     * @function decodeDelimited
+     * @memberof UtmParams
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @returns {UtmParams} UtmParams
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    UtmParams.decodeDelimited = function decodeDelimited(reader) {
+        if (!(reader instanceof $Reader))
+            reader = new $Reader(reader);
+        return this.decode(reader, reader.uint32());
+    };
+
+    /**
+     * Verifies an UtmParams message.
+     * @function verify
+     * @memberof UtmParams
+     * @static
+     * @param {Object.<string,*>} message Plain object to verify
+     * @returns {string|null} `null` if valid, otherwise the reason why it is not
+     */
+    UtmParams.verify = function verify(message) {
+        if (typeof message !== "object" || message === null)
+            return "object expected";
+        if (message.source != null && message.hasOwnProperty("source"))
+            if (!$util.isString(message.source))
+                return "source: string expected";
+        if (message.medium != null && message.hasOwnProperty("medium"))
+            if (!$util.isString(message.medium))
+                return "medium: string expected";
+        if (message.campaign != null && message.hasOwnProperty("campaign"))
+            if (!$util.isString(message.campaign))
+                return "campaign: string expected";
+        return null;
+    };
+
+    /**
+     * Creates an UtmParams message from a plain object. Also converts values to their respective internal types.
+     * @function fromObject
+     * @memberof UtmParams
+     * @static
+     * @param {Object.<string,*>} object Plain object
+     * @returns {UtmParams} UtmParams
+     */
+    UtmParams.fromObject = function fromObject(object) {
+        if (object instanceof $root.UtmParams)
+            return object;
+        var message = new $root.UtmParams();
+        if (object.source != null)
+            message.source = String(object.source);
+        if (object.medium != null)
+            message.medium = String(object.medium);
+        if (object.campaign != null)
+            message.campaign = String(object.campaign);
+        return message;
+    };
+
+    /**
+     * Creates a plain object from an UtmParams message. Also converts values to other types if specified.
+     * @function toObject
+     * @memberof UtmParams
+     * @static
+     * @param {UtmParams} message UtmParams
+     * @param {$protobuf.IConversionOptions} [options] Conversion options
+     * @returns {Object.<string,*>} Plain object
+     */
+    UtmParams.toObject = function toObject(message, options) {
+        if (!options)
+            options = {};
+        var object = {};
+        if (options.defaults) {
+            object.source = "";
+            object.medium = "";
+            object.campaign = "";
+        }
+        if (message.source != null && message.hasOwnProperty("source"))
+            object.source = message.source;
+        if (message.medium != null && message.hasOwnProperty("medium"))
+            object.medium = message.medium;
+        if (message.campaign != null && message.hasOwnProperty("campaign"))
+            object.campaign = message.campaign;
+        return object;
+    };
+
+    /**
+     * Converts this UtmParams to JSON.
+     * @function toJSON
+     * @memberof UtmParams
+     * @instance
+     * @returns {Object.<string,*>} JSON object
+     */
+    UtmParams.prototype.toJSON = function toJSON() {
+        return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
+    };
+
+    return UtmParams;
+})();
+
 $root.EnterpriseUserOnboarded = (function() {
 
     /**
@@ -118777,6 +119009,7 @@ $root.EnterpriseUserEnrollmentCreated = (function() {
      * @property {string|null} [brandLogoUrl] EnterpriseUserEnrollmentCreated brandLogoUrl
      * @property {Array.<ITaggedCustomField>|null} [taggedCustomFields] EnterpriseUserEnrollmentCreated taggedCustomFields
      * @property {boolean|null} [isTextCoachingDisabled] EnterpriseUserEnrollmentCreated isTextCoachingDisabled
+     * @property {IUtmParams|null} [utmParams] EnterpriseUserEnrollmentCreated utmParams
      */
 
     /**
@@ -119243,6 +119476,14 @@ $root.EnterpriseUserEnrollmentCreated = (function() {
      */
     EnterpriseUserEnrollmentCreated.prototype.isTextCoachingDisabled = false;
 
+    /**
+     * EnterpriseUserEnrollmentCreated utmParams.
+     * @member {IUtmParams|null|undefined} utmParams
+     * @memberof EnterpriseUserEnrollmentCreated
+     * @instance
+     */
+    EnterpriseUserEnrollmentCreated.prototype.utmParams = null;
+
     /**
      * Creates a new EnterpriseUserEnrollmentCreated instance using the specified properties.
      * @function create
@@ -119380,6 +119621,8 @@ $root.EnterpriseUserEnrollmentCreated = (function() {
                 $root.TaggedCustomField.encode(message.taggedCustomFields[i], writer.uint32(/* id 60, wireType 2 =*/482).fork()).ldelim();
         if (message.isTextCoachingDisabled != null && message.hasOwnProperty("isTextCoachingDisabled"))
             writer.uint32(/* id 61, wireType 0 =*/488).bool(message.isTextCoachingDisabled);
+        if (message.utmParams != null && message.hasOwnProperty("utmParams"))
+            $root.UtmParams.encode(message.utmParams, writer.uint32(/* id 62, wireType 2 =*/498).fork()).ldelim();
         return writer;
     };
 
@@ -119584,6 +119827,9 @@ $root.EnterpriseUserEnrollmentCreated = (function() {
             case 61:
                 message.isTextCoachingDisabled = reader.bool();
                 break;
+            case 62:
+                message.utmParams = $root.UtmParams.decode(reader, reader.uint32());
+                break;
             default:
                 reader.skipType(tag & 7);
                 break;
@@ -119868,6 +120114,11 @@ $root.EnterpriseUserEnrollmentCreated = (function() {
         if (message.isTextCoachingDisabled != null && message.hasOwnProperty("isTextCoachingDisabled"))
             if (typeof message.isTextCoachingDisabled !== "boolean")
                 return "isTextCoachingDisabled: boolean expected";
+        if (message.utmParams != null && message.hasOwnProperty("utmParams")) {
+            var error = $root.UtmParams.verify(message.utmParams);
+            if (error)
+                return "utmParams." + error;
+        }
         return null;
     };
 
@@ -120218,6 +120469,11 @@ $root.EnterpriseUserEnrollmentCreated = (function() {
         }
         if (object.isTextCoachingDisabled != null)
             message.isTextCoachingDisabled = Boolean(object.isTextCoachingDisabled);
+        if (object.utmParams != null) {
+            if (typeof object.utmParams !== "object")
+                throw TypeError(".EnterpriseUserEnrollmentCreated.utmParams: object expected");
+            message.utmParams = $root.UtmParams.fromObject(object.utmParams);
+        }
         return message;
     };
 
@@ -120312,6 +120568,7 @@ $root.EnterpriseUserEnrollmentCreated = (function() {
             object.externalClientId = "";
             object.brandLogoUrl = "";
             object.isTextCoachingDisabled = false;
+            object.utmParams = null;
         }
         if (message.userId != null && message.hasOwnProperty("userId"))
             object.userId = message.userId;
@@ -120443,6 +120700,8 @@ $root.EnterpriseUserEnrollmentCreated = (function() {
         }
         if (message.isTextCoachingDisabled != null && message.hasOwnProperty("isTextCoachingDisabled"))
             object.isTextCoachingDisabled = message.isTextCoachingDisabled;
+        if (message.utmParams != null && message.hasOwnProperty("utmParams"))
+            object.utmParams = $root.UtmParams.toObject(message.utmParams, options);
         return object;
     };
 

package/package.json

@@ -16,5 +16,5 @@
   "main": "lib/index.js",
   "name": "@headspace/protos-events",
   "typings": "lib/index.d.ts",
-  "version": "1.782.0"
+  "version": "1.783.0"
 }