@headspace/protos-events 1.808.0 → 1.810.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
@@ -68958,6 +68958,153 @@ export namespace OrgMarketingConfigUpdated {
68958
68958
  type $Shape = OrgMarketingConfigUpdated.$Properties;
68959
68959
  }
68960
68960
 
68961
+ /**
68962
+ * Properties of an OrgProviderPartnerConfigUpdated.
68963
+ * @deprecated Use OrgProviderPartnerConfigUpdated.$Properties instead.
68964
+ */
68965
+ export interface IOrgProviderPartnerConfigUpdated extends OrgProviderPartnerConfigUpdated.$Properties {
68966
+ }
68967
+
68968
+ /** Represents an OrgProviderPartnerConfigUpdated. */
68969
+ export class OrgProviderPartnerConfigUpdated {
68970
+
68971
+ /**
68972
+ * Constructs a new OrgProviderPartnerConfigUpdated.
68973
+ * @param [properties] Properties to set
68974
+ */
68975
+ constructor(properties?: OrgProviderPartnerConfigUpdated.$Properties);
68976
+
68977
+ /** Unknown fields preserved while decoding */
68978
+ $unknowns?: Uint8Array[];
68979
+
68980
+ /** OrgProviderPartnerConfigUpdated b2bOrgId. */
68981
+ b2bOrgId: number;
68982
+
68983
+ /** OrgProviderPartnerConfigUpdated providerPartner. */
68984
+ providerPartner: clinical.ClinicalPartnerSource;
68985
+
68986
+ /** OrgProviderPartnerConfigUpdated isVirtualEnabled. */
68987
+ isVirtualEnabled: boolean;
68988
+
68989
+ /** OrgProviderPartnerConfigUpdated isInpersonEnabled. */
68990
+ isInpersonEnabled: boolean;
68991
+
68992
+ /** OrgProviderPartnerConfigUpdated adminId. */
68993
+ adminId: number;
68994
+
68995
+ /** OrgProviderPartnerConfigUpdated timestamp. */
68996
+ timestamp: (number|Long);
68997
+
68998
+ /**
68999
+ * Creates a new OrgProviderPartnerConfigUpdated instance using the specified properties.
69000
+ * @param [properties] Properties to set
69001
+ * @returns OrgProviderPartnerConfigUpdated instance
69002
+ */
69003
+ static create(properties: OrgProviderPartnerConfigUpdated.$Shape): OrgProviderPartnerConfigUpdated & OrgProviderPartnerConfigUpdated.$Shape;
69004
+ static create(properties?: OrgProviderPartnerConfigUpdated.$Properties): OrgProviderPartnerConfigUpdated;
69005
+
69006
+ /**
69007
+ * Encodes the specified OrgProviderPartnerConfigUpdated message. Does not implicitly {@link OrgProviderPartnerConfigUpdated.verify|verify} messages.
69008
+ * @param message OrgProviderPartnerConfigUpdated message or plain object to encode
69009
+ * @param [writer] Writer to encode to
69010
+ * @returns Writer
69011
+ */
69012
+ static encode(message: OrgProviderPartnerConfigUpdated.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
69013
+
69014
+ /**
69015
+ * Encodes the specified OrgProviderPartnerConfigUpdated message, length delimited. Does not implicitly {@link OrgProviderPartnerConfigUpdated.verify|verify} messages.
69016
+ * @param message OrgProviderPartnerConfigUpdated message or plain object to encode
69017
+ * @param [writer] Writer to encode to
69018
+ * @returns Writer
69019
+ */
69020
+ static encodeDelimited(message: OrgProviderPartnerConfigUpdated.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
69021
+
69022
+ /**
69023
+ * Decodes an OrgProviderPartnerConfigUpdated message from the specified reader or buffer.
69024
+ * @param reader Reader or buffer to decode from
69025
+ * @param [length] Message length if known beforehand
69026
+ * @returns {OrgProviderPartnerConfigUpdated & OrgProviderPartnerConfigUpdated.$Shape} OrgProviderPartnerConfigUpdated
69027
+ * @throws {Error} If the payload is not a reader or valid buffer
69028
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
69029
+ */
69030
+ static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): OrgProviderPartnerConfigUpdated & OrgProviderPartnerConfigUpdated.$Shape;
69031
+
69032
+ /**
69033
+ * Decodes an OrgProviderPartnerConfigUpdated message from the specified reader or buffer, length delimited.
69034
+ * @param reader Reader or buffer to decode from
69035
+ * @returns {OrgProviderPartnerConfigUpdated & OrgProviderPartnerConfigUpdated.$Shape} OrgProviderPartnerConfigUpdated
69036
+ * @throws {Error} If the payload is not a reader or valid buffer
69037
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
69038
+ */
69039
+ static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): OrgProviderPartnerConfigUpdated & OrgProviderPartnerConfigUpdated.$Shape;
69040
+
69041
+ /**
69042
+ * Verifies an OrgProviderPartnerConfigUpdated message.
69043
+ * @param message Plain object to verify
69044
+ * @returns `null` if valid, otherwise the reason why it is not
69045
+ */
69046
+ static verify(message: { [k: string]: any }): (string|null);
69047
+
69048
+ /**
69049
+ * Creates an OrgProviderPartnerConfigUpdated message from a plain object. Also converts values to their respective internal types.
69050
+ * @param object Plain object
69051
+ * @returns OrgProviderPartnerConfigUpdated
69052
+ */
69053
+ static fromObject(object: { [k: string]: any }): OrgProviderPartnerConfigUpdated;
69054
+
69055
+ /**
69056
+ * Creates a plain object from an OrgProviderPartnerConfigUpdated message. Also converts values to other types if specified.
69057
+ * @param message OrgProviderPartnerConfigUpdated
69058
+ * @param [options] Conversion options
69059
+ * @returns Plain object
69060
+ */
69061
+ static toObject(message: OrgProviderPartnerConfigUpdated, options?: $protobuf.IConversionOptions): { [k: string]: any };
69062
+
69063
+ /**
69064
+ * Converts this OrgProviderPartnerConfigUpdated to JSON.
69065
+ * @returns JSON object
69066
+ */
69067
+ toJSON(): { [k: string]: any };
69068
+
69069
+ /**
69070
+ * Gets the type url for OrgProviderPartnerConfigUpdated
69071
+ * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
69072
+ * @returns The type url
69073
+ */
69074
+ static getTypeUrl(prefix?: string): string;
69075
+ }
69076
+
69077
+ export namespace OrgProviderPartnerConfigUpdated {
69078
+
69079
+ /** Properties of an OrgProviderPartnerConfigUpdated. */
69080
+ interface $Properties {
69081
+
69082
+ /** OrgProviderPartnerConfigUpdated b2bOrgId */
69083
+ b2bOrgId?: (number|null);
69084
+
69085
+ /** OrgProviderPartnerConfigUpdated providerPartner */
69086
+ providerPartner?: (clinical.ClinicalPartnerSource|null);
69087
+
69088
+ /** OrgProviderPartnerConfigUpdated isVirtualEnabled */
69089
+ isVirtualEnabled?: (boolean|null);
69090
+
69091
+ /** OrgProviderPartnerConfigUpdated isInpersonEnabled */
69092
+ isInpersonEnabled?: (boolean|null);
69093
+
69094
+ /** OrgProviderPartnerConfigUpdated adminId */
69095
+ adminId?: (number|null);
69096
+
69097
+ /** OrgProviderPartnerConfigUpdated timestamp */
69098
+ timestamp?: (number|Long|null);
69099
+
69100
+ /** Unknown fields preserved while decoding */
69101
+ $unknowns?: Uint8Array[];
69102
+ }
69103
+
69104
+ /** Shape of an OrgProviderPartnerConfigUpdated. */
69105
+ type $Shape = OrgProviderPartnerConfigUpdated.$Properties;
69106
+ }
69107
+
68961
69108
  /**
68962
69109
  * Properties of an OrganizationSubscriptionCreated.
68963
69110
  * @deprecated Use OrganizationSubscriptionCreated.$Properties instead.
@@ -89658,6 +89805,143 @@ export namespace PartnerSignalStateAssigned {
89658
89805
  type $Shape = PartnerSignalStateAssigned.$Properties;
89659
89806
  }
89660
89807
 
89808
+ /**
89809
+ * Properties of a PartnerSignalWindDownScheduled.
89810
+ * @deprecated Use PartnerSignalWindDownScheduled.$Properties instead.
89811
+ */
89812
+ export interface IPartnerSignalWindDownScheduled extends PartnerSignalWindDownScheduled.$Properties {
89813
+ }
89814
+
89815
+ /**
89816
+ * Published when a user submits a new night of Apple HealthKit sleep data and has enough history
89817
+ * (≥1 prior night with a recorded sleep start time) to compute a personalized wind-down reminder time.
89818
+ * Used to schedule a push notification 30 minutes before the user's average historical bedtime.
89819
+ */
89820
+ export class PartnerSignalWindDownScheduled {
89821
+
89822
+ /**
89823
+ * Constructs a new PartnerSignalWindDownScheduled.
89824
+ * @param [properties] Properties to set
89825
+ */
89826
+ constructor(properties?: PartnerSignalWindDownScheduled.$Properties);
89827
+
89828
+ /** Unknown fields preserved while decoding */
89829
+ $unknowns?: Uint8Array[];
89830
+
89831
+ /** Headspace user that should receive the wind-down push notification (e.g. HSUSER_ABC123). */
89832
+ hsUserId: string;
89833
+
89834
+ /**
89835
+ * ISO 8601 UTC datetime at which the wind-down push should be delivered.
89836
+ * Computed as the circular mean of the user's recent sleep start times minus 30 minutes,
89837
+ * projected onto today's date (e.g. "2026-05-30T21:30:00.000Z").
89838
+ * Only set if this time is still in the future at the moment of publishing.
89839
+ */
89840
+ scheduledTimeIso: string;
89841
+
89842
+ /**
89843
+ * Creates a new PartnerSignalWindDownScheduled instance using the specified properties.
89844
+ * @param [properties] Properties to set
89845
+ * @returns PartnerSignalWindDownScheduled instance
89846
+ */
89847
+ static create(properties: PartnerSignalWindDownScheduled.$Shape): PartnerSignalWindDownScheduled & PartnerSignalWindDownScheduled.$Shape;
89848
+ static create(properties?: PartnerSignalWindDownScheduled.$Properties): PartnerSignalWindDownScheduled;
89849
+
89850
+ /**
89851
+ * Encodes the specified PartnerSignalWindDownScheduled message. Does not implicitly {@link PartnerSignalWindDownScheduled.verify|verify} messages.
89852
+ * @param message PartnerSignalWindDownScheduled message or plain object to encode
89853
+ * @param [writer] Writer to encode to
89854
+ * @returns Writer
89855
+ */
89856
+ static encode(message: PartnerSignalWindDownScheduled.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
89857
+
89858
+ /**
89859
+ * Encodes the specified PartnerSignalWindDownScheduled message, length delimited. Does not implicitly {@link PartnerSignalWindDownScheduled.verify|verify} messages.
89860
+ * @param message PartnerSignalWindDownScheduled message or plain object to encode
89861
+ * @param [writer] Writer to encode to
89862
+ * @returns Writer
89863
+ */
89864
+ static encodeDelimited(message: PartnerSignalWindDownScheduled.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
89865
+
89866
+ /**
89867
+ * Decodes a PartnerSignalWindDownScheduled message from the specified reader or buffer.
89868
+ * @param reader Reader or buffer to decode from
89869
+ * @param [length] Message length if known beforehand
89870
+ * @returns {PartnerSignalWindDownScheduled & PartnerSignalWindDownScheduled.$Shape} PartnerSignalWindDownScheduled
89871
+ * @throws {Error} If the payload is not a reader or valid buffer
89872
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
89873
+ */
89874
+ static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): PartnerSignalWindDownScheduled & PartnerSignalWindDownScheduled.$Shape;
89875
+
89876
+ /**
89877
+ * Decodes a PartnerSignalWindDownScheduled message from the specified reader or buffer, length delimited.
89878
+ * @param reader Reader or buffer to decode from
89879
+ * @returns {PartnerSignalWindDownScheduled & PartnerSignalWindDownScheduled.$Shape} PartnerSignalWindDownScheduled
89880
+ * @throws {Error} If the payload is not a reader or valid buffer
89881
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
89882
+ */
89883
+ static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): PartnerSignalWindDownScheduled & PartnerSignalWindDownScheduled.$Shape;
89884
+
89885
+ /**
89886
+ * Verifies a PartnerSignalWindDownScheduled message.
89887
+ * @param message Plain object to verify
89888
+ * @returns `null` if valid, otherwise the reason why it is not
89889
+ */
89890
+ static verify(message: { [k: string]: any }): (string|null);
89891
+
89892
+ /**
89893
+ * Creates a PartnerSignalWindDownScheduled message from a plain object. Also converts values to their respective internal types.
89894
+ * @param object Plain object
89895
+ * @returns PartnerSignalWindDownScheduled
89896
+ */
89897
+ static fromObject(object: { [k: string]: any }): PartnerSignalWindDownScheduled;
89898
+
89899
+ /**
89900
+ * Creates a plain object from a PartnerSignalWindDownScheduled message. Also converts values to other types if specified.
89901
+ * @param message PartnerSignalWindDownScheduled
89902
+ * @param [options] Conversion options
89903
+ * @returns Plain object
89904
+ */
89905
+ static toObject(message: PartnerSignalWindDownScheduled, options?: $protobuf.IConversionOptions): { [k: string]: any };
89906
+
89907
+ /**
89908
+ * Converts this PartnerSignalWindDownScheduled to JSON.
89909
+ * @returns JSON object
89910
+ */
89911
+ toJSON(): { [k: string]: any };
89912
+
89913
+ /**
89914
+ * Gets the type url for PartnerSignalWindDownScheduled
89915
+ * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
89916
+ * @returns The type url
89917
+ */
89918
+ static getTypeUrl(prefix?: string): string;
89919
+ }
89920
+
89921
+ export namespace PartnerSignalWindDownScheduled {
89922
+
89923
+ /** Properties of a PartnerSignalWindDownScheduled. */
89924
+ interface $Properties {
89925
+
89926
+ /** Headspace user that should receive the wind-down push notification (e.g. HSUSER_ABC123). */
89927
+ hsUserId?: (string|null);
89928
+
89929
+ /**
89930
+ * ISO 8601 UTC datetime at which the wind-down push should be delivered.
89931
+ * Computed as the circular mean of the user's recent sleep start times minus 30 minutes,
89932
+ * projected onto today's date (e.g. "2026-05-30T21:30:00.000Z").
89933
+ * Only set if this time is still in the future at the moment of publishing.
89934
+ */
89935
+ scheduledTimeIso?: (string|null);
89936
+
89937
+ /** Unknown fields preserved while decoding */
89938
+ $unknowns?: Uint8Array[];
89939
+ }
89940
+
89941
+ /** Shape of a PartnerSignalWindDownScheduled. */
89942
+ type $Shape = PartnerSignalWindDownScheduled.$Properties;
89943
+ }
89944
+
89661
89945
  /**
89662
89946
  * Properties of a PHQAssessmentAssigned.
89663
89947
  * @deprecated Use PHQAssessmentAssigned.$Properties instead.
@@ -103225,6 +103509,133 @@ export namespace UserAppleWatchNotificationSettingUpdated {
103225
103509
  type $Shape = UserAppleWatchNotificationSettingUpdated.$Properties;
103226
103510
  }
103227
103511
 
103512
+ /**
103513
+ * Properties of a UserAppleHealthSleepNudgeSettingUpdated.
103514
+ * @deprecated Use UserAppleHealthSleepNudgeSettingUpdated.$Properties instead.
103515
+ */
103516
+ export interface IUserAppleHealthSleepNudgeSettingUpdated extends UserAppleHealthSleepNudgeSettingUpdated.$Properties {
103517
+ }
103518
+
103519
+ /**
103520
+ * Sent when a user updates their Apple Health sleep nudge notification setting.
103521
+ * Responsible team: Consumer Growth
103522
+ *
103523
+ */
103524
+ export class UserAppleHealthSleepNudgeSettingUpdated {
103525
+
103526
+ /**
103527
+ * Constructs a new UserAppleHealthSleepNudgeSettingUpdated.
103528
+ * @param [properties] Properties to set
103529
+ */
103530
+ constructor(properties?: UserAppleHealthSleepNudgeSettingUpdated.$Properties);
103531
+
103532
+ /** Unknown fields preserved while decoding */
103533
+ $unknowns?: Uint8Array[];
103534
+
103535
+ /** UserAppleHealthSleepNudgeSettingUpdated hsUserId. */
103536
+ hsUserId: string;
103537
+
103538
+ /** UserAppleHealthSleepNudgeSettingUpdated isEnabled. */
103539
+ isEnabled: boolean;
103540
+
103541
+ /**
103542
+ * Creates a new UserAppleHealthSleepNudgeSettingUpdated instance using the specified properties.
103543
+ * @param [properties] Properties to set
103544
+ * @returns UserAppleHealthSleepNudgeSettingUpdated instance
103545
+ */
103546
+ static create(properties: UserAppleHealthSleepNudgeSettingUpdated.$Shape): UserAppleHealthSleepNudgeSettingUpdated & UserAppleHealthSleepNudgeSettingUpdated.$Shape;
103547
+ static create(properties?: UserAppleHealthSleepNudgeSettingUpdated.$Properties): UserAppleHealthSleepNudgeSettingUpdated;
103548
+
103549
+ /**
103550
+ * Encodes the specified UserAppleHealthSleepNudgeSettingUpdated message. Does not implicitly {@link UserAppleHealthSleepNudgeSettingUpdated.verify|verify} messages.
103551
+ * @param message UserAppleHealthSleepNudgeSettingUpdated message or plain object to encode
103552
+ * @param [writer] Writer to encode to
103553
+ * @returns Writer
103554
+ */
103555
+ static encode(message: UserAppleHealthSleepNudgeSettingUpdated.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
103556
+
103557
+ /**
103558
+ * Encodes the specified UserAppleHealthSleepNudgeSettingUpdated message, length delimited. Does not implicitly {@link UserAppleHealthSleepNudgeSettingUpdated.verify|verify} messages.
103559
+ * @param message UserAppleHealthSleepNudgeSettingUpdated message or plain object to encode
103560
+ * @param [writer] Writer to encode to
103561
+ * @returns Writer
103562
+ */
103563
+ static encodeDelimited(message: UserAppleHealthSleepNudgeSettingUpdated.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
103564
+
103565
+ /**
103566
+ * Decodes a UserAppleHealthSleepNudgeSettingUpdated message from the specified reader or buffer.
103567
+ * @param reader Reader or buffer to decode from
103568
+ * @param [length] Message length if known beforehand
103569
+ * @returns {UserAppleHealthSleepNudgeSettingUpdated & UserAppleHealthSleepNudgeSettingUpdated.$Shape} UserAppleHealthSleepNudgeSettingUpdated
103570
+ * @throws {Error} If the payload is not a reader or valid buffer
103571
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
103572
+ */
103573
+ static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): UserAppleHealthSleepNudgeSettingUpdated & UserAppleHealthSleepNudgeSettingUpdated.$Shape;
103574
+
103575
+ /**
103576
+ * Decodes a UserAppleHealthSleepNudgeSettingUpdated message from the specified reader or buffer, length delimited.
103577
+ * @param reader Reader or buffer to decode from
103578
+ * @returns {UserAppleHealthSleepNudgeSettingUpdated & UserAppleHealthSleepNudgeSettingUpdated.$Shape} UserAppleHealthSleepNudgeSettingUpdated
103579
+ * @throws {Error} If the payload is not a reader or valid buffer
103580
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
103581
+ */
103582
+ static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): UserAppleHealthSleepNudgeSettingUpdated & UserAppleHealthSleepNudgeSettingUpdated.$Shape;
103583
+
103584
+ /**
103585
+ * Verifies a UserAppleHealthSleepNudgeSettingUpdated message.
103586
+ * @param message Plain object to verify
103587
+ * @returns `null` if valid, otherwise the reason why it is not
103588
+ */
103589
+ static verify(message: { [k: string]: any }): (string|null);
103590
+
103591
+ /**
103592
+ * Creates a UserAppleHealthSleepNudgeSettingUpdated message from a plain object. Also converts values to their respective internal types.
103593
+ * @param object Plain object
103594
+ * @returns UserAppleHealthSleepNudgeSettingUpdated
103595
+ */
103596
+ static fromObject(object: { [k: string]: any }): UserAppleHealthSleepNudgeSettingUpdated;
103597
+
103598
+ /**
103599
+ * Creates a plain object from a UserAppleHealthSleepNudgeSettingUpdated message. Also converts values to other types if specified.
103600
+ * @param message UserAppleHealthSleepNudgeSettingUpdated
103601
+ * @param [options] Conversion options
103602
+ * @returns Plain object
103603
+ */
103604
+ static toObject(message: UserAppleHealthSleepNudgeSettingUpdated, options?: $protobuf.IConversionOptions): { [k: string]: any };
103605
+
103606
+ /**
103607
+ * Converts this UserAppleHealthSleepNudgeSettingUpdated to JSON.
103608
+ * @returns JSON object
103609
+ */
103610
+ toJSON(): { [k: string]: any };
103611
+
103612
+ /**
103613
+ * Gets the type url for UserAppleHealthSleepNudgeSettingUpdated
103614
+ * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
103615
+ * @returns The type url
103616
+ */
103617
+ static getTypeUrl(prefix?: string): string;
103618
+ }
103619
+
103620
+ export namespace UserAppleHealthSleepNudgeSettingUpdated {
103621
+
103622
+ /** Properties of a UserAppleHealthSleepNudgeSettingUpdated. */
103623
+ interface $Properties {
103624
+
103625
+ /** UserAppleHealthSleepNudgeSettingUpdated hsUserId */
103626
+ hsUserId?: (string|null);
103627
+
103628
+ /** UserAppleHealthSleepNudgeSettingUpdated isEnabled */
103629
+ isEnabled?: (boolean|null);
103630
+
103631
+ /** Unknown fields preserved while decoding */
103632
+ $unknowns?: Uint8Array[];
103633
+ }
103634
+
103635
+ /** Shape of a UserAppleHealthSleepNudgeSettingUpdated. */
103636
+ type $Shape = UserAppleHealthSleepNudgeSettingUpdated.$Properties;
103637
+ }
103638
+
103228
103639
  /**
103229
103640
  * Properties of a UserOuraNotificationSettingUpdated.
103230
103641
  * @deprecated Use UserOuraNotificationSettingUpdated.$Properties instead.