@headspace/protos-events 1.850.0 → 1.852.0

package/lib/index.d.ts

@@ -95547,6 +95547,292 @@ export namespace PartnerSignalWindDownScheduled {
     type $Shape = PartnerSignalWindDownScheduled.$Properties;
 }
 
+/**
+ * Properties of a ContentEngagementPassportCreated.
+ * @deprecated Use ContentEngagementPassportCreated.$Properties instead.
+ */
+export interface IContentEngagementPassportCreated extends ContentEngagementPassportCreated.$Properties {
+}
+
+/**
+ * Sent when a passport (experience-universe envelope) has been created.
+ * Fired by hs-content-engagement-service.
+ * Responsible team: Core Platform
+ * Responsible domain: Content
+ */
+export class ContentEngagementPassportCreated {
+
+    /**
+     * Constructs a new ContentEngagementPassportCreated.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: ContentEngagementPassportCreated.$Properties);
+
+    /** Unknown fields preserved while decoding */
+    $unknowns?: Uint8Array[];
+
+    /** ContentEngagementPassportCreated passportId. */
+    passportId: string;
+
+    /** ContentEngagementPassportCreated profileId. */
+    profileId: string;
+
+    /** ContentEngagementPassportCreated hsUserId. */
+    hsUserId: string;
+
+    /** ContentEngagementPassportCreated universe. */
+    universe: string;
+
+    /** ContentEngagementPassportCreated timestamp. */
+    timestamp: (number|Long);
+
+    /**
+     * Creates a new ContentEngagementPassportCreated instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns ContentEngagementPassportCreated instance
+     */
+    static create(properties: ContentEngagementPassportCreated.$Shape): ContentEngagementPassportCreated & ContentEngagementPassportCreated.$Shape;
+    static create(properties?: ContentEngagementPassportCreated.$Properties): ContentEngagementPassportCreated;
+
+    /**
+     * Encodes the specified ContentEngagementPassportCreated message. Does not implicitly {@link ContentEngagementPassportCreated.verify|verify} messages.
+     * @param message ContentEngagementPassportCreated message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encode(message: ContentEngagementPassportCreated.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified ContentEngagementPassportCreated message, length delimited. Does not implicitly {@link ContentEngagementPassportCreated.verify|verify} messages.
+     * @param message ContentEngagementPassportCreated message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encodeDelimited(message: ContentEngagementPassportCreated.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a ContentEngagementPassportCreated message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns {ContentEngagementPassportCreated & ContentEngagementPassportCreated.$Shape} ContentEngagementPassportCreated
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): ContentEngagementPassportCreated & ContentEngagementPassportCreated.$Shape;
+
+    /**
+     * Decodes a ContentEngagementPassportCreated message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns {ContentEngagementPassportCreated & ContentEngagementPassportCreated.$Shape} ContentEngagementPassportCreated
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): ContentEngagementPassportCreated & ContentEngagementPassportCreated.$Shape;
+
+    /**
+     * Verifies a ContentEngagementPassportCreated message.
+     * @param message Plain object to verify
+     * @returns `null` if valid, otherwise the reason why it is not
+     */
+    static verify(message: { [k: string]: any }): (string|null);
+
+    /**
+     * Creates a ContentEngagementPassportCreated message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns ContentEngagementPassportCreated
+     */
+    static fromObject(object: { [k: string]: any }): ContentEngagementPassportCreated;
+
+    /**
+     * Creates a plain object from a ContentEngagementPassportCreated message. Also converts values to other types if specified.
+     * @param message ContentEngagementPassportCreated
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    static toObject(message: ContentEngagementPassportCreated, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this ContentEngagementPassportCreated to JSON.
+     * @returns JSON object
+     */
+    toJSON(): { [k: string]: any };
+
+    /**
+     * Gets the type url for ContentEngagementPassportCreated
+     * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
+     * @returns The type url
+     */
+    static getTypeUrl(prefix?: string): string;
+}
+
+export namespace ContentEngagementPassportCreated {
+
+    /** Properties of a ContentEngagementPassportCreated. */
+    interface $Properties {
+
+        /** ContentEngagementPassportCreated passportId */
+        passportId?: (string|null);
+
+        /** ContentEngagementPassportCreated profileId */
+        profileId?: (string|null);
+
+        /** ContentEngagementPassportCreated hsUserId */
+        hsUserId?: (string|null);
+
+        /** ContentEngagementPassportCreated universe */
+        universe?: (string|null);
+
+        /** ContentEngagementPassportCreated timestamp */
+        timestamp?: (number|Long|null);
+
+        /** Unknown fields preserved while decoding */
+        $unknowns?: Uint8Array[];
+    }
+
+    /** Shape of a ContentEngagementPassportCreated. */
+    type $Shape = ContentEngagementPassportCreated.$Properties;
+}
+
+/**
+ * Properties of a ContentEngagementPassportDeleted.
+ * @deprecated Use ContentEngagementPassportDeleted.$Properties instead.
+ */
+export interface IContentEngagementPassportDeleted extends ContentEngagementPassportDeleted.$Properties {
+}
+
+/**
+ * Sent when a passport (experience-universe envelope) has been deleted.
+ * Fired by hs-content-engagement-service.
+ * Responsible team: Core Platform
+ * Responsible domain: Content
+ */
+export class ContentEngagementPassportDeleted {
+
+    /**
+     * Constructs a new ContentEngagementPassportDeleted.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: ContentEngagementPassportDeleted.$Properties);
+
+    /** Unknown fields preserved while decoding */
+    $unknowns?: Uint8Array[];
+
+    /** ContentEngagementPassportDeleted passportId. */
+    passportId: string;
+
+    /** ContentEngagementPassportDeleted profileId. */
+    profileId: string;
+
+    /** ContentEngagementPassportDeleted hsUserId. */
+    hsUserId: string;
+
+    /** ContentEngagementPassportDeleted timestamp. */
+    timestamp: (number|Long);
+
+    /**
+     * Creates a new ContentEngagementPassportDeleted instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns ContentEngagementPassportDeleted instance
+     */
+    static create(properties: ContentEngagementPassportDeleted.$Shape): ContentEngagementPassportDeleted & ContentEngagementPassportDeleted.$Shape;
+    static create(properties?: ContentEngagementPassportDeleted.$Properties): ContentEngagementPassportDeleted;
+
+    /**
+     * Encodes the specified ContentEngagementPassportDeleted message. Does not implicitly {@link ContentEngagementPassportDeleted.verify|verify} messages.
+     * @param message ContentEngagementPassportDeleted message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encode(message: ContentEngagementPassportDeleted.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified ContentEngagementPassportDeleted message, length delimited. Does not implicitly {@link ContentEngagementPassportDeleted.verify|verify} messages.
+     * @param message ContentEngagementPassportDeleted message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encodeDelimited(message: ContentEngagementPassportDeleted.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a ContentEngagementPassportDeleted message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns {ContentEngagementPassportDeleted & ContentEngagementPassportDeleted.$Shape} ContentEngagementPassportDeleted
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): ContentEngagementPassportDeleted & ContentEngagementPassportDeleted.$Shape;
+
+    /**
+     * Decodes a ContentEngagementPassportDeleted message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns {ContentEngagementPassportDeleted & ContentEngagementPassportDeleted.$Shape} ContentEngagementPassportDeleted
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): ContentEngagementPassportDeleted & ContentEngagementPassportDeleted.$Shape;
+
+    /**
+     * Verifies a ContentEngagementPassportDeleted message.
+     * @param message Plain object to verify
+     * @returns `null` if valid, otherwise the reason why it is not
+     */
+    static verify(message: { [k: string]: any }): (string|null);
+
+    /**
+     * Creates a ContentEngagementPassportDeleted message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns ContentEngagementPassportDeleted
+     */
+    static fromObject(object: { [k: string]: any }): ContentEngagementPassportDeleted;
+
+    /**
+     * Creates a plain object from a ContentEngagementPassportDeleted message. Also converts values to other types if specified.
+     * @param message ContentEngagementPassportDeleted
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    static toObject(message: ContentEngagementPassportDeleted, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this ContentEngagementPassportDeleted to JSON.
+     * @returns JSON object
+     */
+    toJSON(): { [k: string]: any };
+
+    /**
+     * Gets the type url for ContentEngagementPassportDeleted
+     * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
+     * @returns The type url
+     */
+    static getTypeUrl(prefix?: string): string;
+}
+
+export namespace ContentEngagementPassportDeleted {
+
+    /** Properties of a ContentEngagementPassportDeleted. */
+    interface $Properties {
+
+        /** ContentEngagementPassportDeleted passportId */
+        passportId?: (string|null);
+
+        /** ContentEngagementPassportDeleted profileId */
+        profileId?: (string|null);
+
+        /** ContentEngagementPassportDeleted hsUserId */
+        hsUserId?: (string|null);
+
+        /** ContentEngagementPassportDeleted timestamp */
+        timestamp?: (number|Long|null);
+
+        /** Unknown fields preserved while decoding */
+        $unknowns?: Uint8Array[];
+    }
+
+    /** Shape of a ContentEngagementPassportDeleted. */
+    type $Shape = ContentEngagementPassportDeleted.$Properties;
+}
+
 /**
  * Properties of a PHQAssessmentAssigned.
  * @deprecated Use PHQAssessmentAssigned.$Properties instead.
@@ -110347,6 +110633,303 @@ export enum UserServiceAppClient {
     USER_SERVICE_APP_CLIENT_CROCPIT = 3
 }
 
+/**
+ * Properties of a UserProfileCreated.
+ * @deprecated Use UserProfileCreated.$Properties instead.
+ */
+export interface IUserProfileCreated extends UserProfileCreated.$Properties {
+}
+
+/**
+ * Sent when a Headspace Jr. child profile is created.
+ *
+ * "Profile" here is the Headspace Jr. child-profile identity concept. It is a different
+ * bounded concept from the pre-existing, apparently-unused UserProfileResponse /
+ * UserProfileManager RPC schema in protos/services/user/user_profile.proto (an Amplitude
+ * profile lookup) — do not conflate the two.
+ *
+ * display_name and birth_year_month are intentionally carried on this event for
+ * data-lake-only routing. Do not remove them assuming they are an oversight.
+ *
+ * Consumers: published by hs-user-service; consumed by Braze/lifecycle and the data lake.
+ */
+export class UserProfileCreated {
+
+    /**
+     * Constructs a new UserProfileCreated.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: UserProfileCreated.$Properties);
+
+    /** Unknown fields preserved while decoding */
+    $unknowns?: Uint8Array[];
+
+    /** UserProfileCreated hsUserId. */
+    hsUserId: string;
+
+    /** UserProfileCreated profileId. */
+    profileId: string;
+
+    /** UserProfileCreated displayName. */
+    displayName: string;
+
+    /** UserProfileCreated birthYearMonth. */
+    birthYearMonth: string;
+
+    /** UserProfileCreated timestamp. */
+    timestamp: (number|Long);
+
+    /**
+     * Creates a new UserProfileCreated instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns UserProfileCreated instance
+     */
+    static create(properties: UserProfileCreated.$Shape): UserProfileCreated & UserProfileCreated.$Shape;
+    static create(properties?: UserProfileCreated.$Properties): UserProfileCreated;
+
+    /**
+     * Encodes the specified UserProfileCreated message. Does not implicitly {@link UserProfileCreated.verify|verify} messages.
+     * @param message UserProfileCreated message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encode(message: UserProfileCreated.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified UserProfileCreated message, length delimited. Does not implicitly {@link UserProfileCreated.verify|verify} messages.
+     * @param message UserProfileCreated message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encodeDelimited(message: UserProfileCreated.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a UserProfileCreated message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns {UserProfileCreated & UserProfileCreated.$Shape} UserProfileCreated
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): UserProfileCreated & UserProfileCreated.$Shape;
+
+    /**
+     * Decodes a UserProfileCreated message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns {UserProfileCreated & UserProfileCreated.$Shape} UserProfileCreated
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): UserProfileCreated & UserProfileCreated.$Shape;
+
+    /**
+     * Verifies a UserProfileCreated message.
+     * @param message Plain object to verify
+     * @returns `null` if valid, otherwise the reason why it is not
+     */
+    static verify(message: { [k: string]: any }): (string|null);
+
+    /**
+     * Creates a UserProfileCreated message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns UserProfileCreated
+     */
+    static fromObject(object: { [k: string]: any }): UserProfileCreated;
+
+    /**
+     * Creates a plain object from a UserProfileCreated message. Also converts values to other types if specified.
+     * @param message UserProfileCreated
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    static toObject(message: UserProfileCreated, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this UserProfileCreated to JSON.
+     * @returns JSON object
+     */
+    toJSON(): { [k: string]: any };
+
+    /**
+     * Gets the type url for UserProfileCreated
+     * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
+     * @returns The type url
+     */
+    static getTypeUrl(prefix?: string): string;
+}
+
+export namespace UserProfileCreated {
+
+    /** Properties of a UserProfileCreated. */
+    interface $Properties {
+
+        /** UserProfileCreated hsUserId */
+        hsUserId?: (string|null);
+
+        /** UserProfileCreated profileId */
+        profileId?: (string|null);
+
+        /** UserProfileCreated displayName */
+        displayName?: (string|null);
+
+        /** UserProfileCreated birthYearMonth */
+        birthYearMonth?: (string|null);
+
+        /** UserProfileCreated timestamp */
+        timestamp?: (number|Long|null);
+
+        /** Unknown fields preserved while decoding */
+        $unknowns?: Uint8Array[];
+    }
+
+    /** Shape of a UserProfileCreated. */
+    type $Shape = UserProfileCreated.$Properties;
+}
+
+/**
+ * Properties of a UserProfileDeleted.
+ * @deprecated Use UserProfileDeleted.$Properties instead.
+ */
+export interface IUserProfileDeleted extends UserProfileDeleted.$Properties {
+}
+
+/**
+ * Sent when a Headspace Jr. child profile is deleted.
+ *
+ * "Profile" here is the Headspace Jr. child-profile identity concept. It is a different
+ * bounded concept from the pre-existing, apparently-unused UserProfileResponse /
+ * UserProfileManager RPC schema in protos/services/user/user_profile.proto (an Amplitude
+ * profile lookup) — do not conflate the two.
+ *
+ * Consumers: published by hs-user-service; consumed by hs-content-engagement-service to
+ * cascade-delete the profile's passports.
+ *
+ * That cascade delete is eventually consistent, not atomic: this event fires after the
+ * profile row is already gone, and passport cleanup happens asynchronously on the consumer
+ * side afterward. A caller can briefly still see a just-deleted profile's passports until
+ * this event is consumed. This is an accepted tradeoff, not a bug.
+ */
+export class UserProfileDeleted {
+
+    /**
+     * Constructs a new UserProfileDeleted.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: UserProfileDeleted.$Properties);
+
+    /** Unknown fields preserved while decoding */
+    $unknowns?: Uint8Array[];
+
+    /** UserProfileDeleted hsUserId. */
+    hsUserId: string;
+
+    /** UserProfileDeleted profileId. */
+    profileId: string;
+
+    /** UserProfileDeleted timestamp. */
+    timestamp: (number|Long);
+
+    /**
+     * Creates a new UserProfileDeleted instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns UserProfileDeleted instance
+     */
+    static create(properties: UserProfileDeleted.$Shape): UserProfileDeleted & UserProfileDeleted.$Shape;
+    static create(properties?: UserProfileDeleted.$Properties): UserProfileDeleted;
+
+    /**
+     * Encodes the specified UserProfileDeleted message. Does not implicitly {@link UserProfileDeleted.verify|verify} messages.
+     * @param message UserProfileDeleted message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encode(message: UserProfileDeleted.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified UserProfileDeleted message, length delimited. Does not implicitly {@link UserProfileDeleted.verify|verify} messages.
+     * @param message UserProfileDeleted message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encodeDelimited(message: UserProfileDeleted.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a UserProfileDeleted message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns {UserProfileDeleted & UserProfileDeleted.$Shape} UserProfileDeleted
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): UserProfileDeleted & UserProfileDeleted.$Shape;
+
+    /**
+     * Decodes a UserProfileDeleted message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns {UserProfileDeleted & UserProfileDeleted.$Shape} UserProfileDeleted
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): UserProfileDeleted & UserProfileDeleted.$Shape;
+
+    /**
+     * Verifies a UserProfileDeleted message.
+     * @param message Plain object to verify
+     * @returns `null` if valid, otherwise the reason why it is not
+     */
+    static verify(message: { [k: string]: any }): (string|null);
+
+    /**
+     * Creates a UserProfileDeleted message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns UserProfileDeleted
+     */
+    static fromObject(object: { [k: string]: any }): UserProfileDeleted;
+
+    /**
+     * Creates a plain object from a UserProfileDeleted message. Also converts values to other types if specified.
+     * @param message UserProfileDeleted
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    static toObject(message: UserProfileDeleted, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this UserProfileDeleted to JSON.
+     * @returns JSON object
+     */
+    toJSON(): { [k: string]: any };
+
+    /**
+     * Gets the type url for UserProfileDeleted
+     * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
+     * @returns The type url
+     */
+    static getTypeUrl(prefix?: string): string;
+}
+
+export namespace UserProfileDeleted {
+
+    /** Properties of a UserProfileDeleted. */
+    interface $Properties {
+
+        /** UserProfileDeleted hsUserId */
+        hsUserId?: (string|null);
+
+        /** UserProfileDeleted profileId */
+        profileId?: (string|null);
+
+        /** UserProfileDeleted timestamp */
+        timestamp?: (number|Long|null);
+
+        /** Unknown fields preserved while decoding */
+        $unknowns?: Uint8Array[];
+    }
+
+    /** Shape of a UserProfileDeleted. */
+    type $Shape = UserProfileDeleted.$Properties;
+}
+
 /**
  * Properties of a CareCoachingInteractionStarted.
  * @deprecated Use CareCoachingInteractionStarted.$Properties instead.