@headspace/protos-events 1.543.0 → 1.545.0

package/lib/index.d.ts

@@ -7653,9 +7653,10 @@ export namespace subscription {
 
     /** PlanAffiliation enum. */
     enum PlanAffiliation {
-        STUDENT = 0,
-        VETERAN = 1,
-        FAMILY = 2
+        PLAN_AFFILIATION_STUDENT = 0,
+        PLAN_AFFILIATION_VETERAN = 1,
+        PLAN_AFFILIATION_FAMILY = 2,
+        PLAN_AFFILIATION_UNKNOWN = 3
     }
 
     /** SubscriptionMembership enum. */
@@ -39033,6 +39034,136 @@ export class GingerDependentRolledOver implements IGingerDependentRolledOver {
     public toJSON(): { [k: string]: any };
 }
 
+/** Properties of a GingerMemberUpgraded. */
+export interface IGingerMemberUpgraded {
+
+    /** GingerMemberUpgraded headspaceHealthOrgId */
+    headspaceHealthOrgId?: (string|null);
+
+    /** GingerMemberUpgraded b2bOrgId */
+    b2bOrgId?: (string|null);
+
+    /** GingerMemberUpgraded gingerOrgId */
+    gingerOrgId?: (string|null);
+
+    /** GingerMemberUpgraded workEmail */
+    workEmail?: (string|null);
+
+    /** GingerMemberUpgraded workId */
+    workId?: (string|null);
+
+    /** GingerMemberUpgraded accountEmail */
+    accountEmail?: (string|null);
+
+    /** GingerMemberUpgraded headspaceUserId */
+    headspaceUserId?: (string|null);
+}
+
+/**
+ * Indicates a Ginger-only member has been upgraded to have access to Headspace content (in addition to Care).
+ * Published for all enrolled organization members when the org's upgraded subscription is activated on
+ * the subscription's start date.
+ */
+export class GingerMemberUpgraded implements IGingerMemberUpgraded {
+
+    /**
+     * Constructs a new GingerMemberUpgraded.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: IGingerMemberUpgraded);
+
+    /** GingerMemberUpgraded headspaceHealthOrgId. */
+    public headspaceHealthOrgId: string;
+
+    /** GingerMemberUpgraded b2bOrgId. */
+    public b2bOrgId: string;
+
+    /** GingerMemberUpgraded gingerOrgId. */
+    public gingerOrgId: string;
+
+    /** GingerMemberUpgraded workEmail. */
+    public workEmail: string;
+
+    /** GingerMemberUpgraded workId. */
+    public workId: string;
+
+    /** GingerMemberUpgraded accountEmail. */
+    public accountEmail: string;
+
+    /** GingerMemberUpgraded headspaceUserId. */
+    public headspaceUserId: string;
+
+    /**
+     * Creates a new GingerMemberUpgraded instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns GingerMemberUpgraded instance
+     */
+    public static create(properties?: IGingerMemberUpgraded): GingerMemberUpgraded;
+
+    /**
+     * Encodes the specified GingerMemberUpgraded message. Does not implicitly {@link GingerMemberUpgraded.verify|verify} messages.
+     * @param message GingerMemberUpgraded message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: IGingerMemberUpgraded, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified GingerMemberUpgraded message, length delimited. Does not implicitly {@link GingerMemberUpgraded.verify|verify} messages.
+     * @param message GingerMemberUpgraded message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: IGingerMemberUpgraded, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a GingerMemberUpgraded message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns GingerMemberUpgraded
+     * @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): GingerMemberUpgraded;
+
+    /**
+     * Decodes a GingerMemberUpgraded message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns GingerMemberUpgraded
+     * @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)): GingerMemberUpgraded;
+
+    /**
+     * Verifies a GingerMemberUpgraded 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 GingerMemberUpgraded message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns GingerMemberUpgraded
+     */
+    public static fromObject(object: { [k: string]: any }): GingerMemberUpgraded;
+
+    /**
+     * Creates a plain object from a GingerMemberUpgraded message. Also converts values to other types if specified.
+     * @param message GingerMemberUpgraded
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: GingerMemberUpgraded, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this GingerMemberUpgraded to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
 /** Properties of a GoalSet. */
 export interface IGoalSet {
 

package/lib/index.js

@@ -18176,15 +18176,17 @@ $root.subscription = (function() {
      * PlanAffiliation enum.
      * @name subscription.PlanAffiliation
      * @enum {string}
-     * @property {number} STUDENT=0 STUDENT value
-     * @property {number} VETERAN=1 VETERAN value
-     * @property {number} FAMILY=2 FAMILY value
+     * @property {number} PLAN_AFFILIATION_STUDENT=0 PLAN_AFFILIATION_STUDENT value
+     * @property {number} PLAN_AFFILIATION_VETERAN=1 PLAN_AFFILIATION_VETERAN value
+     * @property {number} PLAN_AFFILIATION_FAMILY=2 PLAN_AFFILIATION_FAMILY value
+     * @property {number} PLAN_AFFILIATION_UNKNOWN=3 PLAN_AFFILIATION_UNKNOWN value
      */
     subscription.PlanAffiliation = (function() {
         var valuesById = {}, values = Object.create(valuesById);
-        values[valuesById[0] = "STUDENT"] = 0;
-        values[valuesById[1] = "VETERAN"] = 1;
-        values[valuesById[2] = "FAMILY"] = 2;
+        values[valuesById[0] = "PLAN_AFFILIATION_STUDENT"] = 0;
+        values[valuesById[1] = "PLAN_AFFILIATION_VETERAN"] = 1;
+        values[valuesById[2] = "PLAN_AFFILIATION_FAMILY"] = 2;
+        values[valuesById[3] = "PLAN_AFFILIATION_UNKNOWN"] = 3;
         return values;
     })();
 
@@ -110091,6 +110093,328 @@ $root.GingerDependentRolledOver = (function() {
     return GingerDependentRolledOver;
 })();
 
+$root.GingerMemberUpgraded = (function() {
+
+    /**
+     * Properties of a GingerMemberUpgraded.
+     * @name IGingerMemberUpgraded
+     * @interface IGingerMemberUpgraded
+     * @property {string|null} [headspaceHealthOrgId] GingerMemberUpgraded headspaceHealthOrgId
+     * @property {string|null} [b2bOrgId] GingerMemberUpgraded b2bOrgId
+     * @property {string|null} [gingerOrgId] GingerMemberUpgraded gingerOrgId
+     * @property {string|null} [workEmail] GingerMemberUpgraded workEmail
+     * @property {string|null} [workId] GingerMemberUpgraded workId
+     * @property {string|null} [accountEmail] GingerMemberUpgraded accountEmail
+     * @property {string|null} [headspaceUserId] GingerMemberUpgraded headspaceUserId
+     */
+
+    /**
+     * Constructs a new GingerMemberUpgraded.
+     * @name GingerMemberUpgraded
+     * @classdesc Indicates a Ginger-only member has been upgraded to have access to Headspace content (in addition to Care).
+     * Published for all enrolled organization members when the org's upgraded subscription is activated on
+     * the subscription's start date.
+     * @implements IGingerMemberUpgraded
+     * @constructor
+     * @param {IGingerMemberUpgraded=} [properties] Properties to set
+     */
+    function GingerMemberUpgraded(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]];
+    }
+
+    /**
+     * GingerMemberUpgraded headspaceHealthOrgId.
+     * @member {string} headspaceHealthOrgId
+     * @memberof GingerMemberUpgraded
+     * @instance
+     */
+    GingerMemberUpgraded.prototype.headspaceHealthOrgId = "";
+
+    /**
+     * GingerMemberUpgraded b2bOrgId.
+     * @member {string} b2bOrgId
+     * @memberof GingerMemberUpgraded
+     * @instance
+     */
+    GingerMemberUpgraded.prototype.b2bOrgId = "";
+
+    /**
+     * GingerMemberUpgraded gingerOrgId.
+     * @member {string} gingerOrgId
+     * @memberof GingerMemberUpgraded
+     * @instance
+     */
+    GingerMemberUpgraded.prototype.gingerOrgId = "";
+
+    /**
+     * GingerMemberUpgraded workEmail.
+     * @member {string} workEmail
+     * @memberof GingerMemberUpgraded
+     * @instance
+     */
+    GingerMemberUpgraded.prototype.workEmail = "";
+
+    /**
+     * GingerMemberUpgraded workId.
+     * @member {string} workId
+     * @memberof GingerMemberUpgraded
+     * @instance
+     */
+    GingerMemberUpgraded.prototype.workId = "";
+
+    /**
+     * GingerMemberUpgraded accountEmail.
+     * @member {string} accountEmail
+     * @memberof GingerMemberUpgraded
+     * @instance
+     */
+    GingerMemberUpgraded.prototype.accountEmail = "";
+
+    /**
+     * GingerMemberUpgraded headspaceUserId.
+     * @member {string} headspaceUserId
+     * @memberof GingerMemberUpgraded
+     * @instance
+     */
+    GingerMemberUpgraded.prototype.headspaceUserId = "";
+
+    /**
+     * Creates a new GingerMemberUpgraded instance using the specified properties.
+     * @function create
+     * @memberof GingerMemberUpgraded
+     * @static
+     * @param {IGingerMemberUpgraded=} [properties] Properties to set
+     * @returns {GingerMemberUpgraded} GingerMemberUpgraded instance
+     */
+    GingerMemberUpgraded.create = function create(properties) {
+        return new GingerMemberUpgraded(properties);
+    };
+
+    /**
+     * Encodes the specified GingerMemberUpgraded message. Does not implicitly {@link GingerMemberUpgraded.verify|verify} messages.
+     * @function encode
+     * @memberof GingerMemberUpgraded
+     * @static
+     * @param {IGingerMemberUpgraded} message GingerMemberUpgraded message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    GingerMemberUpgraded.encode = function encode(message, writer) {
+        if (!writer)
+            writer = $Writer.create();
+        if (message.headspaceHealthOrgId != null && message.hasOwnProperty("headspaceHealthOrgId"))
+            writer.uint32(/* id 1, wireType 2 =*/10).string(message.headspaceHealthOrgId);
+        if (message.b2bOrgId != null && message.hasOwnProperty("b2bOrgId"))
+            writer.uint32(/* id 2, wireType 2 =*/18).string(message.b2bOrgId);
+        if (message.gingerOrgId != null && message.hasOwnProperty("gingerOrgId"))
+            writer.uint32(/* id 3, wireType 2 =*/26).string(message.gingerOrgId);
+        if (message.workEmail != null && message.hasOwnProperty("workEmail"))
+            writer.uint32(/* id 4, wireType 2 =*/34).string(message.workEmail);
+        if (message.workId != null && message.hasOwnProperty("workId"))
+            writer.uint32(/* id 5, wireType 2 =*/42).string(message.workId);
+        if (message.accountEmail != null && message.hasOwnProperty("accountEmail"))
+            writer.uint32(/* id 6, wireType 2 =*/50).string(message.accountEmail);
+        if (message.headspaceUserId != null && message.hasOwnProperty("headspaceUserId"))
+            writer.uint32(/* id 7, wireType 2 =*/58).string(message.headspaceUserId);
+        return writer;
+    };
+
+    /**
+     * Encodes the specified GingerMemberUpgraded message, length delimited. Does not implicitly {@link GingerMemberUpgraded.verify|verify} messages.
+     * @function encodeDelimited
+     * @memberof GingerMemberUpgraded
+     * @static
+     * @param {IGingerMemberUpgraded} message GingerMemberUpgraded message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    GingerMemberUpgraded.encodeDelimited = function encodeDelimited(message, writer) {
+        return this.encode(message, writer).ldelim();
+    };
+
+    /**
+     * Decodes a GingerMemberUpgraded message from the specified reader or buffer.
+     * @function decode
+     * @memberof GingerMemberUpgraded
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @param {number} [length] Message length if known beforehand
+     * @returns {GingerMemberUpgraded} GingerMemberUpgraded
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    GingerMemberUpgraded.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.GingerMemberUpgraded();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+            case 1:
+                message.headspaceHealthOrgId = reader.string();
+                break;
+            case 2:
+                message.b2bOrgId = reader.string();
+                break;
+            case 3:
+                message.gingerOrgId = reader.string();
+                break;
+            case 4:
+                message.workEmail = reader.string();
+                break;
+            case 5:
+                message.workId = reader.string();
+                break;
+            case 6:
+                message.accountEmail = reader.string();
+                break;
+            case 7:
+                message.headspaceUserId = reader.string();
+                break;
+            default:
+                reader.skipType(tag & 7);
+                break;
+            }
+        }
+        return message;
+    };
+
+    /**
+     * Decodes a GingerMemberUpgraded message from the specified reader or buffer, length delimited.
+     * @function decodeDelimited
+     * @memberof GingerMemberUpgraded
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @returns {GingerMemberUpgraded} GingerMemberUpgraded
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    GingerMemberUpgraded.decodeDelimited = function decodeDelimited(reader) {
+        if (!(reader instanceof $Reader))
+            reader = new $Reader(reader);
+        return this.decode(reader, reader.uint32());
+    };
+
+    /**
+     * Verifies a GingerMemberUpgraded message.
+     * @function verify
+     * @memberof GingerMemberUpgraded
+     * @static
+     * @param {Object.<string,*>} message Plain object to verify
+     * @returns {string|null} `null` if valid, otherwise the reason why it is not
+     */
+    GingerMemberUpgraded.verify = function verify(message) {
+        if (typeof message !== "object" || message === null)
+            return "object expected";
+        if (message.headspaceHealthOrgId != null && message.hasOwnProperty("headspaceHealthOrgId"))
+            if (!$util.isString(message.headspaceHealthOrgId))
+                return "headspaceHealthOrgId: string expected";
+        if (message.b2bOrgId != null && message.hasOwnProperty("b2bOrgId"))
+            if (!$util.isString(message.b2bOrgId))
+                return "b2bOrgId: string expected";
+        if (message.gingerOrgId != null && message.hasOwnProperty("gingerOrgId"))
+            if (!$util.isString(message.gingerOrgId))
+                return "gingerOrgId: string expected";
+        if (message.workEmail != null && message.hasOwnProperty("workEmail"))
+            if (!$util.isString(message.workEmail))
+                return "workEmail: string expected";
+        if (message.workId != null && message.hasOwnProperty("workId"))
+            if (!$util.isString(message.workId))
+                return "workId: string expected";
+        if (message.accountEmail != null && message.hasOwnProperty("accountEmail"))
+            if (!$util.isString(message.accountEmail))
+                return "accountEmail: string expected";
+        if (message.headspaceUserId != null && message.hasOwnProperty("headspaceUserId"))
+            if (!$util.isString(message.headspaceUserId))
+                return "headspaceUserId: string expected";
+        return null;
+    };
+
+    /**
+     * Creates a GingerMemberUpgraded message from a plain object. Also converts values to their respective internal types.
+     * @function fromObject
+     * @memberof GingerMemberUpgraded
+     * @static
+     * @param {Object.<string,*>} object Plain object
+     * @returns {GingerMemberUpgraded} GingerMemberUpgraded
+     */
+    GingerMemberUpgraded.fromObject = function fromObject(object) {
+        if (object instanceof $root.GingerMemberUpgraded)
+            return object;
+        var message = new $root.GingerMemberUpgraded();
+        if (object.headspaceHealthOrgId != null)
+            message.headspaceHealthOrgId = String(object.headspaceHealthOrgId);
+        if (object.b2bOrgId != null)
+            message.b2bOrgId = String(object.b2bOrgId);
+        if (object.gingerOrgId != null)
+            message.gingerOrgId = String(object.gingerOrgId);
+        if (object.workEmail != null)
+            message.workEmail = String(object.workEmail);
+        if (object.workId != null)
+            message.workId = String(object.workId);
+        if (object.accountEmail != null)
+            message.accountEmail = String(object.accountEmail);
+        if (object.headspaceUserId != null)
+            message.headspaceUserId = String(object.headspaceUserId);
+        return message;
+    };
+
+    /**
+     * Creates a plain object from a GingerMemberUpgraded message. Also converts values to other types if specified.
+     * @function toObject
+     * @memberof GingerMemberUpgraded
+     * @static
+     * @param {GingerMemberUpgraded} message GingerMemberUpgraded
+     * @param {$protobuf.IConversionOptions} [options] Conversion options
+     * @returns {Object.<string,*>} Plain object
+     */
+    GingerMemberUpgraded.toObject = function toObject(message, options) {
+        if (!options)
+            options = {};
+        var object = {};
+        if (options.defaults) {
+            object.headspaceHealthOrgId = "";
+            object.b2bOrgId = "";
+            object.gingerOrgId = "";
+            object.workEmail = "";
+            object.workId = "";
+            object.accountEmail = "";
+            object.headspaceUserId = "";
+        }
+        if (message.headspaceHealthOrgId != null && message.hasOwnProperty("headspaceHealthOrgId"))
+            object.headspaceHealthOrgId = message.headspaceHealthOrgId;
+        if (message.b2bOrgId != null && message.hasOwnProperty("b2bOrgId"))
+            object.b2bOrgId = message.b2bOrgId;
+        if (message.gingerOrgId != null && message.hasOwnProperty("gingerOrgId"))
+            object.gingerOrgId = message.gingerOrgId;
+        if (message.workEmail != null && message.hasOwnProperty("workEmail"))
+            object.workEmail = message.workEmail;
+        if (message.workId != null && message.hasOwnProperty("workId"))
+            object.workId = message.workId;
+        if (message.accountEmail != null && message.hasOwnProperty("accountEmail"))
+            object.accountEmail = message.accountEmail;
+        if (message.headspaceUserId != null && message.hasOwnProperty("headspaceUserId"))
+            object.headspaceUserId = message.headspaceUserId;
+        return object;
+    };
+
+    /**
+     * Converts this GingerMemberUpgraded to JSON.
+     * @function toJSON
+     * @memberof GingerMemberUpgraded
+     * @instance
+     * @returns {Object.<string,*>} JSON object
+     */
+    GingerMemberUpgraded.prototype.toJSON = function toJSON() {
+        return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
+    };
+
+    return GingerMemberUpgraded;
+})();
+
 $root.GoalSet = (function() {
 
     /**
@@ -132483,6 +132807,7 @@ $root.SubscriptionUpcomingRenewal = (function() {
             case 0:
             case 1:
             case 2:
+            case 3:
                 break;
             }
         if (message.renewalDate != null && message.hasOwnProperty("renewalDate"))
@@ -132531,18 +132856,22 @@ $root.SubscriptionUpcomingRenewal = (function() {
             break;
         }
         switch (object.planAffiliation) {
-        case "STUDENT":
+        case "PLAN_AFFILIATION_STUDENT":
         case 0:
             message.planAffiliation = 0;
             break;
-        case "VETERAN":
+        case "PLAN_AFFILIATION_VETERAN":
         case 1:
             message.planAffiliation = 1;
             break;
-        case "FAMILY":
+        case "PLAN_AFFILIATION_FAMILY":
         case 2:
             message.planAffiliation = 2;
             break;
+        case "PLAN_AFFILIATION_UNKNOWN":
+        case 3:
+            message.planAffiliation = 3;
+            break;
         }
         if (object.renewalDate != null)
             if ($util.Long)
@@ -132583,7 +132912,7 @@ $root.SubscriptionUpcomingRenewal = (function() {
             object.userId = "";
             object.daysBefore = 0;
             object.membership = options.enums === String ? "PRIMARY" : 0;
-            object.planAffiliation = options.enums === String ? "STUDENT" : 0;
+            object.planAffiliation = options.enums === String ? "PLAN_AFFILIATION_STUDENT" : 0;
             if ($util.Long) {
                 var long = new $util.Long(0, 0, true);
                 object.renewalDate = options.longs === String ? long.toString() : options.longs === Number ? long.toNumber() : long;

package/package.json

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