@headspace/protos-events 1.60.0 → 1.62.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.
Files changed (3) hide show
  1. package/lib/index.d.ts +455 -0
  2. package/lib/index.js +1434 -124
  3. package/package.json +1 -1
package/lib/index.d.ts CHANGED
@@ -1185,6 +1185,23 @@ export namespace subscription {
1185
1185
  SUBSTATE_GRACE = 6,
1186
1186
  SUBSTATE_CANCELLED = 5
1187
1187
  }
1188
+
1189
+ /** SubscriptionMemberState enum. */
1190
+ enum SubscriptionMemberState {
1191
+ SUBMEMSTATE_UNKNOWN = 0,
1192
+ SUBMEMSTATE_NEW = 1,
1193
+ SUBMEMSTATE_RESUBSCRIBER = 2,
1194
+ SUBMEMSTATE_FREE_FULL_ACCESS = 3,
1195
+ SUBMEMSTATE_CHURNED = 4
1196
+ }
1197
+
1198
+ /** SubscriptionMemberType enum. */
1199
+ enum SubscriptionMemberType {
1200
+ SUBMEMTYPE_UNKNOWN = 0,
1201
+ SUBMEMTYPE_NONE = 1,
1202
+ SUBMEMTYPE_B2B = 2,
1203
+ SUBMEMTYPE_B2C = 3
1204
+ }
1188
1205
  }
1189
1206
 
1190
1207
  /** Namespace userdomain. */
@@ -5382,6 +5399,348 @@ export class SubscriptionRecovered implements ISubscriptionRecovered {
5382
5399
  public toJSON(): { [k: string]: any };
5383
5400
  }
5384
5401
 
5402
+ /** Properties of a SubscriptionMemberSubscribed. */
5403
+ export interface ISubscriptionMemberSubscribed {
5404
+
5405
+ /** SubscriptionMemberSubscribed timestamp */
5406
+ timestamp?: (number|Long|null);
5407
+
5408
+ /** SubscriptionMemberSubscribed userId */
5409
+ userId?: (string|null);
5410
+
5411
+ /** SubscriptionMemberSubscribed memberState */
5412
+ memberState?: (subscription.SubscriptionMemberState|null);
5413
+
5414
+ /** SubscriptionMemberSubscribed memberType */
5415
+ memberType?: (subscription.SubscriptionMemberType|null);
5416
+
5417
+ /** SubscriptionMemberSubscribed subscriptionMembership */
5418
+ subscriptionMembership?: (subscription.SubscriptionMembership|null);
5419
+ }
5420
+
5421
+ /** Represents a SubscriptionMemberSubscribed. */
5422
+ export class SubscriptionMemberSubscribed implements ISubscriptionMemberSubscribed {
5423
+
5424
+ /**
5425
+ * Constructs a new SubscriptionMemberSubscribed.
5426
+ * @param [properties] Properties to set
5427
+ */
5428
+ constructor(properties?: ISubscriptionMemberSubscribed);
5429
+
5430
+ /** SubscriptionMemberSubscribed timestamp. */
5431
+ public timestamp: (number|Long);
5432
+
5433
+ /** SubscriptionMemberSubscribed userId. */
5434
+ public userId: string;
5435
+
5436
+ /** SubscriptionMemberSubscribed memberState. */
5437
+ public memberState: subscription.SubscriptionMemberState;
5438
+
5439
+ /** SubscriptionMemberSubscribed memberType. */
5440
+ public memberType: subscription.SubscriptionMemberType;
5441
+
5442
+ /** SubscriptionMemberSubscribed subscriptionMembership. */
5443
+ public subscriptionMembership: subscription.SubscriptionMembership;
5444
+
5445
+ /**
5446
+ * Creates a new SubscriptionMemberSubscribed instance using the specified properties.
5447
+ * @param [properties] Properties to set
5448
+ * @returns SubscriptionMemberSubscribed instance
5449
+ */
5450
+ public static create(properties?: ISubscriptionMemberSubscribed): SubscriptionMemberSubscribed;
5451
+
5452
+ /**
5453
+ * Encodes the specified SubscriptionMemberSubscribed message. Does not implicitly {@link SubscriptionMemberSubscribed.verify|verify} messages.
5454
+ * @param message SubscriptionMemberSubscribed message or plain object to encode
5455
+ * @param [writer] Writer to encode to
5456
+ * @returns Writer
5457
+ */
5458
+ public static encode(message: ISubscriptionMemberSubscribed, writer?: $protobuf.Writer): $protobuf.Writer;
5459
+
5460
+ /**
5461
+ * Encodes the specified SubscriptionMemberSubscribed message, length delimited. Does not implicitly {@link SubscriptionMemberSubscribed.verify|verify} messages.
5462
+ * @param message SubscriptionMemberSubscribed message or plain object to encode
5463
+ * @param [writer] Writer to encode to
5464
+ * @returns Writer
5465
+ */
5466
+ public static encodeDelimited(message: ISubscriptionMemberSubscribed, writer?: $protobuf.Writer): $protobuf.Writer;
5467
+
5468
+ /**
5469
+ * Decodes a SubscriptionMemberSubscribed message from the specified reader or buffer.
5470
+ * @param reader Reader or buffer to decode from
5471
+ * @param [length] Message length if known beforehand
5472
+ * @returns SubscriptionMemberSubscribed
5473
+ * @throws {Error} If the payload is not a reader or valid buffer
5474
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
5475
+ */
5476
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): SubscriptionMemberSubscribed;
5477
+
5478
+ /**
5479
+ * Decodes a SubscriptionMemberSubscribed message from the specified reader or buffer, length delimited.
5480
+ * @param reader Reader or buffer to decode from
5481
+ * @returns SubscriptionMemberSubscribed
5482
+ * @throws {Error} If the payload is not a reader or valid buffer
5483
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
5484
+ */
5485
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): SubscriptionMemberSubscribed;
5486
+
5487
+ /**
5488
+ * Verifies a SubscriptionMemberSubscribed message.
5489
+ * @param message Plain object to verify
5490
+ * @returns `null` if valid, otherwise the reason why it is not
5491
+ */
5492
+ public static verify(message: { [k: string]: any }): (string|null);
5493
+
5494
+ /**
5495
+ * Creates a SubscriptionMemberSubscribed message from a plain object. Also converts values to their respective internal types.
5496
+ * @param object Plain object
5497
+ * @returns SubscriptionMemberSubscribed
5498
+ */
5499
+ public static fromObject(object: { [k: string]: any }): SubscriptionMemberSubscribed;
5500
+
5501
+ /**
5502
+ * Creates a plain object from a SubscriptionMemberSubscribed message. Also converts values to other types if specified.
5503
+ * @param message SubscriptionMemberSubscribed
5504
+ * @param [options] Conversion options
5505
+ * @returns Plain object
5506
+ */
5507
+ public static toObject(message: SubscriptionMemberSubscribed, options?: $protobuf.IConversionOptions): { [k: string]: any };
5508
+
5509
+ /**
5510
+ * Converts this SubscriptionMemberSubscribed to JSON.
5511
+ * @returns JSON object
5512
+ */
5513
+ public toJSON(): { [k: string]: any };
5514
+ }
5515
+
5516
+ /** Properties of a SubscriptionMemberRenewed. */
5517
+ export interface ISubscriptionMemberRenewed {
5518
+
5519
+ /** SubscriptionMemberRenewed timestamp */
5520
+ timestamp?: (number|Long|null);
5521
+
5522
+ /** SubscriptionMemberRenewed userId */
5523
+ userId?: (string|null);
5524
+
5525
+ /** SubscriptionMemberRenewed memberState */
5526
+ memberState?: (subscription.SubscriptionMemberState|null);
5527
+
5528
+ /** SubscriptionMemberRenewed memberType */
5529
+ memberType?: (subscription.SubscriptionMemberType|null);
5530
+
5531
+ /** SubscriptionMemberRenewed subscriptionMembership */
5532
+ subscriptionMembership?: (subscription.SubscriptionMembership|null);
5533
+ }
5534
+
5535
+ /** Represents a SubscriptionMemberRenewed. */
5536
+ export class SubscriptionMemberRenewed implements ISubscriptionMemberRenewed {
5537
+
5538
+ /**
5539
+ * Constructs a new SubscriptionMemberRenewed.
5540
+ * @param [properties] Properties to set
5541
+ */
5542
+ constructor(properties?: ISubscriptionMemberRenewed);
5543
+
5544
+ /** SubscriptionMemberRenewed timestamp. */
5545
+ public timestamp: (number|Long);
5546
+
5547
+ /** SubscriptionMemberRenewed userId. */
5548
+ public userId: string;
5549
+
5550
+ /** SubscriptionMemberRenewed memberState. */
5551
+ public memberState: subscription.SubscriptionMemberState;
5552
+
5553
+ /** SubscriptionMemberRenewed memberType. */
5554
+ public memberType: subscription.SubscriptionMemberType;
5555
+
5556
+ /** SubscriptionMemberRenewed subscriptionMembership. */
5557
+ public subscriptionMembership: subscription.SubscriptionMembership;
5558
+
5559
+ /**
5560
+ * Creates a new SubscriptionMemberRenewed instance using the specified properties.
5561
+ * @param [properties] Properties to set
5562
+ * @returns SubscriptionMemberRenewed instance
5563
+ */
5564
+ public static create(properties?: ISubscriptionMemberRenewed): SubscriptionMemberRenewed;
5565
+
5566
+ /**
5567
+ * Encodes the specified SubscriptionMemberRenewed message. Does not implicitly {@link SubscriptionMemberRenewed.verify|verify} messages.
5568
+ * @param message SubscriptionMemberRenewed message or plain object to encode
5569
+ * @param [writer] Writer to encode to
5570
+ * @returns Writer
5571
+ */
5572
+ public static encode(message: ISubscriptionMemberRenewed, writer?: $protobuf.Writer): $protobuf.Writer;
5573
+
5574
+ /**
5575
+ * Encodes the specified SubscriptionMemberRenewed message, length delimited. Does not implicitly {@link SubscriptionMemberRenewed.verify|verify} messages.
5576
+ * @param message SubscriptionMemberRenewed message or plain object to encode
5577
+ * @param [writer] Writer to encode to
5578
+ * @returns Writer
5579
+ */
5580
+ public static encodeDelimited(message: ISubscriptionMemberRenewed, writer?: $protobuf.Writer): $protobuf.Writer;
5581
+
5582
+ /**
5583
+ * Decodes a SubscriptionMemberRenewed message from the specified reader or buffer.
5584
+ * @param reader Reader or buffer to decode from
5585
+ * @param [length] Message length if known beforehand
5586
+ * @returns SubscriptionMemberRenewed
5587
+ * @throws {Error} If the payload is not a reader or valid buffer
5588
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
5589
+ */
5590
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): SubscriptionMemberRenewed;
5591
+
5592
+ /**
5593
+ * Decodes a SubscriptionMemberRenewed message from the specified reader or buffer, length delimited.
5594
+ * @param reader Reader or buffer to decode from
5595
+ * @returns SubscriptionMemberRenewed
5596
+ * @throws {Error} If the payload is not a reader or valid buffer
5597
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
5598
+ */
5599
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): SubscriptionMemberRenewed;
5600
+
5601
+ /**
5602
+ * Verifies a SubscriptionMemberRenewed message.
5603
+ * @param message Plain object to verify
5604
+ * @returns `null` if valid, otherwise the reason why it is not
5605
+ */
5606
+ public static verify(message: { [k: string]: any }): (string|null);
5607
+
5608
+ /**
5609
+ * Creates a SubscriptionMemberRenewed message from a plain object. Also converts values to their respective internal types.
5610
+ * @param object Plain object
5611
+ * @returns SubscriptionMemberRenewed
5612
+ */
5613
+ public static fromObject(object: { [k: string]: any }): SubscriptionMemberRenewed;
5614
+
5615
+ /**
5616
+ * Creates a plain object from a SubscriptionMemberRenewed message. Also converts values to other types if specified.
5617
+ * @param message SubscriptionMemberRenewed
5618
+ * @param [options] Conversion options
5619
+ * @returns Plain object
5620
+ */
5621
+ public static toObject(message: SubscriptionMemberRenewed, options?: $protobuf.IConversionOptions): { [k: string]: any };
5622
+
5623
+ /**
5624
+ * Converts this SubscriptionMemberRenewed to JSON.
5625
+ * @returns JSON object
5626
+ */
5627
+ public toJSON(): { [k: string]: any };
5628
+ }
5629
+
5630
+ /** Properties of a SubscriptionMemberChurned. */
5631
+ export interface ISubscriptionMemberChurned {
5632
+
5633
+ /** SubscriptionMemberChurned timestamp */
5634
+ timestamp?: (number|Long|null);
5635
+
5636
+ /** SubscriptionMemberChurned userId */
5637
+ userId?: (string|null);
5638
+
5639
+ /** SubscriptionMemberChurned memberState */
5640
+ memberState?: (subscription.SubscriptionMemberState|null);
5641
+
5642
+ /** SubscriptionMemberChurned memberType */
5643
+ memberType?: (subscription.SubscriptionMemberType|null);
5644
+
5645
+ /** SubscriptionMemberChurned subscriptionMembership */
5646
+ subscriptionMembership?: (subscription.SubscriptionMembership|null);
5647
+ }
5648
+
5649
+ /** Represents a SubscriptionMemberChurned. */
5650
+ export class SubscriptionMemberChurned implements ISubscriptionMemberChurned {
5651
+
5652
+ /**
5653
+ * Constructs a new SubscriptionMemberChurned.
5654
+ * @param [properties] Properties to set
5655
+ */
5656
+ constructor(properties?: ISubscriptionMemberChurned);
5657
+
5658
+ /** SubscriptionMemberChurned timestamp. */
5659
+ public timestamp: (number|Long);
5660
+
5661
+ /** SubscriptionMemberChurned userId. */
5662
+ public userId: string;
5663
+
5664
+ /** SubscriptionMemberChurned memberState. */
5665
+ public memberState: subscription.SubscriptionMemberState;
5666
+
5667
+ /** SubscriptionMemberChurned memberType. */
5668
+ public memberType: subscription.SubscriptionMemberType;
5669
+
5670
+ /** SubscriptionMemberChurned subscriptionMembership. */
5671
+ public subscriptionMembership: subscription.SubscriptionMembership;
5672
+
5673
+ /**
5674
+ * Creates a new SubscriptionMemberChurned instance using the specified properties.
5675
+ * @param [properties] Properties to set
5676
+ * @returns SubscriptionMemberChurned instance
5677
+ */
5678
+ public static create(properties?: ISubscriptionMemberChurned): SubscriptionMemberChurned;
5679
+
5680
+ /**
5681
+ * Encodes the specified SubscriptionMemberChurned message. Does not implicitly {@link SubscriptionMemberChurned.verify|verify} messages.
5682
+ * @param message SubscriptionMemberChurned message or plain object to encode
5683
+ * @param [writer] Writer to encode to
5684
+ * @returns Writer
5685
+ */
5686
+ public static encode(message: ISubscriptionMemberChurned, writer?: $protobuf.Writer): $protobuf.Writer;
5687
+
5688
+ /**
5689
+ * Encodes the specified SubscriptionMemberChurned message, length delimited. Does not implicitly {@link SubscriptionMemberChurned.verify|verify} messages.
5690
+ * @param message SubscriptionMemberChurned message or plain object to encode
5691
+ * @param [writer] Writer to encode to
5692
+ * @returns Writer
5693
+ */
5694
+ public static encodeDelimited(message: ISubscriptionMemberChurned, writer?: $protobuf.Writer): $protobuf.Writer;
5695
+
5696
+ /**
5697
+ * Decodes a SubscriptionMemberChurned message from the specified reader or buffer.
5698
+ * @param reader Reader or buffer to decode from
5699
+ * @param [length] Message length if known beforehand
5700
+ * @returns SubscriptionMemberChurned
5701
+ * @throws {Error} If the payload is not a reader or valid buffer
5702
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
5703
+ */
5704
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): SubscriptionMemberChurned;
5705
+
5706
+ /**
5707
+ * Decodes a SubscriptionMemberChurned message from the specified reader or buffer, length delimited.
5708
+ * @param reader Reader or buffer to decode from
5709
+ * @returns SubscriptionMemberChurned
5710
+ * @throws {Error} If the payload is not a reader or valid buffer
5711
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
5712
+ */
5713
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): SubscriptionMemberChurned;
5714
+
5715
+ /**
5716
+ * Verifies a SubscriptionMemberChurned message.
5717
+ * @param message Plain object to verify
5718
+ * @returns `null` if valid, otherwise the reason why it is not
5719
+ */
5720
+ public static verify(message: { [k: string]: any }): (string|null);
5721
+
5722
+ /**
5723
+ * Creates a SubscriptionMemberChurned message from a plain object. Also converts values to their respective internal types.
5724
+ * @param object Plain object
5725
+ * @returns SubscriptionMemberChurned
5726
+ */
5727
+ public static fromObject(object: { [k: string]: any }): SubscriptionMemberChurned;
5728
+
5729
+ /**
5730
+ * Creates a plain object from a SubscriptionMemberChurned message. Also converts values to other types if specified.
5731
+ * @param message SubscriptionMemberChurned
5732
+ * @param [options] Conversion options
5733
+ * @returns Plain object
5734
+ */
5735
+ public static toObject(message: SubscriptionMemberChurned, options?: $protobuf.IConversionOptions): { [k: string]: any };
5736
+
5737
+ /**
5738
+ * Converts this SubscriptionMemberChurned to JSON.
5739
+ * @returns JSON object
5740
+ */
5741
+ public toJSON(): { [k: string]: any };
5742
+ }
5743
+
5385
5744
  /** Properties of a UserDoubleOptInEmailRequested. */
5386
5745
  export interface IUserDoubleOptInEmailRequested {
5387
5746
 
@@ -5981,3 +6340,99 @@ export class UserEmailMarketingOptedIn implements IUserEmailMarketingOptedIn {
5981
6340
  */
5982
6341
  public toJSON(): { [k: string]: any };
5983
6342
  }
6343
+
6344
+ /** Properties of a UserEmailMarketingSubscriptionStatusUpdated. */
6345
+ export interface IUserEmailMarketingSubscriptionStatusUpdated {
6346
+
6347
+ /** UserEmailMarketingSubscriptionStatusUpdated userId */
6348
+ userId?: (string|null);
6349
+
6350
+ /** UserEmailMarketingSubscriptionStatusUpdated status */
6351
+ status?: (string|null);
6352
+ }
6353
+
6354
+ /** Represents a UserEmailMarketingSubscriptionStatusUpdated. */
6355
+ export class UserEmailMarketingSubscriptionStatusUpdated implements IUserEmailMarketingSubscriptionStatusUpdated {
6356
+
6357
+ /**
6358
+ * Constructs a new UserEmailMarketingSubscriptionStatusUpdated.
6359
+ * @param [properties] Properties to set
6360
+ */
6361
+ constructor(properties?: IUserEmailMarketingSubscriptionStatusUpdated);
6362
+
6363
+ /** UserEmailMarketingSubscriptionStatusUpdated userId. */
6364
+ public userId: string;
6365
+
6366
+ /** UserEmailMarketingSubscriptionStatusUpdated status. */
6367
+ public status: string;
6368
+
6369
+ /**
6370
+ * Creates a new UserEmailMarketingSubscriptionStatusUpdated instance using the specified properties.
6371
+ * @param [properties] Properties to set
6372
+ * @returns UserEmailMarketingSubscriptionStatusUpdated instance
6373
+ */
6374
+ public static create(properties?: IUserEmailMarketingSubscriptionStatusUpdated): UserEmailMarketingSubscriptionStatusUpdated;
6375
+
6376
+ /**
6377
+ * Encodes the specified UserEmailMarketingSubscriptionStatusUpdated message. Does not implicitly {@link UserEmailMarketingSubscriptionStatusUpdated.verify|verify} messages.
6378
+ * @param message UserEmailMarketingSubscriptionStatusUpdated message or plain object to encode
6379
+ * @param [writer] Writer to encode to
6380
+ * @returns Writer
6381
+ */
6382
+ public static encode(message: IUserEmailMarketingSubscriptionStatusUpdated, writer?: $protobuf.Writer): $protobuf.Writer;
6383
+
6384
+ /**
6385
+ * Encodes the specified UserEmailMarketingSubscriptionStatusUpdated message, length delimited. Does not implicitly {@link UserEmailMarketingSubscriptionStatusUpdated.verify|verify} messages.
6386
+ * @param message UserEmailMarketingSubscriptionStatusUpdated message or plain object to encode
6387
+ * @param [writer] Writer to encode to
6388
+ * @returns Writer
6389
+ */
6390
+ public static encodeDelimited(message: IUserEmailMarketingSubscriptionStatusUpdated, writer?: $protobuf.Writer): $protobuf.Writer;
6391
+
6392
+ /**
6393
+ * Decodes a UserEmailMarketingSubscriptionStatusUpdated message from the specified reader or buffer.
6394
+ * @param reader Reader or buffer to decode from
6395
+ * @param [length] Message length if known beforehand
6396
+ * @returns UserEmailMarketingSubscriptionStatusUpdated
6397
+ * @throws {Error} If the payload is not a reader or valid buffer
6398
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
6399
+ */
6400
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): UserEmailMarketingSubscriptionStatusUpdated;
6401
+
6402
+ /**
6403
+ * Decodes a UserEmailMarketingSubscriptionStatusUpdated message from the specified reader or buffer, length delimited.
6404
+ * @param reader Reader or buffer to decode from
6405
+ * @returns UserEmailMarketingSubscriptionStatusUpdated
6406
+ * @throws {Error} If the payload is not a reader or valid buffer
6407
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
6408
+ */
6409
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): UserEmailMarketingSubscriptionStatusUpdated;
6410
+
6411
+ /**
6412
+ * Verifies a UserEmailMarketingSubscriptionStatusUpdated message.
6413
+ * @param message Plain object to verify
6414
+ * @returns `null` if valid, otherwise the reason why it is not
6415
+ */
6416
+ public static verify(message: { [k: string]: any }): (string|null);
6417
+
6418
+ /**
6419
+ * Creates a UserEmailMarketingSubscriptionStatusUpdated message from a plain object. Also converts values to their respective internal types.
6420
+ * @param object Plain object
6421
+ * @returns UserEmailMarketingSubscriptionStatusUpdated
6422
+ */
6423
+ public static fromObject(object: { [k: string]: any }): UserEmailMarketingSubscriptionStatusUpdated;
6424
+
6425
+ /**
6426
+ * Creates a plain object from a UserEmailMarketingSubscriptionStatusUpdated message. Also converts values to other types if specified.
6427
+ * @param message UserEmailMarketingSubscriptionStatusUpdated
6428
+ * @param [options] Conversion options
6429
+ * @returns Plain object
6430
+ */
6431
+ public static toObject(message: UserEmailMarketingSubscriptionStatusUpdated, options?: $protobuf.IConversionOptions): { [k: string]: any };
6432
+
6433
+ /**
6434
+ * Converts this UserEmailMarketingSubscriptionStatusUpdated to JSON.
6435
+ * @returns JSON object
6436
+ */
6437
+ public toJSON(): { [k: string]: any };
6438
+ }