@headspace/protos-events 1.725.0 → 1.727.0

package/lib/index.d.ts

@@ -46197,6 +46197,144 @@ export enum OrgCoverageEapCarrier {
     ORG_COVERAGE_EAP_CARRIER_NONE = 4
 }
 
+/** Properties of a PartnerRedemptionRevoked. */
+export interface IPartnerRedemptionRevoked {
+
+    /** Unique identifier for the redemption. Formatted as a 24-char hex string. */
+    redemptionId?: (string|null);
+
+    /**
+     * Redemption reference identifier provided by the partner. Partners are not supposed to put any PII in this field,
+     * but we cannot enforce it. Thus, this field _may contain_ sensitive information.
+     */
+    redemptionRef?: (string|null);
+
+    /** Access-code used for the redemption. Provided by the 'access-code' service. */
+    redemptionCode?: (string|null);
+
+    /**
+     * Partner package identifier. Packages contain information what is being given to members redeeming a subscription
+     * through the partner and are tied a single product sku. Formatted as a 24-char hex string.
+     */
+    partnerPackageId?: (string|null);
+
+    /** Unique identifier of the partner. Formatted as a 24-char hex string */
+    partnerId?: (string|null);
+
+    /** Headspace user associated to the redemption, (e.g. HSUSER_FOOBAR) */
+    hsUserId?: (string|null);
+
+    /** UTC epoch milliseconds - when the redemption was revoked. */
+    revokedAt?: (number|Long|null);
+}
+
+/** Represents a PartnerRedemptionRevoked. */
+export class PartnerRedemptionRevoked implements IPartnerRedemptionRevoked {
+
+    /**
+     * Constructs a new PartnerRedemptionRevoked.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: IPartnerRedemptionRevoked);
+
+    /** Unique identifier for the redemption. Formatted as a 24-char hex string. */
+    public redemptionId: string;
+
+    /**
+     * Redemption reference identifier provided by the partner. Partners are not supposed to put any PII in this field,
+     * but we cannot enforce it. Thus, this field _may contain_ sensitive information.
+     */
+    public redemptionRef: string;
+
+    /** Access-code used for the redemption. Provided by the 'access-code' service. */
+    public redemptionCode: string;
+
+    /**
+     * Partner package identifier. Packages contain information what is being given to members redeeming a subscription
+     * through the partner and are tied a single product sku. Formatted as a 24-char hex string.
+     */
+    public partnerPackageId: string;
+
+    /** Unique identifier of the partner. Formatted as a 24-char hex string */
+    public partnerId: string;
+
+    /** Headspace user associated to the redemption, (e.g. HSUSER_FOOBAR) */
+    public hsUserId: string;
+
+    /** UTC epoch milliseconds - when the redemption was revoked. */
+    public revokedAt: (number|Long);
+
+    /**
+     * Creates a new PartnerRedemptionRevoked instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns PartnerRedemptionRevoked instance
+     */
+    public static create(properties?: IPartnerRedemptionRevoked): PartnerRedemptionRevoked;
+
+    /**
+     * Encodes the specified PartnerRedemptionRevoked message. Does not implicitly {@link PartnerRedemptionRevoked.verify|verify} messages.
+     * @param message PartnerRedemptionRevoked message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: IPartnerRedemptionRevoked, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified PartnerRedemptionRevoked message, length delimited. Does not implicitly {@link PartnerRedemptionRevoked.verify|verify} messages.
+     * @param message PartnerRedemptionRevoked message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: IPartnerRedemptionRevoked, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a PartnerRedemptionRevoked message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns PartnerRedemptionRevoked
+     * @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): PartnerRedemptionRevoked;
+
+    /**
+     * Decodes a PartnerRedemptionRevoked message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns PartnerRedemptionRevoked
+     * @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)): PartnerRedemptionRevoked;
+
+    /**
+     * Verifies a PartnerRedemptionRevoked 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 PartnerRedemptionRevoked message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns PartnerRedemptionRevoked
+     */
+    public static fromObject(object: { [k: string]: any }): PartnerRedemptionRevoked;
+
+    /**
+     * Creates a plain object from a PartnerRedemptionRevoked message. Also converts values to other types if specified.
+     * @param message PartnerRedemptionRevoked
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: PartnerRedemptionRevoked, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this PartnerRedemptionRevoked to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
 /** Properties of a WakeupPlaylistCreated. */
 export interface IWakeupPlaylistCreated {
 
@@ -70839,8 +70977,7 @@ export namespace productcatalog {
         PLATFORM_SPOTIFY = 4,
         PLATFORM_ZUORA = 5,
         PLATFORM_B2B_ORG = 6,
-        PRODUCT_SKU_PLATFORM_SIKA = 7,
-        PRODUCT_SKU_PLATFORM_PAPI = 8
+        PRODUCT_SKU_PLATFORM_SIKA = 7
     }
 
     /** ProductSkuBillingCategory enum. */

package/lib/index.js

@@ -131920,6 +131920,344 @@ $root.OrgCoverageEapCarrier = (function() {
     return values;
 })();
 
+$root.PartnerRedemptionRevoked = (function() {
+
+    /**
+     * Properties of a PartnerRedemptionRevoked.
+     * @name IPartnerRedemptionRevoked
+     * @interface IPartnerRedemptionRevoked
+     * @property {string|null} [redemptionId] Unique identifier for the redemption. Formatted as a 24-char hex string.
+     * @property {string|null} [redemptionRef] Redemption reference identifier provided by the partner. Partners are not supposed to put any PII in this field,
+     * but we cannot enforce it. Thus, this field _may contain_ sensitive information.
+     * @property {string|null} [redemptionCode] Access-code used for the redemption. Provided by the 'access-code' service.
+     * @property {string|null} [partnerPackageId] Partner package identifier. Packages contain information what is being given to members redeeming a subscription
+     * through the partner and are tied a single product sku. Formatted as a 24-char hex string.
+     * @property {string|null} [partnerId] Unique identifier of the partner. Formatted as a 24-char hex string
+     * @property {string|null} [hsUserId] Headspace user associated to the redemption, (e.g. HSUSER_FOOBAR)
+     * @property {number|Long|null} [revokedAt] UTC epoch milliseconds - when the redemption was revoked.
+     */
+
+    /**
+     * Constructs a new PartnerRedemptionRevoked.
+     * @name PartnerRedemptionRevoked
+     * @classdesc Represents a PartnerRedemptionRevoked.
+     * @implements IPartnerRedemptionRevoked
+     * @constructor
+     * @param {IPartnerRedemptionRevoked=} [properties] Properties to set
+     */
+    function PartnerRedemptionRevoked(properties) {
+        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]];
+    }
+
+    /**
+     * Unique identifier for the redemption. Formatted as a 24-char hex string.
+     * @member {string} redemptionId
+     * @memberof PartnerRedemptionRevoked
+     * @instance
+     */
+    PartnerRedemptionRevoked.prototype.redemptionId = "";
+
+    /**
+     * Redemption reference identifier provided by the partner. Partners are not supposed to put any PII in this field,
+     * but we cannot enforce it. Thus, this field _may contain_ sensitive information.
+     * @member {string} redemptionRef
+     * @memberof PartnerRedemptionRevoked
+     * @instance
+     */
+    PartnerRedemptionRevoked.prototype.redemptionRef = "";
+
+    /**
+     * Access-code used for the redemption. Provided by the 'access-code' service.
+     * @member {string} redemptionCode
+     * @memberof PartnerRedemptionRevoked
+     * @instance
+     */
+    PartnerRedemptionRevoked.prototype.redemptionCode = "";
+
+    /**
+     * Partner package identifier. Packages contain information what is being given to members redeeming a subscription
+     * through the partner and are tied a single product sku. Formatted as a 24-char hex string.
+     * @member {string} partnerPackageId
+     * @memberof PartnerRedemptionRevoked
+     * @instance
+     */
+    PartnerRedemptionRevoked.prototype.partnerPackageId = "";
+
+    /**
+     * Unique identifier of the partner. Formatted as a 24-char hex string
+     * @member {string} partnerId
+     * @memberof PartnerRedemptionRevoked
+     * @instance
+     */
+    PartnerRedemptionRevoked.prototype.partnerId = "";
+
+    /**
+     * Headspace user associated to the redemption, (e.g. HSUSER_FOOBAR)
+     * @member {string} hsUserId
+     * @memberof PartnerRedemptionRevoked
+     * @instance
+     */
+    PartnerRedemptionRevoked.prototype.hsUserId = "";
+
+    /**
+     * UTC epoch milliseconds - when the redemption was revoked.
+     * @member {number|Long} revokedAt
+     * @memberof PartnerRedemptionRevoked
+     * @instance
+     */
+    PartnerRedemptionRevoked.prototype.revokedAt = $util.Long ? $util.Long.fromBits(0,0,true) : 0;
+
+    /**
+     * Creates a new PartnerRedemptionRevoked instance using the specified properties.
+     * @function create
+     * @memberof PartnerRedemptionRevoked
+     * @static
+     * @param {IPartnerRedemptionRevoked=} [properties] Properties to set
+     * @returns {PartnerRedemptionRevoked} PartnerRedemptionRevoked instance
+     */
+    PartnerRedemptionRevoked.create = function create(properties) {
+        return new PartnerRedemptionRevoked(properties);
+    };
+
+    /**
+     * Encodes the specified PartnerRedemptionRevoked message. Does not implicitly {@link PartnerRedemptionRevoked.verify|verify} messages.
+     * @function encode
+     * @memberof PartnerRedemptionRevoked
+     * @static
+     * @param {IPartnerRedemptionRevoked} message PartnerRedemptionRevoked message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    PartnerRedemptionRevoked.encode = function encode(message, writer) {
+        if (!writer)
+            writer = $Writer.create();
+        if (message.redemptionId != null && message.hasOwnProperty("redemptionId"))
+            writer.uint32(/* id 1, wireType 2 =*/10).string(message.redemptionId);
+        if (message.redemptionRef != null && message.hasOwnProperty("redemptionRef"))
+            writer.uint32(/* id 2, wireType 2 =*/18).string(message.redemptionRef);
+        if (message.redemptionCode != null && message.hasOwnProperty("redemptionCode"))
+            writer.uint32(/* id 3, wireType 2 =*/26).string(message.redemptionCode);
+        if (message.partnerPackageId != null && message.hasOwnProperty("partnerPackageId"))
+            writer.uint32(/* id 4, wireType 2 =*/34).string(message.partnerPackageId);
+        if (message.partnerId != null && message.hasOwnProperty("partnerId"))
+            writer.uint32(/* id 5, wireType 2 =*/42).string(message.partnerId);
+        if (message.hsUserId != null && message.hasOwnProperty("hsUserId"))
+            writer.uint32(/* id 6, wireType 2 =*/50).string(message.hsUserId);
+        if (message.revokedAt != null && message.hasOwnProperty("revokedAt"))
+            writer.uint32(/* id 7, wireType 0 =*/56).uint64(message.revokedAt);
+        return writer;
+    };
+
+    /**
+     * Encodes the specified PartnerRedemptionRevoked message, length delimited. Does not implicitly {@link PartnerRedemptionRevoked.verify|verify} messages.
+     * @function encodeDelimited
+     * @memberof PartnerRedemptionRevoked
+     * @static
+     * @param {IPartnerRedemptionRevoked} message PartnerRedemptionRevoked message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    PartnerRedemptionRevoked.encodeDelimited = function encodeDelimited(message, writer) {
+        return this.encode(message, writer).ldelim();
+    };
+
+    /**
+     * Decodes a PartnerRedemptionRevoked message from the specified reader or buffer.
+     * @function decode
+     * @memberof PartnerRedemptionRevoked
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @param {number} [length] Message length if known beforehand
+     * @returns {PartnerRedemptionRevoked} PartnerRedemptionRevoked
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    PartnerRedemptionRevoked.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.PartnerRedemptionRevoked();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+            case 1:
+                message.redemptionId = reader.string();
+                break;
+            case 2:
+                message.redemptionRef = reader.string();
+                break;
+            case 3:
+                message.redemptionCode = reader.string();
+                break;
+            case 4:
+                message.partnerPackageId = reader.string();
+                break;
+            case 5:
+                message.partnerId = reader.string();
+                break;
+            case 6:
+                message.hsUserId = reader.string();
+                break;
+            case 7:
+                message.revokedAt = reader.uint64();
+                break;
+            default:
+                reader.skipType(tag & 7);
+                break;
+            }
+        }
+        return message;
+    };
+
+    /**
+     * Decodes a PartnerRedemptionRevoked message from the specified reader or buffer, length delimited.
+     * @function decodeDelimited
+     * @memberof PartnerRedemptionRevoked
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @returns {PartnerRedemptionRevoked} PartnerRedemptionRevoked
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    PartnerRedemptionRevoked.decodeDelimited = function decodeDelimited(reader) {
+        if (!(reader instanceof $Reader))
+            reader = new $Reader(reader);
+        return this.decode(reader, reader.uint32());
+    };
+
+    /**
+     * Verifies a PartnerRedemptionRevoked message.
+     * @function verify
+     * @memberof PartnerRedemptionRevoked
+     * @static
+     * @param {Object.<string,*>} message Plain object to verify
+     * @returns {string|null} `null` if valid, otherwise the reason why it is not
+     */
+    PartnerRedemptionRevoked.verify = function verify(message) {
+        if (typeof message !== "object" || message === null)
+            return "object expected";
+        if (message.redemptionId != null && message.hasOwnProperty("redemptionId"))
+            if (!$util.isString(message.redemptionId))
+                return "redemptionId: string expected";
+        if (message.redemptionRef != null && message.hasOwnProperty("redemptionRef"))
+            if (!$util.isString(message.redemptionRef))
+                return "redemptionRef: string expected";
+        if (message.redemptionCode != null && message.hasOwnProperty("redemptionCode"))
+            if (!$util.isString(message.redemptionCode))
+                return "redemptionCode: string expected";
+        if (message.partnerPackageId != null && message.hasOwnProperty("partnerPackageId"))
+            if (!$util.isString(message.partnerPackageId))
+                return "partnerPackageId: string expected";
+        if (message.partnerId != null && message.hasOwnProperty("partnerId"))
+            if (!$util.isString(message.partnerId))
+                return "partnerId: string expected";
+        if (message.hsUserId != null && message.hasOwnProperty("hsUserId"))
+            if (!$util.isString(message.hsUserId))
+                return "hsUserId: string expected";
+        if (message.revokedAt != null && message.hasOwnProperty("revokedAt"))
+            if (!$util.isInteger(message.revokedAt) && !(message.revokedAt && $util.isInteger(message.revokedAt.low) && $util.isInteger(message.revokedAt.high)))
+                return "revokedAt: integer|Long expected";
+        return null;
+    };
+
+    /**
+     * Creates a PartnerRedemptionRevoked message from a plain object. Also converts values to their respective internal types.
+     * @function fromObject
+     * @memberof PartnerRedemptionRevoked
+     * @static
+     * @param {Object.<string,*>} object Plain object
+     * @returns {PartnerRedemptionRevoked} PartnerRedemptionRevoked
+     */
+    PartnerRedemptionRevoked.fromObject = function fromObject(object) {
+        if (object instanceof $root.PartnerRedemptionRevoked)
+            return object;
+        var message = new $root.PartnerRedemptionRevoked();
+        if (object.redemptionId != null)
+            message.redemptionId = String(object.redemptionId);
+        if (object.redemptionRef != null)
+            message.redemptionRef = String(object.redemptionRef);
+        if (object.redemptionCode != null)
+            message.redemptionCode = String(object.redemptionCode);
+        if (object.partnerPackageId != null)
+            message.partnerPackageId = String(object.partnerPackageId);
+        if (object.partnerId != null)
+            message.partnerId = String(object.partnerId);
+        if (object.hsUserId != null)
+            message.hsUserId = String(object.hsUserId);
+        if (object.revokedAt != null)
+            if ($util.Long)
+                (message.revokedAt = $util.Long.fromValue(object.revokedAt)).unsigned = true;
+            else if (typeof object.revokedAt === "string")
+                message.revokedAt = parseInt(object.revokedAt, 10);
+            else if (typeof object.revokedAt === "number")
+                message.revokedAt = object.revokedAt;
+            else if (typeof object.revokedAt === "object")
+                message.revokedAt = new $util.LongBits(object.revokedAt.low >>> 0, object.revokedAt.high >>> 0).toNumber(true);
+        return message;
+    };
+
+    /**
+     * Creates a plain object from a PartnerRedemptionRevoked message. Also converts values to other types if specified.
+     * @function toObject
+     * @memberof PartnerRedemptionRevoked
+     * @static
+     * @param {PartnerRedemptionRevoked} message PartnerRedemptionRevoked
+     * @param {$protobuf.IConversionOptions} [options] Conversion options
+     * @returns {Object.<string,*>} Plain object
+     */
+    PartnerRedemptionRevoked.toObject = function toObject(message, options) {
+        if (!options)
+            options = {};
+        var object = {};
+        if (options.defaults) {
+            object.redemptionId = "";
+            object.redemptionRef = "";
+            object.redemptionCode = "";
+            object.partnerPackageId = "";
+            object.partnerId = "";
+            object.hsUserId = "";
+            if ($util.Long) {
+                var long = new $util.Long(0, 0, true);
+                object.revokedAt = options.longs === String ? long.toString() : options.longs === Number ? long.toNumber() : long;
+            } else
+                object.revokedAt = options.longs === String ? "0" : 0;
+        }
+        if (message.redemptionId != null && message.hasOwnProperty("redemptionId"))
+            object.redemptionId = message.redemptionId;
+        if (message.redemptionRef != null && message.hasOwnProperty("redemptionRef"))
+            object.redemptionRef = message.redemptionRef;
+        if (message.redemptionCode != null && message.hasOwnProperty("redemptionCode"))
+            object.redemptionCode = message.redemptionCode;
+        if (message.partnerPackageId != null && message.hasOwnProperty("partnerPackageId"))
+            object.partnerPackageId = message.partnerPackageId;
+        if (message.partnerId != null && message.hasOwnProperty("partnerId"))
+            object.partnerId = message.partnerId;
+        if (message.hsUserId != null && message.hasOwnProperty("hsUserId"))
+            object.hsUserId = message.hsUserId;
+        if (message.revokedAt != null && message.hasOwnProperty("revokedAt"))
+            if (typeof message.revokedAt === "number")
+                object.revokedAt = options.longs === String ? String(message.revokedAt) : message.revokedAt;
+            else
+                object.revokedAt = options.longs === String ? $util.Long.prototype.toString.call(message.revokedAt) : options.longs === Number ? new $util.LongBits(message.revokedAt.low >>> 0, message.revokedAt.high >>> 0).toNumber(true) : message.revokedAt;
+        return object;
+    };
+
+    /**
+     * Converts this PartnerRedemptionRevoked to JSON.
+     * @function toJSON
+     * @memberof PartnerRedemptionRevoked
+     * @instance
+     * @returns {Object.<string,*>} JSON object
+     */
+    PartnerRedemptionRevoked.prototype.toJSON = function toJSON() {
+        return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
+    };
+
+    return PartnerRedemptionRevoked;
+})();
+
 $root.WakeupPlaylistCreated = (function() {
 
     /**
@@ -198665,7 +199003,6 @@ $root.productcatalog = (function() {
                 case 5:
                 case 6:
                 case 7:
-                case 8:
                     break;
                 }
             if (message.billingCategory != null && message.hasOwnProperty("billingCategory"))
@@ -198782,10 +199119,6 @@ $root.productcatalog = (function() {
             case 7:
                 message.platform = 7;
                 break;
-            case "PRODUCT_SKU_PLATFORM_PAPI":
-            case 8:
-                message.platform = 8;
-                break;
             }
             switch (object.billingCategory) {
             case "BC_UNKNOWN":
@@ -200421,7 +200754,6 @@ $root.productcatalog = (function() {
      * @property {number} PLATFORM_ZUORA=5 PLATFORM_ZUORA value
      * @property {number} PLATFORM_B2B_ORG=6 PLATFORM_B2B_ORG value
      * @property {number} PRODUCT_SKU_PLATFORM_SIKA=7 PRODUCT_SKU_PLATFORM_SIKA value
-     * @property {number} PRODUCT_SKU_PLATFORM_PAPI=8 PRODUCT_SKU_PLATFORM_PAPI value
      */
     productcatalog.ProductSkuPlatform = (function() {
         var valuesById = {}, values = Object.create(valuesById);
@@ -200433,7 +200765,6 @@ $root.productcatalog = (function() {
         values[valuesById[5] = "PLATFORM_ZUORA"] = 5;
         values[valuesById[6] = "PLATFORM_B2B_ORG"] = 6;
         values[valuesById[7] = "PRODUCT_SKU_PLATFORM_SIKA"] = 7;
-        values[valuesById[8] = "PRODUCT_SKU_PLATFORM_PAPI"] = 8;
         return values;
     })();
 

package/package.json

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