@headspace/protos-events 1.789.0 → 1.790.0

package/lib/index.d.ts

@@ -52061,6 +52061,120 @@ export class PartnerEventUpdated implements IPartnerEventUpdated {
     public toJSON(): { [k: string]: any };
 }
 
+/** Properties of a PartnerSignalStateAssigned. */
+export interface IPartnerSignalStateAssigned {
+
+    /** Unique identifier of the partner (from PAPI service). Formatted as a 24-char hex string. */
+    partnerId?: (string|null);
+
+    /** Name of the partner. */
+    partnerName?: (string|null);
+
+    /** Assigned signal. */
+    signal?: (string|null);
+
+    /** Headspace user that was assigned the signal (e.g. HSUSER_FOOBAR). */
+    hsUserId?: (string|null);
+
+    /** UTC epoch milliseconds - when the signal was assigned. */
+    createdAtTimestamp?: (number|Long|null);
+}
+
+/** Represents a PartnerSignalStateAssigned. */
+export class PartnerSignalStateAssigned implements IPartnerSignalStateAssigned {
+
+    /**
+     * Constructs a new PartnerSignalStateAssigned.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: IPartnerSignalStateAssigned);
+
+    /** Unique identifier of the partner (from PAPI service). Formatted as a 24-char hex string. */
+    public partnerId: string;
+
+    /** Name of the partner. */
+    public partnerName: string;
+
+    /** Assigned signal. */
+    public signal: string;
+
+    /** Headspace user that was assigned the signal (e.g. HSUSER_FOOBAR). */
+    public hsUserId: string;
+
+    /** UTC epoch milliseconds - when the signal was assigned. */
+    public createdAtTimestamp: (number|Long);
+
+    /**
+     * Creates a new PartnerSignalStateAssigned instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns PartnerSignalStateAssigned instance
+     */
+    public static create(properties?: IPartnerSignalStateAssigned): PartnerSignalStateAssigned;
+
+    /**
+     * Encodes the specified PartnerSignalStateAssigned message. Does not implicitly {@link PartnerSignalStateAssigned.verify|verify} messages.
+     * @param message PartnerSignalStateAssigned message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: IPartnerSignalStateAssigned, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified PartnerSignalStateAssigned message, length delimited. Does not implicitly {@link PartnerSignalStateAssigned.verify|verify} messages.
+     * @param message PartnerSignalStateAssigned message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: IPartnerSignalStateAssigned, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a PartnerSignalStateAssigned message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns PartnerSignalStateAssigned
+     * @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): PartnerSignalStateAssigned;
+
+    /**
+     * Decodes a PartnerSignalStateAssigned message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns PartnerSignalStateAssigned
+     * @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)): PartnerSignalStateAssigned;
+
+    /**
+     * Verifies a PartnerSignalStateAssigned 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 a PartnerSignalStateAssigned message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns PartnerSignalStateAssigned
+     */
+    public static fromObject(object: { [k: string]: any }): PartnerSignalStateAssigned;
+
+    /**
+     * Creates a plain object from a PartnerSignalStateAssigned message. Also converts values to other types if specified.
+     * @param message PartnerSignalStateAssigned
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: PartnerSignalStateAssigned, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this PartnerSignalStateAssigned to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
 /** Properties of a PHQAssessmentAssigned. */
 export interface IPHQAssessmentAssigned {
 

package/lib/index.js

@@ -148157,6 +148157,296 @@ $root.PartnerEventUpdated = (function() {
     return PartnerEventUpdated;
 })();
 
+$root.PartnerSignalStateAssigned = (function() {
+
+    /**
+     * Properties of a PartnerSignalStateAssigned.
+     * @name IPartnerSignalStateAssigned
+     * @interface IPartnerSignalStateAssigned
+     * @property {string|null} [partnerId] Unique identifier of the partner (from PAPI service). Formatted as a 24-char hex string.
+     * @property {string|null} [partnerName] Name of the partner.
+     * @property {string|null} [signal] Assigned signal.
+     * @property {string|null} [hsUserId] Headspace user that was assigned the signal (e.g. HSUSER_FOOBAR).
+     * @property {number|Long|null} [createdAtTimestamp] UTC epoch milliseconds - when the signal was assigned.
+     */
+
+    /**
+     * Constructs a new PartnerSignalStateAssigned.
+     * @name PartnerSignalStateAssigned
+     * @classdesc Represents a PartnerSignalStateAssigned.
+     * @implements IPartnerSignalStateAssigned
+     * @constructor
+     * @param {IPartnerSignalStateAssigned=} [properties] Properties to set
+     */
+    function PartnerSignalStateAssigned(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]];
+    }
+
+    /**
+     * Unique identifier of the partner (from PAPI service). Formatted as a 24-char hex string.
+     * @member {string} partnerId
+     * @memberof PartnerSignalStateAssigned
+     * @instance
+     */
+    PartnerSignalStateAssigned.prototype.partnerId = "";
+
+    /**
+     * Name of the partner.
+     * @member {string} partnerName
+     * @memberof PartnerSignalStateAssigned
+     * @instance
+     */
+    PartnerSignalStateAssigned.prototype.partnerName = "";
+
+    /**
+     * Assigned signal.
+     * @member {string} signal
+     * @memberof PartnerSignalStateAssigned
+     * @instance
+     */
+    PartnerSignalStateAssigned.prototype.signal = "";
+
+    /**
+     * Headspace user that was assigned the signal (e.g. HSUSER_FOOBAR).
+     * @member {string} hsUserId
+     * @memberof PartnerSignalStateAssigned
+     * @instance
+     */
+    PartnerSignalStateAssigned.prototype.hsUserId = "";
+
+    /**
+     * UTC epoch milliseconds - when the signal was assigned.
+     * @member {number|Long} createdAtTimestamp
+     * @memberof PartnerSignalStateAssigned
+     * @instance
+     */
+    PartnerSignalStateAssigned.prototype.createdAtTimestamp = $util.Long ? $util.Long.fromBits(0,0,true) : 0;
+
+    /**
+     * Creates a new PartnerSignalStateAssigned instance using the specified properties.
+     * @function create
+     * @memberof PartnerSignalStateAssigned
+     * @static
+     * @param {IPartnerSignalStateAssigned=} [properties] Properties to set
+     * @returns {PartnerSignalStateAssigned} PartnerSignalStateAssigned instance
+     */
+    PartnerSignalStateAssigned.create = function create(properties) {
+        return new PartnerSignalStateAssigned(properties);
+    };
+
+    /**
+     * Encodes the specified PartnerSignalStateAssigned message. Does not implicitly {@link PartnerSignalStateAssigned.verify|verify} messages.
+     * @function encode
+     * @memberof PartnerSignalStateAssigned
+     * @static
+     * @param {IPartnerSignalStateAssigned} message PartnerSignalStateAssigned message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    PartnerSignalStateAssigned.encode = function encode(message, writer) {
+        if (!writer)
+            writer = $Writer.create();
+        if (message.partnerId != null && message.hasOwnProperty("partnerId"))
+            writer.uint32(/* id 1, wireType 2 =*/10).string(message.partnerId);
+        if (message.partnerName != null && message.hasOwnProperty("partnerName"))
+            writer.uint32(/* id 2, wireType 2 =*/18).string(message.partnerName);
+        if (message.signal != null && message.hasOwnProperty("signal"))
+            writer.uint32(/* id 3, wireType 2 =*/26).string(message.signal);
+        if (message.hsUserId != null && message.hasOwnProperty("hsUserId"))
+            writer.uint32(/* id 4, wireType 2 =*/34).string(message.hsUserId);
+        if (message.createdAtTimestamp != null && message.hasOwnProperty("createdAtTimestamp"))
+            writer.uint32(/* id 5, wireType 0 =*/40).uint64(message.createdAtTimestamp);
+        return writer;
+    };
+
+    /**
+     * Encodes the specified PartnerSignalStateAssigned message, length delimited. Does not implicitly {@link PartnerSignalStateAssigned.verify|verify} messages.
+     * @function encodeDelimited
+     * @memberof PartnerSignalStateAssigned
+     * @static
+     * @param {IPartnerSignalStateAssigned} message PartnerSignalStateAssigned message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    PartnerSignalStateAssigned.encodeDelimited = function encodeDelimited(message, writer) {
+        return this.encode(message, writer).ldelim();
+    };
+
+    /**
+     * Decodes a PartnerSignalStateAssigned message from the specified reader or buffer.
+     * @function decode
+     * @memberof PartnerSignalStateAssigned
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @param {number} [length] Message length if known beforehand
+     * @returns {PartnerSignalStateAssigned} PartnerSignalStateAssigned
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    PartnerSignalStateAssigned.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.PartnerSignalStateAssigned();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+            case 1:
+                message.partnerId = reader.string();
+                break;
+            case 2:
+                message.partnerName = reader.string();
+                break;
+            case 3:
+                message.signal = reader.string();
+                break;
+            case 4:
+                message.hsUserId = reader.string();
+                break;
+            case 5:
+                message.createdAtTimestamp = reader.uint64();
+                break;
+            default:
+                reader.skipType(tag & 7);
+                break;
+            }
+        }
+        return message;
+    };
+
+    /**
+     * Decodes a PartnerSignalStateAssigned message from the specified reader or buffer, length delimited.
+     * @function decodeDelimited
+     * @memberof PartnerSignalStateAssigned
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @returns {PartnerSignalStateAssigned} PartnerSignalStateAssigned
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    PartnerSignalStateAssigned.decodeDelimited = function decodeDelimited(reader) {
+        if (!(reader instanceof $Reader))
+            reader = new $Reader(reader);
+        return this.decode(reader, reader.uint32());
+    };
+
+    /**
+     * Verifies a PartnerSignalStateAssigned message.
+     * @function verify
+     * @memberof PartnerSignalStateAssigned
+     * @static
+     * @param {Object.<string,*>} message Plain object to verify
+     * @returns {string|null} `null` if valid, otherwise the reason why it is not
+     */
+    PartnerSignalStateAssigned.verify = function verify(message) {
+        if (typeof message !== "object" || message === null)
+            return "object expected";
+        if (message.partnerId != null && message.hasOwnProperty("partnerId"))
+            if (!$util.isString(message.partnerId))
+                return "partnerId: string expected";
+        if (message.partnerName != null && message.hasOwnProperty("partnerName"))
+            if (!$util.isString(message.partnerName))
+                return "partnerName: string expected";
+        if (message.signal != null && message.hasOwnProperty("signal"))
+            if (!$util.isString(message.signal))
+                return "signal: string expected";
+        if (message.hsUserId != null && message.hasOwnProperty("hsUserId"))
+            if (!$util.isString(message.hsUserId))
+                return "hsUserId: string expected";
+        if (message.createdAtTimestamp != null && message.hasOwnProperty("createdAtTimestamp"))
+            if (!$util.isInteger(message.createdAtTimestamp) && !(message.createdAtTimestamp && $util.isInteger(message.createdAtTimestamp.low) && $util.isInteger(message.createdAtTimestamp.high)))
+                return "createdAtTimestamp: integer|Long expected";
+        return null;
+    };
+
+    /**
+     * Creates a PartnerSignalStateAssigned message from a plain object. Also converts values to their respective internal types.
+     * @function fromObject
+     * @memberof PartnerSignalStateAssigned
+     * @static
+     * @param {Object.<string,*>} object Plain object
+     * @returns {PartnerSignalStateAssigned} PartnerSignalStateAssigned
+     */
+    PartnerSignalStateAssigned.fromObject = function fromObject(object) {
+        if (object instanceof $root.PartnerSignalStateAssigned)
+            return object;
+        var message = new $root.PartnerSignalStateAssigned();
+        if (object.partnerId != null)
+            message.partnerId = String(object.partnerId);
+        if (object.partnerName != null)
+            message.partnerName = String(object.partnerName);
+        if (object.signal != null)
+            message.signal = String(object.signal);
+        if (object.hsUserId != null)
+            message.hsUserId = String(object.hsUserId);
+        if (object.createdAtTimestamp != null)
+            if ($util.Long)
+                (message.createdAtTimestamp = $util.Long.fromValue(object.createdAtTimestamp)).unsigned = true;
+            else if (typeof object.createdAtTimestamp === "string")
+                message.createdAtTimestamp = parseInt(object.createdAtTimestamp, 10);
+            else if (typeof object.createdAtTimestamp === "number")
+                message.createdAtTimestamp = object.createdAtTimestamp;
+            else if (typeof object.createdAtTimestamp === "object")
+                message.createdAtTimestamp = new $util.LongBits(object.createdAtTimestamp.low >>> 0, object.createdAtTimestamp.high >>> 0).toNumber(true);
+        return message;
+    };
+
+    /**
+     * Creates a plain object from a PartnerSignalStateAssigned message. Also converts values to other types if specified.
+     * @function toObject
+     * @memberof PartnerSignalStateAssigned
+     * @static
+     * @param {PartnerSignalStateAssigned} message PartnerSignalStateAssigned
+     * @param {$protobuf.IConversionOptions} [options] Conversion options
+     * @returns {Object.<string,*>} Plain object
+     */
+    PartnerSignalStateAssigned.toObject = function toObject(message, options) {
+        if (!options)
+            options = {};
+        var object = {};
+        if (options.defaults) {
+            object.partnerId = "";
+            object.partnerName = "";
+            object.signal = "";
+            object.hsUserId = "";
+            if ($util.Long) {
+                var long = new $util.Long(0, 0, true);
+                object.createdAtTimestamp = options.longs === String ? long.toString() : options.longs === Number ? long.toNumber() : long;
+            } else
+                object.createdAtTimestamp = options.longs === String ? "0" : 0;
+        }
+        if (message.partnerId != null && message.hasOwnProperty("partnerId"))
+            object.partnerId = message.partnerId;
+        if (message.partnerName != null && message.hasOwnProperty("partnerName"))
+            object.partnerName = message.partnerName;
+        if (message.signal != null && message.hasOwnProperty("signal"))
+            object.signal = message.signal;
+        if (message.hsUserId != null && message.hasOwnProperty("hsUserId"))
+            object.hsUserId = message.hsUserId;
+        if (message.createdAtTimestamp != null && message.hasOwnProperty("createdAtTimestamp"))
+            if (typeof message.createdAtTimestamp === "number")
+                object.createdAtTimestamp = options.longs === String ? String(message.createdAtTimestamp) : message.createdAtTimestamp;
+            else
+                object.createdAtTimestamp = options.longs === String ? $util.Long.prototype.toString.call(message.createdAtTimestamp) : options.longs === Number ? new $util.LongBits(message.createdAtTimestamp.low >>> 0, message.createdAtTimestamp.high >>> 0).toNumber(true) : message.createdAtTimestamp;
+        return object;
+    };
+
+    /**
+     * Converts this PartnerSignalStateAssigned to JSON.
+     * @function toJSON
+     * @memberof PartnerSignalStateAssigned
+     * @instance
+     * @returns {Object.<string,*>} JSON object
+     */
+    PartnerSignalStateAssigned.prototype.toJSON = function toJSON() {
+        return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
+    };
+
+    return PartnerSignalStateAssigned;
+})();
+
 $root.PHQAssessmentAssigned = (function() {
 
     /**

package/package.json

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