@headspace/protos-events 1.788.0 → 1.790.0

package/lib/index.d.ts

@@ -15229,6 +15229,379 @@ export class MemberDeactivationStarted implements IMemberDeactivationStarted {
     public toJSON(): { [k: string]: any };
 }
 
+/** CareService enum. */
+export enum CareService {
+    CARE_SERVICE_UNKNOWN = 0,
+    CARE_SERVICE_COACHING = 1,
+    CARE_SERVICE_THERAPY = 2,
+    CARE_SERVICE_PSYCHIATRY = 3
+}
+
+/** SessionType enum. */
+export enum SessionType {
+    SESSION_TYPE_UNKNOWN = 0,
+    SESSION_TYPE_INTAKE = 1,
+    SESSION_TYPE_FOLLOW_UP = 2,
+    SESSION_TYPE_SI = 3,
+    SESSION_TYPE_DROP_IN = 4
+}
+
+/** SessionFormat enum. */
+export enum SessionFormat {
+    SESSION_FORMAT_UNKNOWN = 0,
+    SESSION_FORMAT_CHAT = 1,
+    SESSION_FORMAT_VIDEO = 2
+}
+
+/** Properties of a CareSessionCompleted. */
+export interface ICareSessionCompleted {
+
+    /** CareSessionCompleted eventDetail */
+    eventDetail?: (IEventDetail|null);
+
+    /** CareSessionCompleted hsUserId */
+    hsUserId?: (string|null);
+
+    /** CareSessionCompleted listenerId */
+    listenerId?: (number|Long|null);
+
+    /** CareSessionCompleted sessionId */
+    sessionId?: (number|Long|null);
+
+    /** CareSessionCompleted careService */
+    careService?: (CareService|null);
+
+    /** CareSessionCompleted sessionType */
+    sessionType?: (SessionType|null);
+
+    /** CareSessionCompleted sessionFormat */
+    sessionFormat?: (SessionFormat|null);
+
+    /** CareSessionCompleted isScheduled */
+    isScheduled?: (boolean|null);
+
+    /** CareSessionCompleted startTimestamp */
+    startTimestamp?: (number|Long|null);
+
+    /** CareSessionCompleted startTimestampIso */
+    startTimestampIso?: (string|null);
+
+    /** CareSessionCompleted engagementTimestamp */
+    engagementTimestamp?: (number|Long|null);
+
+    /** CareSessionCompleted engagementTimestampIso */
+    engagementTimestampIso?: (string|null);
+
+    /** CareSessionCompleted endTimestamp */
+    endTimestamp?: (number|Long|null);
+
+    /** CareSessionCompleted endTimestampIso */
+    endTimestampIso?: (string|null);
+
+    /** CareSessionCompleted endedGingerUserId */
+    endedGingerUserId?: (string|null);
+}
+
+/** Represents a CareSessionCompleted. */
+export class CareSessionCompleted implements ICareSessionCompleted {
+
+    /**
+     * Constructs a new CareSessionCompleted.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: ICareSessionCompleted);
+
+    /** CareSessionCompleted eventDetail. */
+    public eventDetail?: (IEventDetail|null);
+
+    /** CareSessionCompleted hsUserId. */
+    public hsUserId: string;
+
+    /** CareSessionCompleted listenerId. */
+    public listenerId: (number|Long);
+
+    /** CareSessionCompleted sessionId. */
+    public sessionId: (number|Long);
+
+    /** CareSessionCompleted careService. */
+    public careService: CareService;
+
+    /** CareSessionCompleted sessionType. */
+    public sessionType: SessionType;
+
+    /** CareSessionCompleted sessionFormat. */
+    public sessionFormat: SessionFormat;
+
+    /** CareSessionCompleted isScheduled. */
+    public isScheduled: boolean;
+
+    /** CareSessionCompleted startTimestamp. */
+    public startTimestamp: (number|Long);
+
+    /** CareSessionCompleted startTimestampIso. */
+    public startTimestampIso: string;
+
+    /** CareSessionCompleted engagementTimestamp. */
+    public engagementTimestamp: (number|Long);
+
+    /** CareSessionCompleted engagementTimestampIso. */
+    public engagementTimestampIso: string;
+
+    /** CareSessionCompleted endTimestamp. */
+    public endTimestamp: (number|Long);
+
+    /** CareSessionCompleted endTimestampIso. */
+    public endTimestampIso: string;
+
+    /** CareSessionCompleted endedGingerUserId. */
+    public endedGingerUserId: string;
+
+    /**
+     * Creates a new CareSessionCompleted instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns CareSessionCompleted instance
+     */
+    public static create(properties?: ICareSessionCompleted): CareSessionCompleted;
+
+    /**
+     * Encodes the specified CareSessionCompleted message. Does not implicitly {@link CareSessionCompleted.verify|verify} messages.
+     * @param message CareSessionCompleted message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: ICareSessionCompleted, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified CareSessionCompleted message, length delimited. Does not implicitly {@link CareSessionCompleted.verify|verify} messages.
+     * @param message CareSessionCompleted message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: ICareSessionCompleted, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a CareSessionCompleted message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns CareSessionCompleted
+     * @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): CareSessionCompleted;
+
+    /**
+     * Decodes a CareSessionCompleted message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns CareSessionCompleted
+     * @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)): CareSessionCompleted;
+
+    /**
+     * Verifies a CareSessionCompleted 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 CareSessionCompleted message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns CareSessionCompleted
+     */
+    public static fromObject(object: { [k: string]: any }): CareSessionCompleted;
+
+    /**
+     * Creates a plain object from a CareSessionCompleted message. Also converts values to other types if specified.
+     * @param message CareSessionCompleted
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: CareSessionCompleted, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this CareSessionCompleted to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
+/** CareAvailabilityType enum. */
+export enum CareAvailabilityType {
+    CARE_AVAILABILITY_TYPE_UNKNOWN = 0,
+    CARE_AVAILABILITY_TYPE_CHAT = 1,
+    CARE_AVAILABILITY_TYPE_VIDEO = 2
+}
+
+/** Properties of a CareAvailabilityOffered. */
+export interface ICareAvailabilityOffered {
+
+    /** CareAvailabilityOffered listenerId */
+    listenerId?: (number|Long|null);
+
+    /** CareAvailabilityOffered careWebUserId */
+    careWebUserId?: (string|null);
+
+    /** CareAvailabilityOffered hsUserId */
+    hsUserId?: (string|null);
+
+    /** CareAvailabilityOffered careService */
+    careService?: (CareService|null);
+
+    /** CareAvailabilityOffered availabilityType */
+    availabilityType?: (CareAvailabilityType|null);
+
+    /** CareAvailabilityOffered searchStart */
+    searchStart?: (number|Long|null);
+
+    /** CareAvailabilityOffered searchEnd */
+    searchEnd?: (number|Long|null);
+
+    /** CareAvailabilityOffered availabilitySlotCount */
+    availabilitySlotCount?: (number|null);
+
+    /** CareAvailabilityOffered earliestAvailability */
+    earliestAvailability?: (number|Long|null);
+
+    /** CareAvailabilityOffered earliestAvailabilityIso */
+    earliestAvailabilityIso?: (string|null);
+
+    /** CareAvailabilityOffered earliestAvailabilityHoursAhead */
+    earliestAvailabilityHoursAhead?: (number|null);
+
+    /** CareAvailabilityOffered latestAvailability */
+    latestAvailability?: (number|Long|null);
+
+    /** CareAvailabilityOffered latestAvailabilityIso */
+    latestAvailabilityIso?: (string|null);
+
+    /** CareAvailabilityOffered latestAvailabilityHoursAhead */
+    latestAvailabilityHoursAhead?: (number|null);
+}
+
+/** Represents a CareAvailabilityOffered. */
+export class CareAvailabilityOffered implements ICareAvailabilityOffered {
+
+    /**
+     * Constructs a new CareAvailabilityOffered.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: ICareAvailabilityOffered);
+
+    /** CareAvailabilityOffered listenerId. */
+    public listenerId: (number|Long);
+
+    /** CareAvailabilityOffered careWebUserId. */
+    public careWebUserId: string;
+
+    /** CareAvailabilityOffered hsUserId. */
+    public hsUserId: string;
+
+    /** CareAvailabilityOffered careService. */
+    public careService: CareService;
+
+    /** CareAvailabilityOffered availabilityType. */
+    public availabilityType: CareAvailabilityType;
+
+    /** CareAvailabilityOffered searchStart. */
+    public searchStart: (number|Long);
+
+    /** CareAvailabilityOffered searchEnd. */
+    public searchEnd: (number|Long);
+
+    /** CareAvailabilityOffered availabilitySlotCount. */
+    public availabilitySlotCount: number;
+
+    /** CareAvailabilityOffered earliestAvailability. */
+    public earliestAvailability: (number|Long);
+
+    /** CareAvailabilityOffered earliestAvailabilityIso. */
+    public earliestAvailabilityIso: string;
+
+    /** CareAvailabilityOffered earliestAvailabilityHoursAhead. */
+    public earliestAvailabilityHoursAhead: number;
+
+    /** CareAvailabilityOffered latestAvailability. */
+    public latestAvailability: (number|Long);
+
+    /** CareAvailabilityOffered latestAvailabilityIso. */
+    public latestAvailabilityIso: string;
+
+    /** CareAvailabilityOffered latestAvailabilityHoursAhead. */
+    public latestAvailabilityHoursAhead: number;
+
+    /**
+     * Creates a new CareAvailabilityOffered instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns CareAvailabilityOffered instance
+     */
+    public static create(properties?: ICareAvailabilityOffered): CareAvailabilityOffered;
+
+    /**
+     * Encodes the specified CareAvailabilityOffered message. Does not implicitly {@link CareAvailabilityOffered.verify|verify} messages.
+     * @param message CareAvailabilityOffered message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: ICareAvailabilityOffered, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified CareAvailabilityOffered message, length delimited. Does not implicitly {@link CareAvailabilityOffered.verify|verify} messages.
+     * @param message CareAvailabilityOffered message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: ICareAvailabilityOffered, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a CareAvailabilityOffered message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns CareAvailabilityOffered
+     * @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): CareAvailabilityOffered;
+
+    /**
+     * Decodes a CareAvailabilityOffered message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns CareAvailabilityOffered
+     * @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)): CareAvailabilityOffered;
+
+    /**
+     * Verifies a CareAvailabilityOffered 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 CareAvailabilityOffered message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns CareAvailabilityOffered
+     */
+    public static fromObject(object: { [k: string]: any }): CareAvailabilityOffered;
+
+    /**
+     * Creates a plain object from a CareAvailabilityOffered message. Also converts values to other types if specified.
+     * @param message CareAvailabilityOffered
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: CareAvailabilityOffered, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this CareAvailabilityOffered to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
 /** CostShareType enum. */
 export enum CostShareType {
     COST_SHARE_TYPE_UNKNOWN = 0,
@@ -51688,6 +52061,120 @@ export class PartnerEventUpdated implements IPartnerEventUpdated {
     public toJSON(): { [k: string]: any };
 }
 
+/** Properties of a PartnerSignalStateAssigned. */
+export interface IPartnerSignalStateAssigned {
+
+    /** Unique identifier of the partner (from PAPI service). Formatted as a 24-char hex string. */
+    partnerId?: (string|null);
+
+    /** Name of the partner. */
+    partnerName?: (string|null);
+
+    /** Assigned signal. */
+    signal?: (string|null);
+
+    /** Headspace user that was assigned the signal (e.g. HSUSER_FOOBAR). */
+    hsUserId?: (string|null);
+
+    /** UTC epoch milliseconds - when the signal was assigned. */
+    createdAtTimestamp?: (number|Long|null);
+}
+
+/** Represents a PartnerSignalStateAssigned. */
+export class PartnerSignalStateAssigned implements IPartnerSignalStateAssigned {
+
+    /**
+     * Constructs a new PartnerSignalStateAssigned.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: IPartnerSignalStateAssigned);
+
+    /** Unique identifier of the partner (from PAPI service). Formatted as a 24-char hex string. */
+    public partnerId: string;
+
+    /** Name of the partner. */
+    public partnerName: string;
+
+    /** Assigned signal. */
+    public signal: string;
+
+    /** Headspace user that was assigned the signal (e.g. HSUSER_FOOBAR). */
+    public hsUserId: string;
+
+    /** UTC epoch milliseconds - when the signal was assigned. */
+    public createdAtTimestamp: (number|Long);
+
+    /**
+     * Creates a new PartnerSignalStateAssigned instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns PartnerSignalStateAssigned instance
+     */
+    public static create(properties?: IPartnerSignalStateAssigned): PartnerSignalStateAssigned;
+
+    /**
+     * Encodes the specified PartnerSignalStateAssigned message. Does not implicitly {@link PartnerSignalStateAssigned.verify|verify} messages.
+     * @param message PartnerSignalStateAssigned message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: IPartnerSignalStateAssigned, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified PartnerSignalStateAssigned message, length delimited. Does not implicitly {@link PartnerSignalStateAssigned.verify|verify} messages.
+     * @param message PartnerSignalStateAssigned message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: IPartnerSignalStateAssigned, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a PartnerSignalStateAssigned message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns PartnerSignalStateAssigned
+     * @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): PartnerSignalStateAssigned;
+
+    /**
+     * Decodes a PartnerSignalStateAssigned message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns PartnerSignalStateAssigned
+     * @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)): PartnerSignalStateAssigned;
+
+    /**
+     * Verifies a PartnerSignalStateAssigned 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 PartnerSignalStateAssigned message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns PartnerSignalStateAssigned
+     */
+    public static fromObject(object: { [k: string]: any }): PartnerSignalStateAssigned;
+
+    /**
+     * Creates a plain object from a PartnerSignalStateAssigned message. Also converts values to other types if specified.
+     * @param message PartnerSignalStateAssigned
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: PartnerSignalStateAssigned, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this PartnerSignalStateAssigned to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
 /** Properties of a PHQAssessmentAssigned. */
 export interface IPHQAssessmentAssigned {