@headspace/protos-events 1.541.0 → 1.542.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -38897,6 +38897,124 @@ export class GiftRedemptionCodeGenerated implements IGiftRedemptionCodeGenerated
38897
38897
  public toJSON(): { [k: string]: any };
38898
38898
  }
38899
38899
 
38900
+ /** Properties of a GingerDependentRolledOver. */
38901
+ export interface IGingerDependentRolledOver {
38902
+
38903
+ /** The organization's UUID v4, which is shared between b2b and ginger systems */
38904
+ orgHeadspaceHealthId?: (string|null);
38905
+
38906
+ /** The organization's ID in the b2b system */
38907
+ orgB2bId?: (number|null);
38908
+
38909
+ /** The organization's ID in the ginger system */
38910
+ orgGingerId?: (number|null);
38911
+
38912
+ /** The primary member's HSUSER_* ID */
38913
+ primaryHsUserId?: (string|null);
38914
+
38915
+ /** The dependent's HSUSER_* ID */
38916
+ dependentHsUserId?: (string|null);
38917
+ }
38918
+
38919
+ /**
38920
+ * When an organization upgrades from Ginger to Fusion (meaning, when the Fusion contract gets activated on its start
38921
+ * date), an async job will be running to update the organization’s records and backfill the enrolled members
38922
+ * to Headspace. The same job will iterate through every record’s active dependents and send the event
38923
+ */
38924
+ export class GingerDependentRolledOver implements IGingerDependentRolledOver {
38925
+
38926
+ /**
38927
+ * Constructs a new GingerDependentRolledOver.
38928
+ * @param [properties] Properties to set
38929
+ */
38930
+ constructor(properties?: IGingerDependentRolledOver);
38931
+
38932
+ /** The organization's UUID v4, which is shared between b2b and ginger systems */
38933
+ public orgHeadspaceHealthId: string;
38934
+
38935
+ /** The organization's ID in the b2b system */
38936
+ public orgB2bId: number;
38937
+
38938
+ /** The organization's ID in the ginger system */
38939
+ public orgGingerId: number;
38940
+
38941
+ /** The primary member's HSUSER_* ID */
38942
+ public primaryHsUserId: string;
38943
+
38944
+ /** The dependent's HSUSER_* ID */
38945
+ public dependentHsUserId: string;
38946
+
38947
+ /**
38948
+ * Creates a new GingerDependentRolledOver instance using the specified properties.
38949
+ * @param [properties] Properties to set
38950
+ * @returns GingerDependentRolledOver instance
38951
+ */
38952
+ public static create(properties?: IGingerDependentRolledOver): GingerDependentRolledOver;
38953
+
38954
+ /**
38955
+ * Encodes the specified GingerDependentRolledOver message. Does not implicitly {@link GingerDependentRolledOver.verify|verify} messages.
38956
+ * @param message GingerDependentRolledOver message or plain object to encode
38957
+ * @param [writer] Writer to encode to
38958
+ * @returns Writer
38959
+ */
38960
+ public static encode(message: IGingerDependentRolledOver, writer?: $protobuf.Writer): $protobuf.Writer;
38961
+
38962
+ /**
38963
+ * Encodes the specified GingerDependentRolledOver message, length delimited. Does not implicitly {@link GingerDependentRolledOver.verify|verify} messages.
38964
+ * @param message GingerDependentRolledOver message or plain object to encode
38965
+ * @param [writer] Writer to encode to
38966
+ * @returns Writer
38967
+ */
38968
+ public static encodeDelimited(message: IGingerDependentRolledOver, writer?: $protobuf.Writer): $protobuf.Writer;
38969
+
38970
+ /**
38971
+ * Decodes a GingerDependentRolledOver message from the specified reader or buffer.
38972
+ * @param reader Reader or buffer to decode from
38973
+ * @param [length] Message length if known beforehand
38974
+ * @returns GingerDependentRolledOver
38975
+ * @throws {Error} If the payload is not a reader or valid buffer
38976
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
38977
+ */
38978
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): GingerDependentRolledOver;
38979
+
38980
+ /**
38981
+ * Decodes a GingerDependentRolledOver message from the specified reader or buffer, length delimited.
38982
+ * @param reader Reader or buffer to decode from
38983
+ * @returns GingerDependentRolledOver
38984
+ * @throws {Error} If the payload is not a reader or valid buffer
38985
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
38986
+ */
38987
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): GingerDependentRolledOver;
38988
+
38989
+ /**
38990
+ * Verifies a GingerDependentRolledOver message.
38991
+ * @param message Plain object to verify
38992
+ * @returns `null` if valid, otherwise the reason why it is not
38993
+ */
38994
+ public static verify(message: { [k: string]: any }): (string|null);
38995
+
38996
+ /**
38997
+ * Creates a GingerDependentRolledOver message from a plain object. Also converts values to their respective internal types.
38998
+ * @param object Plain object
38999
+ * @returns GingerDependentRolledOver
39000
+ */
39001
+ public static fromObject(object: { [k: string]: any }): GingerDependentRolledOver;
39002
+
39003
+ /**
39004
+ * Creates a plain object from a GingerDependentRolledOver message. Also converts values to other types if specified.
39005
+ * @param message GingerDependentRolledOver
39006
+ * @param [options] Conversion options
39007
+ * @returns Plain object
39008
+ */
39009
+ public static toObject(message: GingerDependentRolledOver, options?: $protobuf.IConversionOptions): { [k: string]: any };
39010
+
39011
+ /**
39012
+ * Converts this GingerDependentRolledOver to JSON.
39013
+ * @returns JSON object
39014
+ */
39015
+ public toJSON(): { [k: string]: any };
39016
+ }
39017
+
38900
39018
  /** Properties of a GoalSet. */
38901
39019
  export interface IGoalSet {
38902
39020
 
package/lib/index.js CHANGED
@@ -109693,6 +109693,284 @@ $root.GiftRedemptionCodeGenerated = (function() {
109693
109693
  return GiftRedemptionCodeGenerated;
109694
109694
  })();
109695
109695
 
109696
+ $root.GingerDependentRolledOver = (function() {
109697
+
109698
+ /**
109699
+ * Properties of a GingerDependentRolledOver.
109700
+ * @name IGingerDependentRolledOver
109701
+ * @interface IGingerDependentRolledOver
109702
+ * @property {string|null} [orgHeadspaceHealthId] The organization's UUID v4, which is shared between b2b and ginger systems
109703
+ * @property {number|null} [orgB2bId] The organization's ID in the b2b system
109704
+ * @property {number|null} [orgGingerId] The organization's ID in the ginger system
109705
+ * @property {string|null} [primaryHsUserId] The primary member's HSUSER_* ID
109706
+ * @property {string|null} [dependentHsUserId] The dependent's HSUSER_* ID
109707
+ */
109708
+
109709
+ /**
109710
+ * Constructs a new GingerDependentRolledOver.
109711
+ * @name GingerDependentRolledOver
109712
+ * @classdesc When an organization upgrades from Ginger to Fusion (meaning, when the Fusion contract gets activated on its start
109713
+ * date), an async job will be running to update the organization’s records and backfill the enrolled members
109714
+ * to Headspace. The same job will iterate through every record’s active dependents and send the event
109715
+ * @implements IGingerDependentRolledOver
109716
+ * @constructor
109717
+ * @param {IGingerDependentRolledOver=} [properties] Properties to set
109718
+ */
109719
+ function GingerDependentRolledOver(properties) {
109720
+ if (properties)
109721
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
109722
+ if (properties[keys[i]] != null)
109723
+ this[keys[i]] = properties[keys[i]];
109724
+ }
109725
+
109726
+ /**
109727
+ * The organization's UUID v4, which is shared between b2b and ginger systems
109728
+ * @member {string} orgHeadspaceHealthId
109729
+ * @memberof GingerDependentRolledOver
109730
+ * @instance
109731
+ */
109732
+ GingerDependentRolledOver.prototype.orgHeadspaceHealthId = "";
109733
+
109734
+ /**
109735
+ * The organization's ID in the b2b system
109736
+ * @member {number} orgB2bId
109737
+ * @memberof GingerDependentRolledOver
109738
+ * @instance
109739
+ */
109740
+ GingerDependentRolledOver.prototype.orgB2bId = 0;
109741
+
109742
+ /**
109743
+ * The organization's ID in the ginger system
109744
+ * @member {number} orgGingerId
109745
+ * @memberof GingerDependentRolledOver
109746
+ * @instance
109747
+ */
109748
+ GingerDependentRolledOver.prototype.orgGingerId = 0;
109749
+
109750
+ /**
109751
+ * The primary member's HSUSER_* ID
109752
+ * @member {string} primaryHsUserId
109753
+ * @memberof GingerDependentRolledOver
109754
+ * @instance
109755
+ */
109756
+ GingerDependentRolledOver.prototype.primaryHsUserId = "";
109757
+
109758
+ /**
109759
+ * The dependent's HSUSER_* ID
109760
+ * @member {string} dependentHsUserId
109761
+ * @memberof GingerDependentRolledOver
109762
+ * @instance
109763
+ */
109764
+ GingerDependentRolledOver.prototype.dependentHsUserId = "";
109765
+
109766
+ /**
109767
+ * Creates a new GingerDependentRolledOver instance using the specified properties.
109768
+ * @function create
109769
+ * @memberof GingerDependentRolledOver
109770
+ * @static
109771
+ * @param {IGingerDependentRolledOver=} [properties] Properties to set
109772
+ * @returns {GingerDependentRolledOver} GingerDependentRolledOver instance
109773
+ */
109774
+ GingerDependentRolledOver.create = function create(properties) {
109775
+ return new GingerDependentRolledOver(properties);
109776
+ };
109777
+
109778
+ /**
109779
+ * Encodes the specified GingerDependentRolledOver message. Does not implicitly {@link GingerDependentRolledOver.verify|verify} messages.
109780
+ * @function encode
109781
+ * @memberof GingerDependentRolledOver
109782
+ * @static
109783
+ * @param {IGingerDependentRolledOver} message GingerDependentRolledOver message or plain object to encode
109784
+ * @param {$protobuf.Writer} [writer] Writer to encode to
109785
+ * @returns {$protobuf.Writer} Writer
109786
+ */
109787
+ GingerDependentRolledOver.encode = function encode(message, writer) {
109788
+ if (!writer)
109789
+ writer = $Writer.create();
109790
+ if (message.orgHeadspaceHealthId != null && message.hasOwnProperty("orgHeadspaceHealthId"))
109791
+ writer.uint32(/* id 1, wireType 2 =*/10).string(message.orgHeadspaceHealthId);
109792
+ if (message.orgB2bId != null && message.hasOwnProperty("orgB2bId"))
109793
+ writer.uint32(/* id 2, wireType 0 =*/16).uint32(message.orgB2bId);
109794
+ if (message.orgGingerId != null && message.hasOwnProperty("orgGingerId"))
109795
+ writer.uint32(/* id 3, wireType 0 =*/24).uint32(message.orgGingerId);
109796
+ if (message.primaryHsUserId != null && message.hasOwnProperty("primaryHsUserId"))
109797
+ writer.uint32(/* id 4, wireType 2 =*/34).string(message.primaryHsUserId);
109798
+ if (message.dependentHsUserId != null && message.hasOwnProperty("dependentHsUserId"))
109799
+ writer.uint32(/* id 5, wireType 2 =*/42).string(message.dependentHsUserId);
109800
+ return writer;
109801
+ };
109802
+
109803
+ /**
109804
+ * Encodes the specified GingerDependentRolledOver message, length delimited. Does not implicitly {@link GingerDependentRolledOver.verify|verify} messages.
109805
+ * @function encodeDelimited
109806
+ * @memberof GingerDependentRolledOver
109807
+ * @static
109808
+ * @param {IGingerDependentRolledOver} message GingerDependentRolledOver message or plain object to encode
109809
+ * @param {$protobuf.Writer} [writer] Writer to encode to
109810
+ * @returns {$protobuf.Writer} Writer
109811
+ */
109812
+ GingerDependentRolledOver.encodeDelimited = function encodeDelimited(message, writer) {
109813
+ return this.encode(message, writer).ldelim();
109814
+ };
109815
+
109816
+ /**
109817
+ * Decodes a GingerDependentRolledOver message from the specified reader or buffer.
109818
+ * @function decode
109819
+ * @memberof GingerDependentRolledOver
109820
+ * @static
109821
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
109822
+ * @param {number} [length] Message length if known beforehand
109823
+ * @returns {GingerDependentRolledOver} GingerDependentRolledOver
109824
+ * @throws {Error} If the payload is not a reader or valid buffer
109825
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
109826
+ */
109827
+ GingerDependentRolledOver.decode = function decode(reader, length) {
109828
+ if (!(reader instanceof $Reader))
109829
+ reader = $Reader.create(reader);
109830
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.GingerDependentRolledOver();
109831
+ while (reader.pos < end) {
109832
+ var tag = reader.uint32();
109833
+ switch (tag >>> 3) {
109834
+ case 1:
109835
+ message.orgHeadspaceHealthId = reader.string();
109836
+ break;
109837
+ case 2:
109838
+ message.orgB2bId = reader.uint32();
109839
+ break;
109840
+ case 3:
109841
+ message.orgGingerId = reader.uint32();
109842
+ break;
109843
+ case 4:
109844
+ message.primaryHsUserId = reader.string();
109845
+ break;
109846
+ case 5:
109847
+ message.dependentHsUserId = reader.string();
109848
+ break;
109849
+ default:
109850
+ reader.skipType(tag & 7);
109851
+ break;
109852
+ }
109853
+ }
109854
+ return message;
109855
+ };
109856
+
109857
+ /**
109858
+ * Decodes a GingerDependentRolledOver message from the specified reader or buffer, length delimited.
109859
+ * @function decodeDelimited
109860
+ * @memberof GingerDependentRolledOver
109861
+ * @static
109862
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
109863
+ * @returns {GingerDependentRolledOver} GingerDependentRolledOver
109864
+ * @throws {Error} If the payload is not a reader or valid buffer
109865
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
109866
+ */
109867
+ GingerDependentRolledOver.decodeDelimited = function decodeDelimited(reader) {
109868
+ if (!(reader instanceof $Reader))
109869
+ reader = new $Reader(reader);
109870
+ return this.decode(reader, reader.uint32());
109871
+ };
109872
+
109873
+ /**
109874
+ * Verifies a GingerDependentRolledOver message.
109875
+ * @function verify
109876
+ * @memberof GingerDependentRolledOver
109877
+ * @static
109878
+ * @param {Object.<string,*>} message Plain object to verify
109879
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
109880
+ */
109881
+ GingerDependentRolledOver.verify = function verify(message) {
109882
+ if (typeof message !== "object" || message === null)
109883
+ return "object expected";
109884
+ if (message.orgHeadspaceHealthId != null && message.hasOwnProperty("orgHeadspaceHealthId"))
109885
+ if (!$util.isString(message.orgHeadspaceHealthId))
109886
+ return "orgHeadspaceHealthId: string expected";
109887
+ if (message.orgB2bId != null && message.hasOwnProperty("orgB2bId"))
109888
+ if (!$util.isInteger(message.orgB2bId))
109889
+ return "orgB2bId: integer expected";
109890
+ if (message.orgGingerId != null && message.hasOwnProperty("orgGingerId"))
109891
+ if (!$util.isInteger(message.orgGingerId))
109892
+ return "orgGingerId: integer expected";
109893
+ if (message.primaryHsUserId != null && message.hasOwnProperty("primaryHsUserId"))
109894
+ if (!$util.isString(message.primaryHsUserId))
109895
+ return "primaryHsUserId: string expected";
109896
+ if (message.dependentHsUserId != null && message.hasOwnProperty("dependentHsUserId"))
109897
+ if (!$util.isString(message.dependentHsUserId))
109898
+ return "dependentHsUserId: string expected";
109899
+ return null;
109900
+ };
109901
+
109902
+ /**
109903
+ * Creates a GingerDependentRolledOver message from a plain object. Also converts values to their respective internal types.
109904
+ * @function fromObject
109905
+ * @memberof GingerDependentRolledOver
109906
+ * @static
109907
+ * @param {Object.<string,*>} object Plain object
109908
+ * @returns {GingerDependentRolledOver} GingerDependentRolledOver
109909
+ */
109910
+ GingerDependentRolledOver.fromObject = function fromObject(object) {
109911
+ if (object instanceof $root.GingerDependentRolledOver)
109912
+ return object;
109913
+ var message = new $root.GingerDependentRolledOver();
109914
+ if (object.orgHeadspaceHealthId != null)
109915
+ message.orgHeadspaceHealthId = String(object.orgHeadspaceHealthId);
109916
+ if (object.orgB2bId != null)
109917
+ message.orgB2bId = object.orgB2bId >>> 0;
109918
+ if (object.orgGingerId != null)
109919
+ message.orgGingerId = object.orgGingerId >>> 0;
109920
+ if (object.primaryHsUserId != null)
109921
+ message.primaryHsUserId = String(object.primaryHsUserId);
109922
+ if (object.dependentHsUserId != null)
109923
+ message.dependentHsUserId = String(object.dependentHsUserId);
109924
+ return message;
109925
+ };
109926
+
109927
+ /**
109928
+ * Creates a plain object from a GingerDependentRolledOver message. Also converts values to other types if specified.
109929
+ * @function toObject
109930
+ * @memberof GingerDependentRolledOver
109931
+ * @static
109932
+ * @param {GingerDependentRolledOver} message GingerDependentRolledOver
109933
+ * @param {$protobuf.IConversionOptions} [options] Conversion options
109934
+ * @returns {Object.<string,*>} Plain object
109935
+ */
109936
+ GingerDependentRolledOver.toObject = function toObject(message, options) {
109937
+ if (!options)
109938
+ options = {};
109939
+ var object = {};
109940
+ if (options.defaults) {
109941
+ object.orgHeadspaceHealthId = "";
109942
+ object.orgB2bId = 0;
109943
+ object.orgGingerId = 0;
109944
+ object.primaryHsUserId = "";
109945
+ object.dependentHsUserId = "";
109946
+ }
109947
+ if (message.orgHeadspaceHealthId != null && message.hasOwnProperty("orgHeadspaceHealthId"))
109948
+ object.orgHeadspaceHealthId = message.orgHeadspaceHealthId;
109949
+ if (message.orgB2bId != null && message.hasOwnProperty("orgB2bId"))
109950
+ object.orgB2bId = message.orgB2bId;
109951
+ if (message.orgGingerId != null && message.hasOwnProperty("orgGingerId"))
109952
+ object.orgGingerId = message.orgGingerId;
109953
+ if (message.primaryHsUserId != null && message.hasOwnProperty("primaryHsUserId"))
109954
+ object.primaryHsUserId = message.primaryHsUserId;
109955
+ if (message.dependentHsUserId != null && message.hasOwnProperty("dependentHsUserId"))
109956
+ object.dependentHsUserId = message.dependentHsUserId;
109957
+ return object;
109958
+ };
109959
+
109960
+ /**
109961
+ * Converts this GingerDependentRolledOver to JSON.
109962
+ * @function toJSON
109963
+ * @memberof GingerDependentRolledOver
109964
+ * @instance
109965
+ * @returns {Object.<string,*>} JSON object
109966
+ */
109967
+ GingerDependentRolledOver.prototype.toJSON = function toJSON() {
109968
+ return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
109969
+ };
109970
+
109971
+ return GingerDependentRolledOver;
109972
+ })();
109973
+
109696
109974
  $root.GoalSet = (function() {
109697
109975
 
109698
109976
  /**
package/package.json CHANGED
@@ -16,5 +16,5 @@
16
16
  "main": "lib/index.js",
17
17
  "name": "@headspace/protos-events",
18
18
  "typings": "lib/index.d.ts",
19
- "version": "1.541.0"
19
+ "version": "1.542.0"
20
20
  }