@headspace/protos-events 1.782.0 → 1.784.0

package/lib/index.d.ts

@@ -36818,6 +36818,108 @@ export class ClinicalIntakeCompleted implements IClinicalIntakeCompleted {
     public toJSON(): { [k: string]: any };
 }
 
+/** Properties of a TaggedCustomField. */
+export interface ITaggedCustomField {
+
+    /** TaggedCustomField key */
+    key?: (string|null);
+
+    /** TaggedCustomField value */
+    value?: (string|null);
+
+    /** TaggedCustomField fieldTags */
+    fieldTags?: (field_tags.FieldTags[]|null);
+}
+
+/** Represents a TaggedCustomField. */
+export class TaggedCustomField implements ITaggedCustomField {
+
+    /**
+     * Constructs a new TaggedCustomField.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: ITaggedCustomField);
+
+    /** TaggedCustomField key. */
+    public key: string;
+
+    /** TaggedCustomField value. */
+    public value: string;
+
+    /** TaggedCustomField fieldTags. */
+    public fieldTags: field_tags.FieldTags[];
+
+    /**
+     * Creates a new TaggedCustomField instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns TaggedCustomField instance
+     */
+    public static create(properties?: ITaggedCustomField): TaggedCustomField;
+
+    /**
+     * Encodes the specified TaggedCustomField message. Does not implicitly {@link TaggedCustomField.verify|verify} messages.
+     * @param message TaggedCustomField message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: ITaggedCustomField, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified TaggedCustomField message, length delimited. Does not implicitly {@link TaggedCustomField.verify|verify} messages.
+     * @param message TaggedCustomField message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: ITaggedCustomField, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a TaggedCustomField message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns TaggedCustomField
+     * @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): TaggedCustomField;
+
+    /**
+     * Decodes a TaggedCustomField message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns TaggedCustomField
+     * @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)): TaggedCustomField;
+
+    /**
+     * Verifies a TaggedCustomField 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 TaggedCustomField message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns TaggedCustomField
+     */
+    public static fromObject(object: { [k: string]: any }): TaggedCustomField;
+
+    /**
+     * Creates a plain object from a TaggedCustomField message. Also converts values to other types if specified.
+     * @param message TaggedCustomField
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: TaggedCustomField, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this TaggedCustomField to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
 /** GroupType enum. */
 export enum GroupType {
     GROUP_TYPE_UNKNOWN = 0,
@@ -41976,103 +42078,103 @@ export enum PartnerName {
     PARTNER_NAME_PERSONIFY = 3
 }
 
-/** Properties of a TaggedCustomField. */
-export interface ITaggedCustomField {
+/** Properties of an UtmParams. */
+export interface IUtmParams {
 
-    /** TaggedCustomField key */
-    key?: (string|null);
+    /** UtmParams source */
+    source?: (string|null);
 
-    /** TaggedCustomField value */
-    value?: (string|null);
+    /** UtmParams medium */
+    medium?: (string|null);
 
-    /** TaggedCustomField fieldTags */
-    fieldTags?: (field_tags.FieldTags[]|null);
+    /** UtmParams campaign */
+    campaign?: (string|null);
 }
 
-/** Represents a TaggedCustomField. */
-export class TaggedCustomField implements ITaggedCustomField {
+/** Represents an UtmParams. */
+export class UtmParams implements IUtmParams {
 
     /**
-     * Constructs a new TaggedCustomField.
+     * Constructs a new UtmParams.
      * @param [properties] Properties to set
      */
-    constructor(properties?: ITaggedCustomField);
+    constructor(properties?: IUtmParams);
 
-    /** TaggedCustomField key. */
-    public key: string;
+    /** UtmParams source. */
+    public source: string;
 
-    /** TaggedCustomField value. */
-    public value: string;
+    /** UtmParams medium. */
+    public medium: string;
 
-    /** TaggedCustomField fieldTags. */
-    public fieldTags: field_tags.FieldTags[];
+    /** UtmParams campaign. */
+    public campaign: string;
 
     /**
-     * Creates a new TaggedCustomField instance using the specified properties.
+     * Creates a new UtmParams instance using the specified properties.
      * @param [properties] Properties to set
-     * @returns TaggedCustomField instance
+     * @returns UtmParams instance
      */
-    public static create(properties?: ITaggedCustomField): TaggedCustomField;
+    public static create(properties?: IUtmParams): UtmParams;
 
     /**
-     * Encodes the specified TaggedCustomField message. Does not implicitly {@link TaggedCustomField.verify|verify} messages.
-     * @param message TaggedCustomField message or plain object to encode
+     * Encodes the specified UtmParams message. Does not implicitly {@link UtmParams.verify|verify} messages.
+     * @param message UtmParams message or plain object to encode
      * @param [writer] Writer to encode to
      * @returns Writer
      */
-    public static encode(message: ITaggedCustomField, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encode(message: IUtmParams, writer?: $protobuf.Writer): $protobuf.Writer;
 
     /**
-     * Encodes the specified TaggedCustomField message, length delimited. Does not implicitly {@link TaggedCustomField.verify|verify} messages.
-     * @param message TaggedCustomField message or plain object to encode
+     * Encodes the specified UtmParams message, length delimited. Does not implicitly {@link UtmParams.verify|verify} messages.
+     * @param message UtmParams message or plain object to encode
      * @param [writer] Writer to encode to
      * @returns Writer
      */
-    public static encodeDelimited(message: ITaggedCustomField, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IUtmParams, writer?: $protobuf.Writer): $protobuf.Writer;
 
     /**
-     * Decodes a TaggedCustomField message from the specified reader or buffer.
+     * Decodes an UtmParams message from the specified reader or buffer.
      * @param reader Reader or buffer to decode from
      * @param [length] Message length if known beforehand
-     * @returns TaggedCustomField
+     * @returns UtmParams
      * @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): TaggedCustomField;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): UtmParams;
 
     /**
-     * Decodes a TaggedCustomField message from the specified reader or buffer, length delimited.
+     * Decodes an UtmParams message from the specified reader or buffer, length delimited.
      * @param reader Reader or buffer to decode from
-     * @returns TaggedCustomField
+     * @returns UtmParams
      * @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)): TaggedCustomField;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): UtmParams;
 
     /**
-     * Verifies a TaggedCustomField message.
+     * Verifies an UtmParams 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 TaggedCustomField message from a plain object. Also converts values to their respective internal types.
+     * Creates an UtmParams message from a plain object. Also converts values to their respective internal types.
      * @param object Plain object
-     * @returns TaggedCustomField
+     * @returns UtmParams
      */
-    public static fromObject(object: { [k: string]: any }): TaggedCustomField;
+    public static fromObject(object: { [k: string]: any }): UtmParams;
 
     /**
-     * Creates a plain object from a TaggedCustomField message. Also converts values to other types if specified.
-     * @param message TaggedCustomField
+     * Creates a plain object from an UtmParams message. Also converts values to other types if specified.
+     * @param message UtmParams
      * @param [options] Conversion options
      * @returns Plain object
      */
-    public static toObject(message: TaggedCustomField, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public static toObject(message: UtmParams, options?: $protobuf.IConversionOptions): { [k: string]: any };
 
     /**
-     * Converts this TaggedCustomField to JSON.
+     * Converts this UtmParams to JSON.
      * @returns JSON object
      */
     public toJSON(): { [k: string]: any };
@@ -42380,6 +42482,9 @@ export interface IEnterpriseUserEnrollmentCreated {
 
     /** EnterpriseUserEnrollmentCreated isTextCoachingDisabled */
     isTextCoachingDisabled?: (boolean|null);
+
+    /** EnterpriseUserEnrollmentCreated utmParams */
+    utmParams?: (IUtmParams|null);
 }
 
 /** Represents an EnterpriseUserEnrollmentCreated. */
@@ -42559,6 +42664,9 @@ export class EnterpriseUserEnrollmentCreated implements IEnterpriseUserEnrollmen
     /** EnterpriseUserEnrollmentCreated isTextCoachingDisabled. */
     public isTextCoachingDisabled: boolean;
 
+    /** EnterpriseUserEnrollmentCreated utmParams. */
+    public utmParams?: (IUtmParams|null);
+
     /**
      * Creates a new EnterpriseUserEnrollmentCreated instance using the specified properties.
      * @param [properties] Properties to set
@@ -51014,6 +51122,114 @@ export class PartnerRedemptionRevoked implements IPartnerRedemptionRevoked {
     public toJSON(): { [k: string]: any };
 }
 
+/** Properties of a PartnerEventUpdated. */
+export interface IPartnerEventUpdated {
+
+    /** Unique identifier of the partner. Formatted as a 24-char hex string. */
+    partnerId?: (string|null);
+
+    /**
+     * Extracted webhook fields with appropriate sensitivity tags.
+     * Keeps the event schema generic and avoids leaking partner-specific implementation details.
+     */
+    taggedCustomFields?: (ITaggedCustomField[]|null);
+
+    /** UTC epoch milliseconds - when the webhook was received. */
+    receivedAtTimestamp?: (number|Long|null);
+}
+
+/** Represents a PartnerEventUpdated. */
+export class PartnerEventUpdated implements IPartnerEventUpdated {
+
+    /**
+     * Constructs a new PartnerEventUpdated.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: IPartnerEventUpdated);
+
+    /** Unique identifier of the partner. Formatted as a 24-char hex string. */
+    public partnerId: string;
+
+    /**
+     * Extracted webhook fields with appropriate sensitivity tags.
+     * Keeps the event schema generic and avoids leaking partner-specific implementation details.
+     */
+    public taggedCustomFields: ITaggedCustomField[];
+
+    /** UTC epoch milliseconds - when the webhook was received. */
+    public receivedAtTimestamp: (number|Long);
+
+    /**
+     * Creates a new PartnerEventUpdated instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns PartnerEventUpdated instance
+     */
+    public static create(properties?: IPartnerEventUpdated): PartnerEventUpdated;
+
+    /**
+     * Encodes the specified PartnerEventUpdated message. Does not implicitly {@link PartnerEventUpdated.verify|verify} messages.
+     * @param message PartnerEventUpdated message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: IPartnerEventUpdated, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified PartnerEventUpdated message, length delimited. Does not implicitly {@link PartnerEventUpdated.verify|verify} messages.
+     * @param message PartnerEventUpdated message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: IPartnerEventUpdated, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a PartnerEventUpdated message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns PartnerEventUpdated
+     * @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): PartnerEventUpdated;
+
+    /**
+     * Decodes a PartnerEventUpdated message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns PartnerEventUpdated
+     * @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)): PartnerEventUpdated;
+
+    /**
+     * Verifies a PartnerEventUpdated 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 PartnerEventUpdated message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns PartnerEventUpdated
+     */
+    public static fromObject(object: { [k: string]: any }): PartnerEventUpdated;
+
+    /**
+     * Creates a plain object from a PartnerEventUpdated message. Also converts values to other types if specified.
+     * @param message PartnerEventUpdated
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: PartnerEventUpdated, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this PartnerEventUpdated to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
 /** Properties of a PHQAssessmentAssigned. */
 export interface IPHQAssessmentAssigned {