@headspace/protos-events 1.800.0 → 1.801.0

package/lib/index.d.ts

@@ -81142,7 +81142,12 @@ export interface ISubscriptionCreated {
     productSku?: (subscription.ISubscriptionProductSku|null);
 }
 
-/** Represents a SubscriptionCreated. */
+/**
+ * A new subscription record has been created.
+ * This event only signals that a new record has been created but DOES NOT MEAN that the subscription has already
+ * started or even will start. Some subscriptions are created as "backfills" in order to fill in missing data. Use
+ * the `starts_at` and `ends_at` to determine whether the subscription is current.
+ */
 export class SubscriptionCreated implements ISubscriptionCreated {
 
     /**
@@ -81338,7 +81343,12 @@ export interface ISubscriptionCancelled {
     cancellationReason?: (string|null);
 }
 
-/** Represents a SubscriptionCancelled. */
+/**
+ * The subscription's auto-renewal has been disabled.
+ * Subscriptions can be cancelled for a number of reasons, see `cancellation_reason` for more information. This event
+ * __DOES NOT__ mean the subscription has ended. Check the `starts_at` and `ends_at` to determine whether the
+ * subscription is current.
+ */
 export class SubscriptionCancelled implements ISubscriptionCancelled {
 
     /**
@@ -81643,7 +81653,11 @@ export interface ISubscriptionRenewed {
     productSku?: (subscription.ISubscriptionProductSku|null);
 }
 
-/** Represents a SubscriptionRenewed. */
+/**
+ * Triggered when the subscription's `ends_at` has been pushed out further than what it was previously.
+ * The subscription did not necessarily transition to its new "subscription term", only that the overall end date
+ * has been extended.
+ */
 export class SubscriptionRenewed implements ISubscriptionRenewed {
 
     /**
@@ -81815,7 +81829,10 @@ export interface ISubscriptionUpcomingRenewal {
     platform?: (subscription.SubscriptionPlatform|null);
 }
 
-/** Represents a SubscriptionUpcomingRenewal. */
+/**
+ * __Zuora ONLY__. Triggered when Zuora sends an upcoming renewal notification. Signals that a Zuora subscription will
+ * renew in `days_before` days.
+ */
 export class SubscriptionUpcomingRenewal implements ISubscriptionUpcomingRenewal {
 
     /**
@@ -81960,7 +81977,10 @@ export interface ISubscriptionPaymentProcessed {
     subscriptionId?: (number|null);
 }
 
-/** Represents a SubscriptionPaymentProcessed. */
+/**
+ * __Zuora ONLY__. Triggered when Zuora sends a payment processed notification. Signals that there has been a successful
+ * payment made for the subscription in Zuora.
+ */
 export class SubscriptionPaymentProcessed implements ISubscriptionPaymentProcessed {
 
     /**
@@ -82087,7 +82107,10 @@ export interface ISubscriptionPaymentDeclined {
     subscriptionId?: (number|null);
 }
 
-/** Represents a SubscriptionPaymentDeclined. */
+/**
+ * __Zuora ONLY__. Triggered when Zuora sends a payment declined notification. Signals that the user has failed to pay
+ * for the subscription in Zuora {attempt} times.
+ */
 export class SubscriptionPaymentDeclined implements ISubscriptionPaymentDeclined {
 
     /**
@@ -82241,7 +82264,11 @@ export interface ISubscriptionGraced {
     productSku?: (subscription.ISubscriptionProductSku|null);
 }
 
-/** Represents a SubscriptionGraced. */
+/**
+ * A subscription has transitioned from an ACTIVE to GRACE status. This is usually due to a failed payment. Not all
+ * platforms support having a GRACE status so this event is not available on all subscriptions whenever a payment fails.
+ * (ie, not all failed payments will result in a SubscriptionGraced).
+ */
 export class SubscriptionGraced implements ISubscriptionGraced {
 
     /**
@@ -82428,7 +82455,10 @@ export interface ISubscriptionStarted {
     productSku?: (subscription.ISubscriptionProductSku|null);
 }
 
-/** Represents a SubscriptionStarted. */
+/**
+ * Triggered when the subscription starts, ie passed its start date. The event is published on a cron schedule so the
+ * events are not necessarily published at the exact instant of `starts_at`, but it should be triggered within 24 hours.
+ */
 export class SubscriptionStarted implements ISubscriptionStarted {
 
     /**
@@ -82618,7 +82648,10 @@ export interface ISubscriptionEnded {
     productSku?: (subscription.ISubscriptionProductSku|null);
 }
 
-/** Represents a SubscriptionEnded. */
+/**
+ * Triggered when the subscription ends, ie passed its end date. The event is published on a cron schedule so the events
+ * are not necessarily published at the exact instant of `ends_at`, but it should be within 24 hours.
+ */
 export class SubscriptionEnded implements ISubscriptionEnded {
 
     /**
@@ -82808,7 +82841,7 @@ export interface ISubscriptionRecovered {
     productSku?: (subscription.ISubscriptionProductSku|null);
 }
 
-/** Represents a SubscriptionRecovered. */
+/** Triggered when a subscription goes from GRACE to PAYING. See comments on `SubscriptionGraced` for more information. */
 export class SubscriptionRecovered implements ISubscriptionRecovered {
 
     /**
@@ -82995,7 +83028,11 @@ export interface ISubscriptionAmended {
     productSku?: (subscription.ISubscriptionProductSku|null);
 }
 
-/** Represents a SubscriptionAmended. */
+/**
+ * A subscription record was changed (ie "amended") outside of its normal lifecycle. Essentially a "catchall" event for
+ * in the case that fields needed to be corrected. Intention is for consumers to use this event to "resync" their view
+ * of the subscription.
+ */
 export class SubscriptionAmended implements ISubscriptionAmended {
 
     /**

package/lib/index.js

@@ -245303,7 +245303,10 @@ $root.SubscriptionCreated = (function() {
     /**
      * Constructs a new SubscriptionCreated.
      * @name SubscriptionCreated
-     * @classdesc Represents a SubscriptionCreated.
+     * @classdesc A new subscription record has been created.
+     * This event only signals that a new record has been created but DOES NOT MEAN that the subscription has already
+     * started or even will start. Some subscriptions are created as "backfills" in order to fill in missing data. Use
+     * the `starts_at` and `ends_at` to determine whether the subscription is current.
      * @implements ISubscriptionCreated
      * @constructor
      * @param {ISubscriptionCreated=} [properties] Properties to set
@@ -246142,7 +246145,10 @@ $root.SubscriptionCancelled = (function() {
     /**
      * Constructs a new SubscriptionCancelled.
      * @name SubscriptionCancelled
-     * @classdesc Represents a SubscriptionCancelled.
+     * @classdesc The subscription's auto-renewal has been disabled.
+     * Subscriptions can be cancelled for a number of reasons, see `cancellation_reason` for more information. This event
+     * __DOES NOT__ mean the subscription has ended. Check the `starts_at` and `ends_at` to determine whether the
+     * subscription is current.
      * @implements ISubscriptionCancelled
      * @constructor
      * @param {ISubscriptionCancelled=} [properties] Properties to set
@@ -247365,7 +247371,9 @@ $root.SubscriptionRenewed = (function() {
     /**
      * Constructs a new SubscriptionRenewed.
      * @name SubscriptionRenewed
-     * @classdesc Represents a SubscriptionRenewed.
+     * @classdesc Triggered when the subscription's `ends_at` has been pushed out further than what it was previously.
+     * The subscription did not necessarily transition to its new "subscription term", only that the overall end date
+     * has been extended.
      * @implements ISubscriptionRenewed
      * @constructor
      * @param {ISubscriptionRenewed=} [properties] Properties to set
@@ -248210,7 +248218,8 @@ $root.SubscriptionUpcomingRenewal = (function() {
     /**
      * Constructs a new SubscriptionUpcomingRenewal.
      * @name SubscriptionUpcomingRenewal
-     * @classdesc Represents a SubscriptionUpcomingRenewal.
+     * @classdesc __Zuora ONLY__. Triggered when Zuora sends an upcoming renewal notification. Signals that a Zuora subscription will
+     * renew in `days_before` days.
      * @implements ISubscriptionUpcomingRenewal
      * @constructor
      * @param {ISubscriptionUpcomingRenewal=} [properties] Properties to set
@@ -248775,7 +248784,8 @@ $root.SubscriptionPaymentProcessed = (function() {
     /**
      * Constructs a new SubscriptionPaymentProcessed.
      * @name SubscriptionPaymentProcessed
-     * @classdesc Represents a SubscriptionPaymentProcessed.
+     * @classdesc __Zuora ONLY__. Triggered when Zuora sends a payment processed notification. Signals that there has been a successful
+     * payment made for the subscription in Zuora.
      * @implements ISubscriptionPaymentProcessed
      * @constructor
      * @param {ISubscriptionPaymentProcessed=} [properties] Properties to set
@@ -249157,7 +249167,8 @@ $root.SubscriptionPaymentDeclined = (function() {
     /**
      * Constructs a new SubscriptionPaymentDeclined.
      * @name SubscriptionPaymentDeclined
-     * @classdesc Represents a SubscriptionPaymentDeclined.
+     * @classdesc __Zuora ONLY__. Triggered when Zuora sends a payment declined notification. Signals that the user has failed to pay
+     * for the subscription in Zuora {attempt} times.
      * @implements ISubscriptionPaymentDeclined
      * @constructor
      * @param {ISubscriptionPaymentDeclined=} [properties] Properties to set
@@ -249506,7 +249517,9 @@ $root.SubscriptionGraced = (function() {
     /**
      * Constructs a new SubscriptionGraced.
      * @name SubscriptionGraced
-     * @classdesc Represents a SubscriptionGraced.
+     * @classdesc A subscription has transitioned from an ACTIVE to GRACE status. This is usually due to a failed payment. Not all
+     * platforms support having a GRACE status so this event is not available on all subscriptions whenever a payment fails.
+     * (ie, not all failed payments will result in a SubscriptionGraced).
      * @implements ISubscriptionGraced
      * @constructor
      * @param {ISubscriptionGraced=} [properties] Properties to set
@@ -250356,7 +250369,8 @@ $root.SubscriptionStarted = (function() {
     /**
      * Constructs a new SubscriptionStarted.
      * @name SubscriptionStarted
-     * @classdesc Represents a SubscriptionStarted.
+     * @classdesc Triggered when the subscription starts, ie passed its start date. The event is published on a cron schedule so the
+     * events are not necessarily published at the exact instant of `starts_at`, but it should be triggered within 24 hours.
      * @implements ISubscriptionStarted
      * @constructor
      * @param {ISubscriptionStarted=} [properties] Properties to set
@@ -251207,7 +251221,8 @@ $root.SubscriptionEnded = (function() {
     /**
      * Constructs a new SubscriptionEnded.
      * @name SubscriptionEnded
-     * @classdesc Represents a SubscriptionEnded.
+     * @classdesc Triggered when the subscription ends, ie passed its end date. The event is published on a cron schedule so the events
+     * are not necessarily published at the exact instant of `ends_at`, but it should be within 24 hours.
      * @implements ISubscriptionEnded
      * @constructor
      * @param {ISubscriptionEnded=} [properties] Properties to set
@@ -252103,7 +252118,7 @@ $root.SubscriptionRecovered = (function() {
     /**
      * Constructs a new SubscriptionRecovered.
      * @name SubscriptionRecovered
-     * @classdesc Represents a SubscriptionRecovered.
+     * @classdesc Triggered when a subscription goes from GRACE to PAYING. See comments on `SubscriptionGraced` for more information.
      * @implements ISubscriptionRecovered
      * @constructor
      * @param {ISubscriptionRecovered=} [properties] Properties to set
@@ -252953,7 +252968,9 @@ $root.SubscriptionAmended = (function() {
     /**
      * Constructs a new SubscriptionAmended.
      * @name SubscriptionAmended
-     * @classdesc Represents a SubscriptionAmended.
+     * @classdesc A subscription record was changed (ie "amended") outside of its normal lifecycle. Essentially a "catchall" event for
+     * in the case that fields needed to be corrected. Intention is for consumers to use this event to "resync" their view
+     * of the subscription.
      * @implements ISubscriptionAmended
      * @constructor
      * @param {ISubscriptionAmended=} [properties] Properties to set

package/package.json

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