@headspace/protos-events 1.386.0 → 1.387.0

package/lib/index.d.ts

@@ -93,6 +93,34 @@ export namespace date {
     }
 }
 
+/** Namespace auth. */
+export namespace auth {
+
+    /** AuthClientPlatform enum. */
+    enum AuthClientPlatform {
+        AUTH_CLIENT_PLATFORM_UNKNOWN = 0,
+        AUTH_CLIENT_PLATFORM_WEB = 1,
+        AUTH_CLIENT_PLATFORM_IOS = 2,
+        AUTH_CLIENT_PLATFORM_ANDROID = 3,
+        AUTH_CLIENT_PLATFORM_ALEXA = 4,
+        AUTH_CLIENT_PLATFORM_GOOGLE_ASSISTANT = 5,
+        AUTH_CLIENT_PLATFORM_IOS_WATCH = 6
+    }
+
+    /** AuthClientApp enum. */
+    enum AuthClientApp {
+        AUTH_CLIENT_APP_UNKNOWN = 0,
+        AUTH_CLIENT_APP_HEADSPACE = 1,
+        AUTH_CLIENT_APP_GINGER = 2
+    }
+
+    /** AuthLoginTag enum. */
+    enum AuthLoginTag {
+        AUTH_LOGIN_TAG_UNKNOWN = 0,
+        AUTH_LOGIN_TAG_FIRST_LOGIN = 1
+    }
+}
+
 /** Namespace auth0. */
 export namespace auth0 {
 
@@ -30039,6 +30067,120 @@ export class AssetCreated implements IAssetCreated {
     public toJSON(): { [k: string]: any };
 }
 
+/** Properties of an AuthLoggedIn. */
+export interface IAuthLoggedIn {
+
+    /** HSUSER identifier */
+    userId?: (string|null);
+
+    /** epoch millis of login event */
+    timestamp?: (number|Long|null);
+
+    /** client application (e.g. headspace, ginger) */
+    app?: (auth.AuthClientApp|null);
+
+    /** client platform (e.g. ios, android, web) */
+    platform?: (auth.AuthClientPlatform|null);
+
+    /** tags for the login event */
+    tags?: (auth.AuthLoginTag[]|null);
+}
+
+/** Signals that a user logged in */
+export class AuthLoggedIn implements IAuthLoggedIn {
+
+    /**
+     * Constructs a new AuthLoggedIn.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: IAuthLoggedIn);
+
+    /** HSUSER identifier */
+    public userId: string;
+
+    /** epoch millis of login event */
+    public timestamp: (number|Long);
+
+    /** client application (e.g. headspace, ginger) */
+    public app: auth.AuthClientApp;
+
+    /** client platform (e.g. ios, android, web) */
+    public platform: auth.AuthClientPlatform;
+
+    /** tags for the login event */
+    public tags: auth.AuthLoginTag[];
+
+    /**
+     * Creates a new AuthLoggedIn instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns AuthLoggedIn instance
+     */
+    public static create(properties?: IAuthLoggedIn): AuthLoggedIn;
+
+    /**
+     * Encodes the specified AuthLoggedIn message. Does not implicitly {@link AuthLoggedIn.verify|verify} messages.
+     * @param message AuthLoggedIn message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: IAuthLoggedIn, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified AuthLoggedIn message, length delimited. Does not implicitly {@link AuthLoggedIn.verify|verify} messages.
+     * @param message AuthLoggedIn message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: IAuthLoggedIn, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes an AuthLoggedIn message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns AuthLoggedIn
+     * @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): AuthLoggedIn;
+
+    /**
+     * Decodes an AuthLoggedIn message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns AuthLoggedIn
+     * @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)): AuthLoggedIn;
+
+    /**
+     * Verifies an AuthLoggedIn 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 an AuthLoggedIn message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns AuthLoggedIn
+     */
+    public static fromObject(object: { [k: string]: any }): AuthLoggedIn;
+
+    /**
+     * Creates a plain object from an AuthLoggedIn message. Also converts values to other types if specified.
+     * @param message AuthLoggedIn
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: AuthLoggedIn, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this AuthLoggedIn to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
 /** Properties of an OrganizationCreated. */
 export interface IOrganizationCreated {
 

package/lib/index.js

@@ -222,6 +222,72 @@ $root.date = (function() {
     return date;
 })();
 
+$root.auth = (function() {
+
+    /**
+     * Namespace auth.
+     * @exports auth
+     * @namespace
+     */
+    var auth = {};
+
+    /**
+     * AuthClientPlatform enum.
+     * @name auth.AuthClientPlatform
+     * @enum {string}
+     * @property {number} AUTH_CLIENT_PLATFORM_UNKNOWN=0 AUTH_CLIENT_PLATFORM_UNKNOWN value
+     * @property {number} AUTH_CLIENT_PLATFORM_WEB=1 AUTH_CLIENT_PLATFORM_WEB value
+     * @property {number} AUTH_CLIENT_PLATFORM_IOS=2 AUTH_CLIENT_PLATFORM_IOS value
+     * @property {number} AUTH_CLIENT_PLATFORM_ANDROID=3 AUTH_CLIENT_PLATFORM_ANDROID value
+     * @property {number} AUTH_CLIENT_PLATFORM_ALEXA=4 AUTH_CLIENT_PLATFORM_ALEXA value
+     * @property {number} AUTH_CLIENT_PLATFORM_GOOGLE_ASSISTANT=5 AUTH_CLIENT_PLATFORM_GOOGLE_ASSISTANT value
+     * @property {number} AUTH_CLIENT_PLATFORM_IOS_WATCH=6 AUTH_CLIENT_PLATFORM_IOS_WATCH value
+     */
+    auth.AuthClientPlatform = (function() {
+        var valuesById = {}, values = Object.create(valuesById);
+        values[valuesById[0] = "AUTH_CLIENT_PLATFORM_UNKNOWN"] = 0;
+        values[valuesById[1] = "AUTH_CLIENT_PLATFORM_WEB"] = 1;
+        values[valuesById[2] = "AUTH_CLIENT_PLATFORM_IOS"] = 2;
+        values[valuesById[3] = "AUTH_CLIENT_PLATFORM_ANDROID"] = 3;
+        values[valuesById[4] = "AUTH_CLIENT_PLATFORM_ALEXA"] = 4;
+        values[valuesById[5] = "AUTH_CLIENT_PLATFORM_GOOGLE_ASSISTANT"] = 5;
+        values[valuesById[6] = "AUTH_CLIENT_PLATFORM_IOS_WATCH"] = 6;
+        return values;
+    })();
+
+    /**
+     * AuthClientApp enum.
+     * @name auth.AuthClientApp
+     * @enum {string}
+     * @property {number} AUTH_CLIENT_APP_UNKNOWN=0 AUTH_CLIENT_APP_UNKNOWN value
+     * @property {number} AUTH_CLIENT_APP_HEADSPACE=1 AUTH_CLIENT_APP_HEADSPACE value
+     * @property {number} AUTH_CLIENT_APP_GINGER=2 AUTH_CLIENT_APP_GINGER value
+     */
+    auth.AuthClientApp = (function() {
+        var valuesById = {}, values = Object.create(valuesById);
+        values[valuesById[0] = "AUTH_CLIENT_APP_UNKNOWN"] = 0;
+        values[valuesById[1] = "AUTH_CLIENT_APP_HEADSPACE"] = 1;
+        values[valuesById[2] = "AUTH_CLIENT_APP_GINGER"] = 2;
+        return values;
+    })();
+
+    /**
+     * AuthLoginTag enum.
+     * @name auth.AuthLoginTag
+     * @enum {string}
+     * @property {number} AUTH_LOGIN_TAG_UNKNOWN=0 AUTH_LOGIN_TAG_UNKNOWN value
+     * @property {number} AUTH_LOGIN_TAG_FIRST_LOGIN=1 AUTH_LOGIN_TAG_FIRST_LOGIN value
+     */
+    auth.AuthLoginTag = (function() {
+        var valuesById = {}, values = Object.create(valuesById);
+        values[valuesById[0] = "AUTH_LOGIN_TAG_UNKNOWN"] = 0;
+        values[valuesById[1] = "AUTH_LOGIN_TAG_FIRST_LOGIN"] = 1;
+        return values;
+    })();
+
+    return auth;
+})();
+
 $root.auth0 = (function() {
 
     /**
@@ -83677,6 +83743,392 @@ $root.AssetCreated = (function() {
     return AssetCreated;
 })();
 
+$root.AuthLoggedIn = (function() {
+
+    /**
+     * Properties of an AuthLoggedIn.
+     * @exports IAuthLoggedIn
+     * @interface IAuthLoggedIn
+     * @property {string|null} [userId] HSUSER identifier
+     * @property {number|Long|null} [timestamp] epoch millis of login event
+     * @property {auth.AuthClientApp|null} [app] client application (e.g. headspace, ginger)
+     * @property {auth.AuthClientPlatform|null} [platform] client platform (e.g. ios, android, web)
+     * @property {Array.<auth.AuthLoginTag>|null} [tags] tags for the login event
+     */
+
+    /**
+     * Constructs a new AuthLoggedIn.
+     * @exports AuthLoggedIn
+     * @classdesc Signals that a user logged in
+     * @implements IAuthLoggedIn
+     * @constructor
+     * @param {IAuthLoggedIn=} [properties] Properties to set
+     */
+    function AuthLoggedIn(properties) {
+        this.tags = [];
+        if (properties)
+            for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
+                if (properties[keys[i]] != null)
+                    this[keys[i]] = properties[keys[i]];
+    }
+
+    /**
+     * HSUSER identifier
+     * @member {string} userId
+     * @memberof AuthLoggedIn
+     * @instance
+     */
+    AuthLoggedIn.prototype.userId = "";
+
+    /**
+     * epoch millis of login event
+     * @member {number|Long} timestamp
+     * @memberof AuthLoggedIn
+     * @instance
+     */
+    AuthLoggedIn.prototype.timestamp = $util.Long ? $util.Long.fromBits(0,0,true) : 0;
+
+    /**
+     * client application (e.g. headspace, ginger)
+     * @member {auth.AuthClientApp} app
+     * @memberof AuthLoggedIn
+     * @instance
+     */
+    AuthLoggedIn.prototype.app = 0;
+
+    /**
+     * client platform (e.g. ios, android, web)
+     * @member {auth.AuthClientPlatform} platform
+     * @memberof AuthLoggedIn
+     * @instance
+     */
+    AuthLoggedIn.prototype.platform = 0;
+
+    /**
+     * tags for the login event
+     * @member {Array.<auth.AuthLoginTag>} tags
+     * @memberof AuthLoggedIn
+     * @instance
+     */
+    AuthLoggedIn.prototype.tags = $util.emptyArray;
+
+    /**
+     * Creates a new AuthLoggedIn instance using the specified properties.
+     * @function create
+     * @memberof AuthLoggedIn
+     * @static
+     * @param {IAuthLoggedIn=} [properties] Properties to set
+     * @returns {AuthLoggedIn} AuthLoggedIn instance
+     */
+    AuthLoggedIn.create = function create(properties) {
+        return new AuthLoggedIn(properties);
+    };
+
+    /**
+     * Encodes the specified AuthLoggedIn message. Does not implicitly {@link AuthLoggedIn.verify|verify} messages.
+     * @function encode
+     * @memberof AuthLoggedIn
+     * @static
+     * @param {IAuthLoggedIn} message AuthLoggedIn message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    AuthLoggedIn.encode = function encode(message, writer) {
+        if (!writer)
+            writer = $Writer.create();
+        if (message.userId != null && message.hasOwnProperty("userId"))
+            writer.uint32(/* id 1, wireType 2 =*/10).string(message.userId);
+        if (message.timestamp != null && message.hasOwnProperty("timestamp"))
+            writer.uint32(/* id 2, wireType 0 =*/16).uint64(message.timestamp);
+        if (message.app != null && message.hasOwnProperty("app"))
+            writer.uint32(/* id 3, wireType 0 =*/24).int32(message.app);
+        if (message.platform != null && message.hasOwnProperty("platform"))
+            writer.uint32(/* id 4, wireType 0 =*/32).int32(message.platform);
+        if (message.tags != null && message.tags.length) {
+            writer.uint32(/* id 5, wireType 2 =*/42).fork();
+            for (var i = 0; i < message.tags.length; ++i)
+                writer.int32(message.tags[i]);
+            writer.ldelim();
+        }
+        return writer;
+    };
+
+    /**
+     * Encodes the specified AuthLoggedIn message, length delimited. Does not implicitly {@link AuthLoggedIn.verify|verify} messages.
+     * @function encodeDelimited
+     * @memberof AuthLoggedIn
+     * @static
+     * @param {IAuthLoggedIn} message AuthLoggedIn message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    AuthLoggedIn.encodeDelimited = function encodeDelimited(message, writer) {
+        return this.encode(message, writer).ldelim();
+    };
+
+    /**
+     * Decodes an AuthLoggedIn message from the specified reader or buffer.
+     * @function decode
+     * @memberof AuthLoggedIn
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @param {number} [length] Message length if known beforehand
+     * @returns {AuthLoggedIn} AuthLoggedIn
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    AuthLoggedIn.decode = function decode(reader, length) {
+        if (!(reader instanceof $Reader))
+            reader = $Reader.create(reader);
+        var end = length === undefined ? reader.len : reader.pos + length, message = new $root.AuthLoggedIn();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+            case 1:
+                message.userId = reader.string();
+                break;
+            case 2:
+                message.timestamp = reader.uint64();
+                break;
+            case 3:
+                message.app = reader.int32();
+                break;
+            case 4:
+                message.platform = reader.int32();
+                break;
+            case 5:
+                if (!(message.tags && message.tags.length))
+                    message.tags = [];
+                if ((tag & 7) === 2) {
+                    var end2 = reader.uint32() + reader.pos;
+                    while (reader.pos < end2)
+                        message.tags.push(reader.int32());
+                } else
+                    message.tags.push(reader.int32());
+                break;
+            default:
+                reader.skipType(tag & 7);
+                break;
+            }
+        }
+        return message;
+    };
+
+    /**
+     * Decodes an AuthLoggedIn message from the specified reader or buffer, length delimited.
+     * @function decodeDelimited
+     * @memberof AuthLoggedIn
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @returns {AuthLoggedIn} AuthLoggedIn
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    AuthLoggedIn.decodeDelimited = function decodeDelimited(reader) {
+        if (!(reader instanceof $Reader))
+            reader = new $Reader(reader);
+        return this.decode(reader, reader.uint32());
+    };
+
+    /**
+     * Verifies an AuthLoggedIn message.
+     * @function verify
+     * @memberof AuthLoggedIn
+     * @static
+     * @param {Object.<string,*>} message Plain object to verify
+     * @returns {string|null} `null` if valid, otherwise the reason why it is not
+     */
+    AuthLoggedIn.verify = function verify(message) {
+        if (typeof message !== "object" || message === null)
+            return "object expected";
+        if (message.userId != null && message.hasOwnProperty("userId"))
+            if (!$util.isString(message.userId))
+                return "userId: string expected";
+        if (message.timestamp != null && message.hasOwnProperty("timestamp"))
+            if (!$util.isInteger(message.timestamp) && !(message.timestamp && $util.isInteger(message.timestamp.low) && $util.isInteger(message.timestamp.high)))
+                return "timestamp: integer|Long expected";
+        if (message.app != null && message.hasOwnProperty("app"))
+            switch (message.app) {
+            default:
+                return "app: enum value expected";
+            case 0:
+            case 1:
+            case 2:
+                break;
+            }
+        if (message.platform != null && message.hasOwnProperty("platform"))
+            switch (message.platform) {
+            default:
+                return "platform: enum value expected";
+            case 0:
+            case 1:
+            case 2:
+            case 3:
+            case 4:
+            case 5:
+            case 6:
+                break;
+            }
+        if (message.tags != null && message.hasOwnProperty("tags")) {
+            if (!Array.isArray(message.tags))
+                return "tags: array expected";
+            for (var i = 0; i < message.tags.length; ++i)
+                switch (message.tags[i]) {
+                default:
+                    return "tags: enum value[] expected";
+                case 0:
+                case 1:
+                    break;
+                }
+        }
+        return null;
+    };
+
+    /**
+     * Creates an AuthLoggedIn message from a plain object. Also converts values to their respective internal types.
+     * @function fromObject
+     * @memberof AuthLoggedIn
+     * @static
+     * @param {Object.<string,*>} object Plain object
+     * @returns {AuthLoggedIn} AuthLoggedIn
+     */
+    AuthLoggedIn.fromObject = function fromObject(object) {
+        if (object instanceof $root.AuthLoggedIn)
+            return object;
+        var message = new $root.AuthLoggedIn();
+        if (object.userId != null)
+            message.userId = String(object.userId);
+        if (object.timestamp != null)
+            if ($util.Long)
+                (message.timestamp = $util.Long.fromValue(object.timestamp)).unsigned = true;
+            else if (typeof object.timestamp === "string")
+                message.timestamp = parseInt(object.timestamp, 10);
+            else if (typeof object.timestamp === "number")
+                message.timestamp = object.timestamp;
+            else if (typeof object.timestamp === "object")
+                message.timestamp = new $util.LongBits(object.timestamp.low >>> 0, object.timestamp.high >>> 0).toNumber(true);
+        switch (object.app) {
+        case "AUTH_CLIENT_APP_UNKNOWN":
+        case 0:
+            message.app = 0;
+            break;
+        case "AUTH_CLIENT_APP_HEADSPACE":
+        case 1:
+            message.app = 1;
+            break;
+        case "AUTH_CLIENT_APP_GINGER":
+        case 2:
+            message.app = 2;
+            break;
+        }
+        switch (object.platform) {
+        case "AUTH_CLIENT_PLATFORM_UNKNOWN":
+        case 0:
+            message.platform = 0;
+            break;
+        case "AUTH_CLIENT_PLATFORM_WEB":
+        case 1:
+            message.platform = 1;
+            break;
+        case "AUTH_CLIENT_PLATFORM_IOS":
+        case 2:
+            message.platform = 2;
+            break;
+        case "AUTH_CLIENT_PLATFORM_ANDROID":
+        case 3:
+            message.platform = 3;
+            break;
+        case "AUTH_CLIENT_PLATFORM_ALEXA":
+        case 4:
+            message.platform = 4;
+            break;
+        case "AUTH_CLIENT_PLATFORM_GOOGLE_ASSISTANT":
+        case 5:
+            message.platform = 5;
+            break;
+        case "AUTH_CLIENT_PLATFORM_IOS_WATCH":
+        case 6:
+            message.platform = 6;
+            break;
+        }
+        if (object.tags) {
+            if (!Array.isArray(object.tags))
+                throw TypeError(".AuthLoggedIn.tags: array expected");
+            message.tags = [];
+            for (var i = 0; i < object.tags.length; ++i)
+                switch (object.tags[i]) {
+                default:
+                case "AUTH_LOGIN_TAG_UNKNOWN":
+                case 0:
+                    message.tags[i] = 0;
+                    break;
+                case "AUTH_LOGIN_TAG_FIRST_LOGIN":
+                case 1:
+                    message.tags[i] = 1;
+                    break;
+                }
+        }
+        return message;
+    };
+
+    /**
+     * Creates a plain object from an AuthLoggedIn message. Also converts values to other types if specified.
+     * @function toObject
+     * @memberof AuthLoggedIn
+     * @static
+     * @param {AuthLoggedIn} message AuthLoggedIn
+     * @param {$protobuf.IConversionOptions} [options] Conversion options
+     * @returns {Object.<string,*>} Plain object
+     */
+    AuthLoggedIn.toObject = function toObject(message, options) {
+        if (!options)
+            options = {};
+        var object = {};
+        if (options.arrays || options.defaults)
+            object.tags = [];
+        if (options.defaults) {
+            object.userId = "";
+            if ($util.Long) {
+                var long = new $util.Long(0, 0, true);
+                object.timestamp = options.longs === String ? long.toString() : options.longs === Number ? long.toNumber() : long;
+            } else
+                object.timestamp = options.longs === String ? "0" : 0;
+            object.app = options.enums === String ? "AUTH_CLIENT_APP_UNKNOWN" : 0;
+            object.platform = options.enums === String ? "AUTH_CLIENT_PLATFORM_UNKNOWN" : 0;
+        }
+        if (message.userId != null && message.hasOwnProperty("userId"))
+            object.userId = message.userId;
+        if (message.timestamp != null && message.hasOwnProperty("timestamp"))
+            if (typeof message.timestamp === "number")
+                object.timestamp = options.longs === String ? String(message.timestamp) : message.timestamp;
+            else
+                object.timestamp = options.longs === String ? $util.Long.prototype.toString.call(message.timestamp) : options.longs === Number ? new $util.LongBits(message.timestamp.low >>> 0, message.timestamp.high >>> 0).toNumber(true) : message.timestamp;
+        if (message.app != null && message.hasOwnProperty("app"))
+            object.app = options.enums === String ? $root.auth.AuthClientApp[message.app] : message.app;
+        if (message.platform != null && message.hasOwnProperty("platform"))
+            object.platform = options.enums === String ? $root.auth.AuthClientPlatform[message.platform] : message.platform;
+        if (message.tags && message.tags.length) {
+            object.tags = [];
+            for (var j = 0; j < message.tags.length; ++j)
+                object.tags[j] = options.enums === String ? $root.auth.AuthLoginTag[message.tags[j]] : message.tags[j];
+        }
+        return object;
+    };
+
+    /**
+     * Converts this AuthLoggedIn to JSON.
+     * @function toJSON
+     * @memberof AuthLoggedIn
+     * @instance
+     * @returns {Object.<string,*>} JSON object
+     */
+    AuthLoggedIn.prototype.toJSON = function toJSON() {
+        return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
+    };
+
+    return AuthLoggedIn;
+})();
+
 $root.OrganizationCreated = (function() {
 
     /**

package/package.json

@@ -16,5 +16,5 @@
   "main": "lib/index.js",
   "name": "@headspace/protos-events",
   "typings": "lib/index.d.ts",
-  "version": "1.386.0"
+  "version": "1.387.0"
 }