@headspace/protos-events 1.632.0 → 1.634.0

package/lib/index.d.ts

@@ -16949,10 +16949,15 @@ export namespace userdomain {
             HEALTH_USER = 4
         }
 
-        /** UserDeleteReason enum. */
+        /**
+         * User Deletion Reason
+         *
+         * To provide context for the user deletion
+         */
         enum UserDeleteReason {
             UNKNOWN_REASON = 0,
-            INACTIVE = 1
+            INACTIVE = 1,
+            USER_DELETE_REASON_DSAR = 2
         }
     }
 
@@ -43380,6 +43385,9 @@ export interface IClinicalCoverageCreated {
 
     /** ClinicalCoverageCreated externalOrgId */
     externalOrgId?: (string|null);
+
+    /** ClinicalCoverageCreated orgSubscriptionStartDate */
+    orgSubscriptionStartDate?: (number|Long|null);
 }
 
 /** Represents a ClinicalCoverageCreated. */
@@ -43415,6 +43423,9 @@ export class ClinicalCoverageCreated implements IClinicalCoverageCreated {
     /** ClinicalCoverageCreated externalOrgId. */
     public externalOrgId: string;
 
+    /** ClinicalCoverageCreated orgSubscriptionStartDate. */
+    public orgSubscriptionStartDate: (number|Long);
+
     /**
      * Creates a new ClinicalCoverageCreated instance using the specified properties.
      * @param [properties] Properties to set
@@ -43512,6 +43523,9 @@ export interface IClinicalCoverageUpdated {
 
     /** ClinicalCoverageUpdated externalOrgId */
     externalOrgId?: (string|null);
+
+    /** ClinicalCoverageUpdated orgSubscriptionStartDate */
+    orgSubscriptionStartDate?: (number|Long|null);
 }
 
 /** Represents a ClinicalCoverageUpdated. */
@@ -43547,6 +43561,9 @@ export class ClinicalCoverageUpdated implements IClinicalCoverageUpdated {
     /** ClinicalCoverageUpdated externalOrgId. */
     public externalOrgId: string;
 
+    /** ClinicalCoverageUpdated orgSubscriptionStartDate. */
+    public orgSubscriptionStartDate: (number|Long);
+
     /**
      * Creates a new ClinicalCoverageUpdated instance using the specified properties.
      * @param [properties] Properties to set
@@ -43644,6 +43661,9 @@ export interface IClinicalCoverageDeleted {
 
     /** ClinicalCoverageDeleted externalOrgId */
     externalOrgId?: (string|null);
+
+    /** ClinicalCoverageDeleted orgSubscriptionStartDate */
+    orgSubscriptionStartDate?: (number|Long|null);
 }
 
 /** Represents a ClinicalCoverageDeleted. */
@@ -43679,6 +43699,9 @@ export class ClinicalCoverageDeleted implements IClinicalCoverageDeleted {
     /** ClinicalCoverageDeleted externalOrgId. */
     public externalOrgId: string;
 
+    /** ClinicalCoverageDeleted orgSubscriptionStartDate. */
+    public orgSubscriptionStartDate: (number|Long);
+
     /**
      * Creates a new ClinicalCoverageDeleted instance using the specified properties.
      * @param [properties] Properties to set
@@ -43773,6 +43796,9 @@ export interface IEapCoverageCreated {
 
     /** EapCoverageCreated externalOrgId */
     externalOrgId?: (string|null);
+
+    /** EapCoverageCreated orgSubscriptionStartDate */
+    orgSubscriptionStartDate?: (number|Long|null);
 }
 
 /** Represents an EapCoverageCreated. */
@@ -43805,6 +43831,9 @@ export class EapCoverageCreated implements IEapCoverageCreated {
     /** EapCoverageCreated externalOrgId. */
     public externalOrgId: string;
 
+    /** EapCoverageCreated orgSubscriptionStartDate. */
+    public orgSubscriptionStartDate: (number|Long);
+
     /**
      * Creates a new EapCoverageCreated instance using the specified properties.
      * @param [properties] Properties to set
@@ -43899,6 +43928,9 @@ export interface IEapCoverageUpdated {
 
     /** EapCoverageUpdated externalOrgId */
     externalOrgId?: (string|null);
+
+    /** EapCoverageUpdated orgSubscriptionStartDate */
+    orgSubscriptionStartDate?: (number|Long|null);
 }
 
 /** Represents an EapCoverageUpdated. */
@@ -43931,6 +43963,9 @@ export class EapCoverageUpdated implements IEapCoverageUpdated {
     /** EapCoverageUpdated externalOrgId. */
     public externalOrgId: string;
 
+    /** EapCoverageUpdated orgSubscriptionStartDate. */
+    public orgSubscriptionStartDate: (number|Long);
+
     /**
      * Creates a new EapCoverageUpdated instance using the specified properties.
      * @param [properties] Properties to set
@@ -44025,6 +44060,9 @@ export interface IEapCoverageDeleted {
 
     /** EapCoverageDeleted externalOrgId */
     externalOrgId?: (string|null);
+
+    /** EapCoverageDeleted orgSubscriptionStartDate */
+    orgSubscriptionStartDate?: (number|Long|null);
 }
 
 /** Represents an EapCoverageDeleted. */
@@ -44057,6 +44095,9 @@ export class EapCoverageDeleted implements IEapCoverageDeleted {
     /** EapCoverageDeleted externalOrgId. */
     public externalOrgId: string;
 
+    /** EapCoverageDeleted orgSubscriptionStartDate. */
+    public orgSubscriptionStartDate: (number|Long);
+
     /**
      * Creates a new EapCoverageDeleted instance using the specified properties.
      * @param [properties] Properties to set
@@ -66814,6 +66855,234 @@ export class UserConsentUpdated implements IUserConsentUpdated {
     public toJSON(): { [k: string]: any };
 }
 
+/** Properties of a UserDeletionRequested. */
+export interface IUserDeletionRequested {
+
+    /** UserDeletionRequested requester */
+    requester?: (string|null);
+
+    /** UserDeletionRequested timestamp */
+    timestamp?: (number|Long|null);
+
+    /** UserDeletionRequested deleteReason */
+    deleteReason?: (userdomain.users.UserDeleteReason|null);
+
+    /** UserDeletionRequested appClient */
+    appClient?: (UserServiceAppClient|null);
+}
+
+/**
+ * Sent when a user requests their account to be deleted.
+ *
+ * Ex: If a user has outstanding balances on their account, the deletion request can be revoked
+ * if the issue is not resolved within 15 days.
+ *
+ * Workflow: UserDeletionRequested -> UserDeletionRevoked (If needed) -> UserDeleted
+ */
+export class UserDeletionRequested implements IUserDeletionRequested {
+
+    /**
+     * Constructs a new UserDeletionRequested.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: IUserDeletionRequested);
+
+    /** UserDeletionRequested requester. */
+    public requester: string;
+
+    /** UserDeletionRequested timestamp. */
+    public timestamp: (number|Long);
+
+    /** UserDeletionRequested deleteReason. */
+    public deleteReason: userdomain.users.UserDeleteReason;
+
+    /** UserDeletionRequested appClient. */
+    public appClient: UserServiceAppClient;
+
+    /**
+     * Creates a new UserDeletionRequested instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns UserDeletionRequested instance
+     */
+    public static create(properties?: IUserDeletionRequested): UserDeletionRequested;
+
+    /**
+     * Encodes the specified UserDeletionRequested message. Does not implicitly {@link UserDeletionRequested.verify|verify} messages.
+     * @param message UserDeletionRequested message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: IUserDeletionRequested, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified UserDeletionRequested message, length delimited. Does not implicitly {@link UserDeletionRequested.verify|verify} messages.
+     * @param message UserDeletionRequested message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: IUserDeletionRequested, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a UserDeletionRequested message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns UserDeletionRequested
+     * @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): UserDeletionRequested;
+
+    /**
+     * Decodes a UserDeletionRequested message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns UserDeletionRequested
+     * @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)): UserDeletionRequested;
+
+    /**
+     * Verifies a UserDeletionRequested 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 UserDeletionRequested message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns UserDeletionRequested
+     */
+    public static fromObject(object: { [k: string]: any }): UserDeletionRequested;
+
+    /**
+     * Creates a plain object from a UserDeletionRequested message. Also converts values to other types if specified.
+     * @param message UserDeletionRequested
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: UserDeletionRequested, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this UserDeletionRequested to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
+/** Properties of a UserDeletionRevoked. */
+export interface IUserDeletionRevoked {
+
+    /** UserDeletionRevoked hsUserId */
+    hsUserId?: (string|null);
+
+    /** UserDeletionRevoked timestamp */
+    timestamp?: (number|Long|null);
+}
+
+/**
+ * Sent when an administrative user revokes the deletion of a user account.
+ *
+ * Ex: If a user has outstanding balances on their account, the deletion request will be revoked
+ * if the issue is not resolved within 15 days.
+ */
+export class UserDeletionRevoked implements IUserDeletionRevoked {
+
+    /**
+     * Constructs a new UserDeletionRevoked.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: IUserDeletionRevoked);
+
+    /** UserDeletionRevoked hsUserId. */
+    public hsUserId: string;
+
+    /** UserDeletionRevoked timestamp. */
+    public timestamp: (number|Long);
+
+    /**
+     * Creates a new UserDeletionRevoked instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns UserDeletionRevoked instance
+     */
+    public static create(properties?: IUserDeletionRevoked): UserDeletionRevoked;
+
+    /**
+     * Encodes the specified UserDeletionRevoked message. Does not implicitly {@link UserDeletionRevoked.verify|verify} messages.
+     * @param message UserDeletionRevoked message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: IUserDeletionRevoked, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified UserDeletionRevoked message, length delimited. Does not implicitly {@link UserDeletionRevoked.verify|verify} messages.
+     * @param message UserDeletionRevoked message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: IUserDeletionRevoked, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a UserDeletionRevoked message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns UserDeletionRevoked
+     * @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): UserDeletionRevoked;
+
+    /**
+     * Decodes a UserDeletionRevoked message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns UserDeletionRevoked
+     * @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)): UserDeletionRevoked;
+
+    /**
+     * Verifies a UserDeletionRevoked 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 UserDeletionRevoked message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns UserDeletionRevoked
+     */
+    public static fromObject(object: { [k: string]: any }): UserDeletionRevoked;
+
+    /**
+     * Creates a plain object from a UserDeletionRevoked message. Also converts values to other types if specified.
+     * @param message UserDeletionRevoked
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: UserDeletionRevoked, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this UserDeletionRevoked to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
+/**
+ * User Deletion Request Origin
+ *
+ * A request from the compliance teams to provide the origin of the user deletion request
+ */
+export enum UserServiceAppClient {
+    USER_SERVICE_APP_CLIENT_UNKNOWN = 0,
+    USER_SERVICE_APP_CLIENT_HEADSPACE_APP = 1,
+    USER_SERVICE_APP_CLIENT_HEADSPACE_CARE_APP = 2,
+    USER_SERVICE_APP_CLIENT_CROCPIT = 3
+}
+
 /** Properties of a VirginPulseAccountLinked. */
 export interface IVirginPulseAccountLinked {