@headspace/protos-events 1.169.0 → 1.171.0

package/lib/index.d.ts

@@ -1845,6 +1845,114 @@ export namespace subscription {
         public toJSON(): { [k: string]: any };
     }
 
+    /** Properties of a Term. */
+    interface ITerm {
+
+        /** Term startsMillis */
+        startsMillis?: (number|Long|null);
+
+        /** Term endsMillis */
+        endsMillis?: (number|Long|null);
+
+        /** Term termType */
+        termType?: (subscription.TermType|null);
+    }
+
+    /** Represents a Term. */
+    class Term implements ITerm {
+
+        /**
+         * Constructs a new Term.
+         * @param [properties] Properties to set
+         */
+        constructor(properties?: subscription.ITerm);
+
+        /** Term startsMillis. */
+        public startsMillis: (number|Long);
+
+        /** Term endsMillis. */
+        public endsMillis: (number|Long);
+
+        /** Term termType. */
+        public termType: subscription.TermType;
+
+        /**
+         * Creates a new Term instance using the specified properties.
+         * @param [properties] Properties to set
+         * @returns Term instance
+         */
+        public static create(properties?: subscription.ITerm): subscription.Term;
+
+        /**
+         * Encodes the specified Term message. Does not implicitly {@link subscription.Term.verify|verify} messages.
+         * @param message Term message or plain object to encode
+         * @param [writer] Writer to encode to
+         * @returns Writer
+         */
+        public static encode(message: subscription.ITerm, writer?: $protobuf.Writer): $protobuf.Writer;
+
+        /**
+         * Encodes the specified Term message, length delimited. Does not implicitly {@link subscription.Term.verify|verify} messages.
+         * @param message Term message or plain object to encode
+         * @param [writer] Writer to encode to
+         * @returns Writer
+         */
+        public static encodeDelimited(message: subscription.ITerm, writer?: $protobuf.Writer): $protobuf.Writer;
+
+        /**
+         * Decodes a Term message from the specified reader or buffer.
+         * @param reader Reader or buffer to decode from
+         * @param [length] Message length if known beforehand
+         * @returns Term
+         * @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): subscription.Term;
+
+        /**
+         * Decodes a Term message from the specified reader or buffer, length delimited.
+         * @param reader Reader or buffer to decode from
+         * @returns Term
+         * @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)): subscription.Term;
+
+        /**
+         * Verifies a Term 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 Term message from a plain object. Also converts values to their respective internal types.
+         * @param object Plain object
+         * @returns Term
+         */
+        public static fromObject(object: { [k: string]: any }): subscription.Term;
+
+        /**
+         * Creates a plain object from a Term message. Also converts values to other types if specified.
+         * @param message Term
+         * @param [options] Conversion options
+         * @returns Plain object
+         */
+        public static toObject(message: subscription.Term, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+        /**
+         * Converts this Term to JSON.
+         * @returns JSON object
+         */
+        public toJSON(): { [k: string]: any };
+    }
+
+    /** TermType enum. */
+    enum TermType {
+        TERM_TYPE_UNKNOWN = 0,
+        FREE_TRIAL = 1
+    }
+
     /** PlanAffiliation enum. */
     enum PlanAffiliation {
         STUDENT = 0,
@@ -20685,6 +20793,9 @@ export interface ISubscriptionCreated {
 
     /** SubscriptionCreated isQueuedSubscription */
     isQueuedSubscription?: (boolean|null);
+
+    /** SubscriptionCreated terms */
+    terms?: (subscription.ITerm[]|null);
 }
 
 /** Represents a SubscriptionCreated. */
@@ -20735,6 +20846,9 @@ export class SubscriptionCreated implements ISubscriptionCreated {
     /** SubscriptionCreated isQueuedSubscription. */
     public isQueuedSubscription: boolean;
 
+    /** SubscriptionCreated terms. */
+    public terms: subscription.ITerm[];
+
     /**
      * Creates a new SubscriptionCreated instance using the specified properties.
      * @param [properties] Properties to set
@@ -20853,6 +20967,9 @@ export interface ISubscriptionCancelled {
 
     /** SubscriptionCancelled renewalCount */
     renewalCount?: (number|Long|null);
+
+    /** SubscriptionCancelled terms */
+    terms?: (subscription.ITerm[]|null);
 }
 
 /** Represents a SubscriptionCancelled. */
@@ -20909,6 +21026,9 @@ export class SubscriptionCancelled implements ISubscriptionCancelled {
     /** SubscriptionCancelled renewalCount. */
     public renewalCount: (number|Long);
 
+    /** SubscriptionCancelled terms. */
+    public terms: subscription.ITerm[];
+
     /**
      * Creates a new SubscriptionCancelled instance using the specified properties.
      * @param [properties] Properties to set
@@ -21021,6 +21141,9 @@ export interface ISubscriptionRenewed {
 
     /** SubscriptionRenewed renewalCount */
     renewalCount?: (number|Long|null);
+
+    /** SubscriptionRenewed terms */
+    terms?: (subscription.ITerm[]|null);
 }
 
 /** Represents a SubscriptionRenewed. */
@@ -21071,6 +21194,9 @@ export class SubscriptionRenewed implements ISubscriptionRenewed {
     /** SubscriptionRenewed renewalCount. */
     public renewalCount: (number|Long);
 
+    /** SubscriptionRenewed terms. */
+    public terms: subscription.ITerm[];
+
     /**
      * Creates a new SubscriptionRenewed instance using the specified properties.
      * @param [properties] Properties to set
@@ -21549,6 +21675,9 @@ export interface ISubscriptionGraced {
 
     /** SubscriptionGraced renewalCount */
     renewalCount?: (number|Long|null);
+
+    /** SubscriptionGraced terms */
+    terms?: (subscription.ITerm[]|null);
 }
 
 /** Represents a SubscriptionGraced. */
@@ -21599,6 +21728,9 @@ export class SubscriptionGraced implements ISubscriptionGraced {
     /** SubscriptionGraced renewalCount. */
     public renewalCount: (number|Long);
 
+    /** SubscriptionGraced terms. */
+    public terms: subscription.ITerm[];
+
     /**
      * Creates a new SubscriptionGraced instance using the specified properties.
      * @param [properties] Properties to set
@@ -21711,6 +21843,9 @@ export interface ISubscriptionStarted {
 
     /** SubscriptionStarted id */
     id?: (number|null);
+
+    /** SubscriptionStarted terms */
+    terms?: (subscription.ITerm[]|null);
 }
 
 /** Represents a SubscriptionStarted. */
@@ -21761,6 +21896,9 @@ export class SubscriptionStarted implements ISubscriptionStarted {
     /** SubscriptionStarted id. */
     public id: number;
 
+    /** SubscriptionStarted terms. */
+    public terms: subscription.ITerm[];
+
     /**
      * Creates a new SubscriptionStarted instance using the specified properties.
      * @param [properties] Properties to set
@@ -21876,6 +22014,9 @@ export interface ISubscriptionEnded {
 
     /** SubscriptionEnded id */
     id?: (number|null);
+
+    /** SubscriptionEnded terms */
+    terms?: (subscription.ITerm[]|null);
 }
 
 /** Represents a SubscriptionEnded. */
@@ -21929,6 +22070,9 @@ export class SubscriptionEnded implements ISubscriptionEnded {
     /** SubscriptionEnded id. */
     public id: number;
 
+    /** SubscriptionEnded terms. */
+    public terms: subscription.ITerm[];
+
     /**
      * Creates a new SubscriptionEnded instance using the specified properties.
      * @param [properties] Properties to set
@@ -22041,6 +22185,9 @@ export interface ISubscriptionRecovered {
 
     /** SubscriptionRecovered id */
     id?: (number|null);
+
+    /** SubscriptionRecovered terms */
+    terms?: (subscription.ITerm[]|null);
 }
 
 /** Represents a SubscriptionRecovered. */
@@ -22091,6 +22238,9 @@ export class SubscriptionRecovered implements ISubscriptionRecovered {
     /** SubscriptionRecovered id. */
     public id: number;
 
+    /** SubscriptionRecovered terms. */
+    public terms: subscription.ITerm[];
+
     /**
      * Creates a new SubscriptionRecovered instance using the specified properties.
      * @param [properties] Properties to set
@@ -22162,6 +22312,174 @@ export class SubscriptionRecovered implements ISubscriptionRecovered {
     public toJSON(): { [k: string]: any };
 }
 
+/** Properties of a SubscriptionAmended. */
+export interface ISubscriptionAmended {
+
+    /** SubscriptionAmended updatedOn */
+    updatedOn?: (number|Long|null);
+
+    /** SubscriptionAmended userId */
+    userId?: (string|null);
+
+    /** SubscriptionAmended createdAt */
+    createdAt?: (number|Long|null);
+
+    /** SubscriptionAmended startsAt */
+    startsAt?: (number|Long|null);
+
+    /** SubscriptionAmended endsAt */
+    endsAt?: (number|Long|null);
+
+    /** SubscriptionAmended voucherCode */
+    voucherCode?: (string|null);
+
+    /** SubscriptionAmended platform */
+    platform?: (subscription.SubscriptionPlatform|null);
+
+    /** SubscriptionAmended autoRenewalStatus */
+    autoRenewalStatus?: (subscription.AutoRenewalStatus|null);
+
+    /** SubscriptionAmended plan */
+    plan?: (subscription.IPlan|null);
+
+    /** SubscriptionAmended subscriptionState */
+    subscriptionState?: (subscription.SubscriptionState|null);
+
+    /** SubscriptionAmended labels */
+    labels?: (subscription.SubscriptionLabels[]|null);
+
+    /** SubscriptionAmended renewalCount */
+    renewalCount?: (number|Long|null);
+
+    /** SubscriptionAmended id */
+    id?: (number|null);
+
+    /** SubscriptionAmended terms */
+    terms?: (subscription.ITerm[]|null);
+}
+
+/** Represents a SubscriptionAmended. */
+export class SubscriptionAmended implements ISubscriptionAmended {
+
+    /**
+     * Constructs a new SubscriptionAmended.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: ISubscriptionAmended);
+
+    /** SubscriptionAmended updatedOn. */
+    public updatedOn: (number|Long);
+
+    /** SubscriptionAmended userId. */
+    public userId: string;
+
+    /** SubscriptionAmended createdAt. */
+    public createdAt: (number|Long);
+
+    /** SubscriptionAmended startsAt. */
+    public startsAt: (number|Long);
+
+    /** SubscriptionAmended endsAt. */
+    public endsAt: (number|Long);
+
+    /** SubscriptionAmended voucherCode. */
+    public voucherCode: string;
+
+    /** SubscriptionAmended platform. */
+    public platform: subscription.SubscriptionPlatform;
+
+    /** SubscriptionAmended autoRenewalStatus. */
+    public autoRenewalStatus: subscription.AutoRenewalStatus;
+
+    /** SubscriptionAmended plan. */
+    public plan?: (subscription.IPlan|null);
+
+    /** SubscriptionAmended subscriptionState. */
+    public subscriptionState: subscription.SubscriptionState;
+
+    /** SubscriptionAmended labels. */
+    public labels: subscription.SubscriptionLabels[];
+
+    /** SubscriptionAmended renewalCount. */
+    public renewalCount: (number|Long);
+
+    /** SubscriptionAmended id. */
+    public id: number;
+
+    /** SubscriptionAmended terms. */
+    public terms: subscription.ITerm[];
+
+    /**
+     * Creates a new SubscriptionAmended instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns SubscriptionAmended instance
+     */
+    public static create(properties?: ISubscriptionAmended): SubscriptionAmended;
+
+    /**
+     * Encodes the specified SubscriptionAmended message. Does not implicitly {@link SubscriptionAmended.verify|verify} messages.
+     * @param message SubscriptionAmended message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(message: ISubscriptionAmended, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified SubscriptionAmended message, length delimited. Does not implicitly {@link SubscriptionAmended.verify|verify} messages.
+     * @param message SubscriptionAmended message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    public static encodeDelimited(message: ISubscriptionAmended, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a SubscriptionAmended message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns SubscriptionAmended
+     * @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): SubscriptionAmended;
+
+    /**
+     * Decodes a SubscriptionAmended message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns SubscriptionAmended
+     * @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)): SubscriptionAmended;
+
+    /**
+     * Verifies a SubscriptionAmended 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 SubscriptionAmended message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns SubscriptionAmended
+     */
+    public static fromObject(object: { [k: string]: any }): SubscriptionAmended;
+
+    /**
+     * Creates a plain object from a SubscriptionAmended message. Also converts values to other types if specified.
+     * @param message SubscriptionAmended
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(message: SubscriptionAmended, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this SubscriptionAmended to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}
+
 /** Properties of a SubscriptionMemberSubscribed. */
 export interface ISubscriptionMemberSubscribed {