@headspace/protos-events 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -1,4 +1,21 @@
1
1
  import * as $protobuf from "protobufjs";
2
+ /** Namespace subscription. */
3
+ export namespace subscription {
4
+
5
+ /** PlanAffiliation enum. */
6
+ enum PlanAffiliation {
7
+ STUDENT = 0,
8
+ VETERAN = 1,
9
+ FAMILY = 2
10
+ }
11
+
12
+ /** SubscriptionMembership enum. */
13
+ enum SubscriptionMembership {
14
+ PRIMARY = 0,
15
+ MEMBER = 1
16
+ }
17
+ }
18
+
2
19
  /** Properties of a FamilyMemberAdded. */
3
20
  export interface IFamilyMemberAdded {
4
21
 
@@ -1385,6 +1402,120 @@ export class SubscriptionRenewed implements ISubscriptionRenewed {
1385
1402
  public toJSON(): { [k: string]: any };
1386
1403
  }
1387
1404
 
1405
+ /** Properties of a SubscriptionUpcomingRenewal. */
1406
+ export interface ISubscriptionUpcomingRenewal {
1407
+
1408
+ /** SubscriptionUpcomingRenewal id */
1409
+ id?: (number|null);
1410
+
1411
+ /** SubscriptionUpcomingRenewal userId */
1412
+ userId?: (string|null);
1413
+
1414
+ /** SubscriptionUpcomingRenewal daysBefore */
1415
+ daysBefore?: (number|null);
1416
+
1417
+ /** SubscriptionUpcomingRenewal membership */
1418
+ membership?: (subscription.SubscriptionMembership|null);
1419
+
1420
+ /** SubscriptionUpcomingRenewal planAffiliation */
1421
+ planAffiliation?: (subscription.PlanAffiliation|null);
1422
+ }
1423
+
1424
+ /** Represents a SubscriptionUpcomingRenewal. */
1425
+ export class SubscriptionUpcomingRenewal implements ISubscriptionUpcomingRenewal {
1426
+
1427
+ /**
1428
+ * Constructs a new SubscriptionUpcomingRenewal.
1429
+ * @param [properties] Properties to set
1430
+ */
1431
+ constructor(properties?: ISubscriptionUpcomingRenewal);
1432
+
1433
+ /** SubscriptionUpcomingRenewal id. */
1434
+ public id: number;
1435
+
1436
+ /** SubscriptionUpcomingRenewal userId. */
1437
+ public userId: string;
1438
+
1439
+ /** SubscriptionUpcomingRenewal daysBefore. */
1440
+ public daysBefore: number;
1441
+
1442
+ /** SubscriptionUpcomingRenewal membership. */
1443
+ public membership: subscription.SubscriptionMembership;
1444
+
1445
+ /** SubscriptionUpcomingRenewal planAffiliation. */
1446
+ public planAffiliation: subscription.PlanAffiliation;
1447
+
1448
+ /**
1449
+ * Creates a new SubscriptionUpcomingRenewal instance using the specified properties.
1450
+ * @param [properties] Properties to set
1451
+ * @returns SubscriptionUpcomingRenewal instance
1452
+ */
1453
+ public static create(properties?: ISubscriptionUpcomingRenewal): SubscriptionUpcomingRenewal;
1454
+
1455
+ /**
1456
+ * Encodes the specified SubscriptionUpcomingRenewal message. Does not implicitly {@link SubscriptionUpcomingRenewal.verify|verify} messages.
1457
+ * @param message SubscriptionUpcomingRenewal message or plain object to encode
1458
+ * @param [writer] Writer to encode to
1459
+ * @returns Writer
1460
+ */
1461
+ public static encode(message: ISubscriptionUpcomingRenewal, writer?: $protobuf.Writer): $protobuf.Writer;
1462
+
1463
+ /**
1464
+ * Encodes the specified SubscriptionUpcomingRenewal message, length delimited. Does not implicitly {@link SubscriptionUpcomingRenewal.verify|verify} messages.
1465
+ * @param message SubscriptionUpcomingRenewal message or plain object to encode
1466
+ * @param [writer] Writer to encode to
1467
+ * @returns Writer
1468
+ */
1469
+ public static encodeDelimited(message: ISubscriptionUpcomingRenewal, writer?: $protobuf.Writer): $protobuf.Writer;
1470
+
1471
+ /**
1472
+ * Decodes a SubscriptionUpcomingRenewal message from the specified reader or buffer.
1473
+ * @param reader Reader or buffer to decode from
1474
+ * @param [length] Message length if known beforehand
1475
+ * @returns SubscriptionUpcomingRenewal
1476
+ * @throws {Error} If the payload is not a reader or valid buffer
1477
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
1478
+ */
1479
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): SubscriptionUpcomingRenewal;
1480
+
1481
+ /**
1482
+ * Decodes a SubscriptionUpcomingRenewal message from the specified reader or buffer, length delimited.
1483
+ * @param reader Reader or buffer to decode from
1484
+ * @returns SubscriptionUpcomingRenewal
1485
+ * @throws {Error} If the payload is not a reader or valid buffer
1486
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
1487
+ */
1488
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): SubscriptionUpcomingRenewal;
1489
+
1490
+ /**
1491
+ * Verifies a SubscriptionUpcomingRenewal message.
1492
+ * @param message Plain object to verify
1493
+ * @returns `null` if valid, otherwise the reason why it is not
1494
+ */
1495
+ public static verify(message: { [k: string]: any }): (string|null);
1496
+
1497
+ /**
1498
+ * Creates a SubscriptionUpcomingRenewal message from a plain object. Also converts values to their respective internal types.
1499
+ * @param object Plain object
1500
+ * @returns SubscriptionUpcomingRenewal
1501
+ */
1502
+ public static fromObject(object: { [k: string]: any }): SubscriptionUpcomingRenewal;
1503
+
1504
+ /**
1505
+ * Creates a plain object from a SubscriptionUpcomingRenewal message. Also converts values to other types if specified.
1506
+ * @param message SubscriptionUpcomingRenewal
1507
+ * @param [options] Conversion options
1508
+ * @returns Plain object
1509
+ */
1510
+ public static toObject(message: SubscriptionUpcomingRenewal, options?: $protobuf.IConversionOptions): { [k: string]: any };
1511
+
1512
+ /**
1513
+ * Converts this SubscriptionUpcomingRenewal to JSON.
1514
+ * @returns JSON object
1515
+ */
1516
+ public toJSON(): { [k: string]: any };
1517
+ }
1518
+
1388
1519
  /** Properties of a UserPasswordUpdated. */
1389
1520
  export interface IUserPasswordUpdated {
1390
1521
 
package/lib/index.js CHANGED
@@ -9,6 +9,48 @@ var $Reader = $protobuf.Reader, $Writer = $protobuf.Writer, $util = $protobuf.ut
9
9
  // Exported root namespace
10
10
  var $root = $protobuf.roots["default"] || ($protobuf.roots["default"] = {});
11
11
 
12
+ $root.subscription = (function() {
13
+
14
+ /**
15
+ * Namespace subscription.
16
+ * @exports subscription
17
+ * @namespace
18
+ */
19
+ var subscription = {};
20
+
21
+ /**
22
+ * PlanAffiliation enum.
23
+ * @name subscription.PlanAffiliation
24
+ * @enum {string}
25
+ * @property {number} STUDENT=0 STUDENT value
26
+ * @property {number} VETERAN=1 VETERAN value
27
+ * @property {number} FAMILY=2 FAMILY value
28
+ */
29
+ subscription.PlanAffiliation = (function() {
30
+ var valuesById = {}, values = Object.create(valuesById);
31
+ values[valuesById[0] = "STUDENT"] = 0;
32
+ values[valuesById[1] = "VETERAN"] = 1;
33
+ values[valuesById[2] = "FAMILY"] = 2;
34
+ return values;
35
+ })();
36
+
37
+ /**
38
+ * SubscriptionMembership enum.
39
+ * @name subscription.SubscriptionMembership
40
+ * @enum {string}
41
+ * @property {number} PRIMARY=0 PRIMARY value
42
+ * @property {number} MEMBER=1 MEMBER value
43
+ */
44
+ subscription.SubscriptionMembership = (function() {
45
+ var valuesById = {}, values = Object.create(valuesById);
46
+ values[valuesById[0] = "PRIMARY"] = 0;
47
+ values[valuesById[1] = "MEMBER"] = 1;
48
+ return values;
49
+ })();
50
+
51
+ return subscription;
52
+ })();
53
+
12
54
  $root.FamilyMemberAdded = (function() {
13
55
 
14
56
  /**
@@ -3449,6 +3491,313 @@ $root.SubscriptionRenewed = (function() {
3449
3491
  return SubscriptionRenewed;
3450
3492
  })();
3451
3493
 
3494
+ $root.SubscriptionUpcomingRenewal = (function() {
3495
+
3496
+ /**
3497
+ * Properties of a SubscriptionUpcomingRenewal.
3498
+ * @exports ISubscriptionUpcomingRenewal
3499
+ * @interface ISubscriptionUpcomingRenewal
3500
+ * @property {number|null} [id] SubscriptionUpcomingRenewal id
3501
+ * @property {string|null} [userId] SubscriptionUpcomingRenewal userId
3502
+ * @property {number|null} [daysBefore] SubscriptionUpcomingRenewal daysBefore
3503
+ * @property {subscription.SubscriptionMembership|null} [membership] SubscriptionUpcomingRenewal membership
3504
+ * @property {subscription.PlanAffiliation|null} [planAffiliation] SubscriptionUpcomingRenewal planAffiliation
3505
+ */
3506
+
3507
+ /**
3508
+ * Constructs a new SubscriptionUpcomingRenewal.
3509
+ * @exports SubscriptionUpcomingRenewal
3510
+ * @classdesc Represents a SubscriptionUpcomingRenewal.
3511
+ * @implements ISubscriptionUpcomingRenewal
3512
+ * @constructor
3513
+ * @param {ISubscriptionUpcomingRenewal=} [properties] Properties to set
3514
+ */
3515
+ function SubscriptionUpcomingRenewal(properties) {
3516
+ if (properties)
3517
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
3518
+ if (properties[keys[i]] != null)
3519
+ this[keys[i]] = properties[keys[i]];
3520
+ }
3521
+
3522
+ /**
3523
+ * SubscriptionUpcomingRenewal id.
3524
+ * @member {number} id
3525
+ * @memberof SubscriptionUpcomingRenewal
3526
+ * @instance
3527
+ */
3528
+ SubscriptionUpcomingRenewal.prototype.id = 0;
3529
+
3530
+ /**
3531
+ * SubscriptionUpcomingRenewal userId.
3532
+ * @member {string} userId
3533
+ * @memberof SubscriptionUpcomingRenewal
3534
+ * @instance
3535
+ */
3536
+ SubscriptionUpcomingRenewal.prototype.userId = "";
3537
+
3538
+ /**
3539
+ * SubscriptionUpcomingRenewal daysBefore.
3540
+ * @member {number} daysBefore
3541
+ * @memberof SubscriptionUpcomingRenewal
3542
+ * @instance
3543
+ */
3544
+ SubscriptionUpcomingRenewal.prototype.daysBefore = 0;
3545
+
3546
+ /**
3547
+ * SubscriptionUpcomingRenewal membership.
3548
+ * @member {subscription.SubscriptionMembership} membership
3549
+ * @memberof SubscriptionUpcomingRenewal
3550
+ * @instance
3551
+ */
3552
+ SubscriptionUpcomingRenewal.prototype.membership = 0;
3553
+
3554
+ /**
3555
+ * SubscriptionUpcomingRenewal planAffiliation.
3556
+ * @member {subscription.PlanAffiliation} planAffiliation
3557
+ * @memberof SubscriptionUpcomingRenewal
3558
+ * @instance
3559
+ */
3560
+ SubscriptionUpcomingRenewal.prototype.planAffiliation = 0;
3561
+
3562
+ /**
3563
+ * Creates a new SubscriptionUpcomingRenewal instance using the specified properties.
3564
+ * @function create
3565
+ * @memberof SubscriptionUpcomingRenewal
3566
+ * @static
3567
+ * @param {ISubscriptionUpcomingRenewal=} [properties] Properties to set
3568
+ * @returns {SubscriptionUpcomingRenewal} SubscriptionUpcomingRenewal instance
3569
+ */
3570
+ SubscriptionUpcomingRenewal.create = function create(properties) {
3571
+ return new SubscriptionUpcomingRenewal(properties);
3572
+ };
3573
+
3574
+ /**
3575
+ * Encodes the specified SubscriptionUpcomingRenewal message. Does not implicitly {@link SubscriptionUpcomingRenewal.verify|verify} messages.
3576
+ * @function encode
3577
+ * @memberof SubscriptionUpcomingRenewal
3578
+ * @static
3579
+ * @param {ISubscriptionUpcomingRenewal} message SubscriptionUpcomingRenewal message or plain object to encode
3580
+ * @param {$protobuf.Writer} [writer] Writer to encode to
3581
+ * @returns {$protobuf.Writer} Writer
3582
+ */
3583
+ SubscriptionUpcomingRenewal.encode = function encode(message, writer) {
3584
+ if (!writer)
3585
+ writer = $Writer.create();
3586
+ if (message.id != null && message.hasOwnProperty("id"))
3587
+ writer.uint32(/* id 1, wireType 0 =*/8).uint32(message.id);
3588
+ if (message.userId != null && message.hasOwnProperty("userId"))
3589
+ writer.uint32(/* id 2, wireType 2 =*/18).string(message.userId);
3590
+ if (message.daysBefore != null && message.hasOwnProperty("daysBefore"))
3591
+ writer.uint32(/* id 3, wireType 0 =*/24).uint32(message.daysBefore);
3592
+ if (message.membership != null && message.hasOwnProperty("membership"))
3593
+ writer.uint32(/* id 4, wireType 0 =*/32).int32(message.membership);
3594
+ if (message.planAffiliation != null && message.hasOwnProperty("planAffiliation"))
3595
+ writer.uint32(/* id 5, wireType 0 =*/40).int32(message.planAffiliation);
3596
+ return writer;
3597
+ };
3598
+
3599
+ /**
3600
+ * Encodes the specified SubscriptionUpcomingRenewal message, length delimited. Does not implicitly {@link SubscriptionUpcomingRenewal.verify|verify} messages.
3601
+ * @function encodeDelimited
3602
+ * @memberof SubscriptionUpcomingRenewal
3603
+ * @static
3604
+ * @param {ISubscriptionUpcomingRenewal} message SubscriptionUpcomingRenewal message or plain object to encode
3605
+ * @param {$protobuf.Writer} [writer] Writer to encode to
3606
+ * @returns {$protobuf.Writer} Writer
3607
+ */
3608
+ SubscriptionUpcomingRenewal.encodeDelimited = function encodeDelimited(message, writer) {
3609
+ return this.encode(message, writer).ldelim();
3610
+ };
3611
+
3612
+ /**
3613
+ * Decodes a SubscriptionUpcomingRenewal message from the specified reader or buffer.
3614
+ * @function decode
3615
+ * @memberof SubscriptionUpcomingRenewal
3616
+ * @static
3617
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
3618
+ * @param {number} [length] Message length if known beforehand
3619
+ * @returns {SubscriptionUpcomingRenewal} SubscriptionUpcomingRenewal
3620
+ * @throws {Error} If the payload is not a reader or valid buffer
3621
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
3622
+ */
3623
+ SubscriptionUpcomingRenewal.decode = function decode(reader, length) {
3624
+ if (!(reader instanceof $Reader))
3625
+ reader = $Reader.create(reader);
3626
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.SubscriptionUpcomingRenewal();
3627
+ while (reader.pos < end) {
3628
+ var tag = reader.uint32();
3629
+ switch (tag >>> 3) {
3630
+ case 1:
3631
+ message.id = reader.uint32();
3632
+ break;
3633
+ case 2:
3634
+ message.userId = reader.string();
3635
+ break;
3636
+ case 3:
3637
+ message.daysBefore = reader.uint32();
3638
+ break;
3639
+ case 4:
3640
+ message.membership = reader.int32();
3641
+ break;
3642
+ case 5:
3643
+ message.planAffiliation = reader.int32();
3644
+ break;
3645
+ default:
3646
+ reader.skipType(tag & 7);
3647
+ break;
3648
+ }
3649
+ }
3650
+ return message;
3651
+ };
3652
+
3653
+ /**
3654
+ * Decodes a SubscriptionUpcomingRenewal message from the specified reader or buffer, length delimited.
3655
+ * @function decodeDelimited
3656
+ * @memberof SubscriptionUpcomingRenewal
3657
+ * @static
3658
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
3659
+ * @returns {SubscriptionUpcomingRenewal} SubscriptionUpcomingRenewal
3660
+ * @throws {Error} If the payload is not a reader or valid buffer
3661
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
3662
+ */
3663
+ SubscriptionUpcomingRenewal.decodeDelimited = function decodeDelimited(reader) {
3664
+ if (!(reader instanceof $Reader))
3665
+ reader = new $Reader(reader);
3666
+ return this.decode(reader, reader.uint32());
3667
+ };
3668
+
3669
+ /**
3670
+ * Verifies a SubscriptionUpcomingRenewal message.
3671
+ * @function verify
3672
+ * @memberof SubscriptionUpcomingRenewal
3673
+ * @static
3674
+ * @param {Object.<string,*>} message Plain object to verify
3675
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
3676
+ */
3677
+ SubscriptionUpcomingRenewal.verify = function verify(message) {
3678
+ if (typeof message !== "object" || message === null)
3679
+ return "object expected";
3680
+ if (message.id != null && message.hasOwnProperty("id"))
3681
+ if (!$util.isInteger(message.id))
3682
+ return "id: integer expected";
3683
+ if (message.userId != null && message.hasOwnProperty("userId"))
3684
+ if (!$util.isString(message.userId))
3685
+ return "userId: string expected";
3686
+ if (message.daysBefore != null && message.hasOwnProperty("daysBefore"))
3687
+ if (!$util.isInteger(message.daysBefore))
3688
+ return "daysBefore: integer expected";
3689
+ if (message.membership != null && message.hasOwnProperty("membership"))
3690
+ switch (message.membership) {
3691
+ default:
3692
+ return "membership: enum value expected";
3693
+ case 0:
3694
+ case 1:
3695
+ break;
3696
+ }
3697
+ if (message.planAffiliation != null && message.hasOwnProperty("planAffiliation"))
3698
+ switch (message.planAffiliation) {
3699
+ default:
3700
+ return "planAffiliation: enum value expected";
3701
+ case 0:
3702
+ case 1:
3703
+ case 2:
3704
+ break;
3705
+ }
3706
+ return null;
3707
+ };
3708
+
3709
+ /**
3710
+ * Creates a SubscriptionUpcomingRenewal message from a plain object. Also converts values to their respective internal types.
3711
+ * @function fromObject
3712
+ * @memberof SubscriptionUpcomingRenewal
3713
+ * @static
3714
+ * @param {Object.<string,*>} object Plain object
3715
+ * @returns {SubscriptionUpcomingRenewal} SubscriptionUpcomingRenewal
3716
+ */
3717
+ SubscriptionUpcomingRenewal.fromObject = function fromObject(object) {
3718
+ if (object instanceof $root.SubscriptionUpcomingRenewal)
3719
+ return object;
3720
+ var message = new $root.SubscriptionUpcomingRenewal();
3721
+ if (object.id != null)
3722
+ message.id = object.id >>> 0;
3723
+ if (object.userId != null)
3724
+ message.userId = String(object.userId);
3725
+ if (object.daysBefore != null)
3726
+ message.daysBefore = object.daysBefore >>> 0;
3727
+ switch (object.membership) {
3728
+ case "PRIMARY":
3729
+ case 0:
3730
+ message.membership = 0;
3731
+ break;
3732
+ case "MEMBER":
3733
+ case 1:
3734
+ message.membership = 1;
3735
+ break;
3736
+ }
3737
+ switch (object.planAffiliation) {
3738
+ case "STUDENT":
3739
+ case 0:
3740
+ message.planAffiliation = 0;
3741
+ break;
3742
+ case "VETERAN":
3743
+ case 1:
3744
+ message.planAffiliation = 1;
3745
+ break;
3746
+ case "FAMILY":
3747
+ case 2:
3748
+ message.planAffiliation = 2;
3749
+ break;
3750
+ }
3751
+ return message;
3752
+ };
3753
+
3754
+ /**
3755
+ * Creates a plain object from a SubscriptionUpcomingRenewal message. Also converts values to other types if specified.
3756
+ * @function toObject
3757
+ * @memberof SubscriptionUpcomingRenewal
3758
+ * @static
3759
+ * @param {SubscriptionUpcomingRenewal} message SubscriptionUpcomingRenewal
3760
+ * @param {$protobuf.IConversionOptions} [options] Conversion options
3761
+ * @returns {Object.<string,*>} Plain object
3762
+ */
3763
+ SubscriptionUpcomingRenewal.toObject = function toObject(message, options) {
3764
+ if (!options)
3765
+ options = {};
3766
+ var object = {};
3767
+ if (options.defaults) {
3768
+ object.id = 0;
3769
+ object.userId = "";
3770
+ object.daysBefore = 0;
3771
+ object.membership = options.enums === String ? "PRIMARY" : 0;
3772
+ object.planAffiliation = options.enums === String ? "STUDENT" : 0;
3773
+ }
3774
+ if (message.id != null && message.hasOwnProperty("id"))
3775
+ object.id = message.id;
3776
+ if (message.userId != null && message.hasOwnProperty("userId"))
3777
+ object.userId = message.userId;
3778
+ if (message.daysBefore != null && message.hasOwnProperty("daysBefore"))
3779
+ object.daysBefore = message.daysBefore;
3780
+ if (message.membership != null && message.hasOwnProperty("membership"))
3781
+ object.membership = options.enums === String ? $root.subscription.SubscriptionMembership[message.membership] : message.membership;
3782
+ if (message.planAffiliation != null && message.hasOwnProperty("planAffiliation"))
3783
+ object.planAffiliation = options.enums === String ? $root.subscription.PlanAffiliation[message.planAffiliation] : message.planAffiliation;
3784
+ return object;
3785
+ };
3786
+
3787
+ /**
3788
+ * Converts this SubscriptionUpcomingRenewal to JSON.
3789
+ * @function toJSON
3790
+ * @memberof SubscriptionUpcomingRenewal
3791
+ * @instance
3792
+ * @returns {Object.<string,*>} JSON object
3793
+ */
3794
+ SubscriptionUpcomingRenewal.prototype.toJSON = function toJSON() {
3795
+ return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
3796
+ };
3797
+
3798
+ return SubscriptionUpcomingRenewal;
3799
+ })();
3800
+
3452
3801
  $root.UserPasswordUpdated = (function() {
3453
3802
 
3454
3803
  /**
package/package.json CHANGED
@@ -16,5 +16,5 @@
16
16
  "main": "lib/index.js",
17
17
  "name": "@headspace/protos-events",
18
18
  "typings": "lib/index.d.ts",
19
- "version": "1.4.0"
19
+ "version": "1.5.0"
20
20
  }