@stigg/typescript 0.1.0-beta.55 → 0.1.0-beta.56

package/src/resources/v1/features.ts

@@ -185,7 +185,8 @@ export namespace Feature {
     featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
 
     /**
-     * The type of the feature
+     * The type of the feature: BOOLEAN (on/off access), NUMBER (a numeric limit or
+     * quantity), or ENUM (one of a fixed set of values).
      */
     featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
 
@@ -205,7 +206,16 @@ export namespace Feature {
     metadata: { [key: string]: string };
 
     /**
-     * The meter type for the feature
+     * Event meter that turns reported events into usage for a metered feature
+     */
+    meter: Data.Meter | null;
+
+    /**
+     * How usage accumulates for this feature. `Incremental` and `Fluctuating` features
+     * track usage from reported events; `None` means the feature's value isn't
+     * usage-tracked — it's just a numeric or enum value carried by the plan (for
+     * example, a seat count or a tier setting) rather than something customers
+     * consume.
      */
     meterType: 'None' | 'FLUCTUATING' | 'INCREMENTAL';
 
@@ -233,6 +243,84 @@ export namespace Feature {
       value: string;
     }
 
+    /**
+     * Event meter that turns reported events into usage for a metered feature
+     */
+    export interface Meter {
+      /**
+       * How the matching events are aggregated into a usage value
+       */
+      aggregation: Meter.Aggregation;
+
+      /**
+       * Event filters. Conditions within a filter are ANDed, and filters are ORed
+       */
+      filters: Array<Meter.Filter>;
+    }
+
+    export namespace Meter {
+      /**
+       * How the matching events are aggregated into a usage value
+       */
+      export interface Aggregation {
+        /**
+         * Aggregation function applied to the matching events
+         */
+        function: 'SUM' | 'MAX' | 'MIN' | 'AVG' | 'COUNT' | 'UNIQUE';
+
+        /**
+         * Aggregation field name
+         */
+        field?: string | null;
+      }
+
+      /**
+       * A set of conditions an event must all match
+       */
+      export interface Filter {
+        /**
+         * Conditions the event must match
+         */
+        conditions: Array<Filter.Condition>;
+      }
+
+      export namespace Filter {
+        /**
+         * Meter filter condition
+         */
+        export interface Condition {
+          /**
+           * Condition field name
+           */
+          field: string;
+
+          /**
+           * Comparison applied to the condition field
+           */
+          operation:
+            | 'EQUALS'
+            | 'NOT_EQUALS'
+            | 'GREATER_THAN'
+            | 'GREATER_THAN_OR_EQUAL'
+            | 'LESS_THAN'
+            | 'LESS_THAN_OR_EQUAL'
+            | 'IS_NULL'
+            | 'IS_NOT_NULL'
+            | 'CONTAINS'
+            | 'STARTS_WITH'
+            | 'ENDS_WITH'
+            | 'IN';
+
+          /**
+           * Condition value
+           */
+          value?: string | null;
+
+          values?: Array<string> | null;
+        }
+      }
+    }
+
     /**
      * Unit transformation to be applied to the reported usage
      */
@@ -295,7 +383,8 @@ export interface FeatureListFeaturesResponse {
   featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
 
   /**
-   * The type of the feature
+   * The type of the feature: BOOLEAN (on/off access), NUMBER (a numeric limit or
+   * quantity), or ENUM (one of a fixed set of values).
    */
   featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
 
@@ -315,7 +404,16 @@ export interface FeatureListFeaturesResponse {
   metadata: { [key: string]: string };
 
   /**
-   * The meter type for the feature
+   * Event meter that turns reported events into usage for a metered feature
+   */
+  meter: FeatureListFeaturesResponse.Meter | null;
+
+  /**
+   * How usage accumulates for this feature. `Incremental` and `Fluctuating` features
+   * track usage from reported events; `None` means the feature's value isn't
+   * usage-tracked — it's just a numeric or enum value carried by the plan (for
+   * example, a seat count or a tier setting) rather than something customers
+   * consume.
    */
   meterType: 'None' | 'FLUCTUATING' | 'INCREMENTAL';
 
@@ -343,6 +441,84 @@ export namespace FeatureListFeaturesResponse {
     value: string;
   }
 
+  /**
+   * Event meter that turns reported events into usage for a metered feature
+   */
+  export interface Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
+    aggregation: Meter.Aggregation;
+
+    /**
+     * Event filters. Conditions within a filter are ANDed, and filters are ORed
+     */
+    filters: Array<Meter.Filter>;
+  }
+
+  export namespace Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
+    export interface Aggregation {
+      /**
+       * Aggregation function applied to the matching events
+       */
+      function: 'SUM' | 'MAX' | 'MIN' | 'AVG' | 'COUNT' | 'UNIQUE';
+
+      /**
+       * Aggregation field name
+       */
+      field?: string | null;
+    }
+
+    /**
+     * A set of conditions an event must all match
+     */
+    export interface Filter {
+      /**
+       * Conditions the event must match
+       */
+      conditions: Array<Filter.Condition>;
+    }
+
+    export namespace Filter {
+      /**
+       * Meter filter condition
+       */
+      export interface Condition {
+        /**
+         * Condition field name
+         */
+        field: string;
+
+        /**
+         * Comparison applied to the condition field
+         */
+        operation:
+          | 'EQUALS'
+          | 'NOT_EQUALS'
+          | 'GREATER_THAN'
+          | 'GREATER_THAN_OR_EQUAL'
+          | 'LESS_THAN'
+          | 'LESS_THAN_OR_EQUAL'
+          | 'IS_NULL'
+          | 'IS_NOT_NULL'
+          | 'CONTAINS'
+          | 'STARTS_WITH'
+          | 'ENDS_WITH'
+          | 'IN';
+
+        /**
+         * Condition value
+         */
+        value?: string | null;
+
+        values?: Array<string> | null;
+      }
+    }
+  }
+
   /**
    * Unit transformation to be applied to the reported usage
    */
@@ -396,7 +572,8 @@ export interface FeatureCreateFeatureParams {
   displayName: string;
 
   /**
-   * Body param: The type of the feature
+   * Body param: The type of the feature: BOOLEAN (on/off access), NUMBER (a numeric
+   * limit or quantity), or ENUM (one of a fixed set of values).
    */
   featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
 
@@ -431,7 +608,17 @@ export interface FeatureCreateFeatureParams {
   metadata?: { [key: string]: string };
 
   /**
-   * Body param: The meter type for the feature
+   * Body param: Event meter that turns reported events into usage for a metered
+   * feature
+   */
+  meter?: FeatureCreateFeatureParams.Meter;
+
+  /**
+   * Body param: How usage accumulates for this feature. `Incremental` and
+   * `Fluctuating` features track usage from reported events; `None` means the
+   * feature's value isn't usage-tracked — it's just a numeric or enum value carried
+   * by the plan (for example, a seat count or a tier setting) rather than something
+   * customers consume.
    */
   meterType?: 'None' | 'FLUCTUATING' | 'INCREMENTAL';
 
@@ -467,6 +654,78 @@ export namespace FeatureCreateFeatureParams {
     value: string;
   }
 
+  /**
+   * Event meter that turns reported events into usage for a metered feature
+   */
+  export interface Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
+    aggregation: Meter.Aggregation;
+
+    /**
+     * Event filters. Conditions within a filter are ANDed, and filters are ORed
+     */
+    filters: Array<Meter.Filter>;
+  }
+
+  export namespace Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
+    export interface Aggregation {
+      /**
+       * Aggregation function applied to the matching events
+       */
+      function: 'SUM' | 'MAX' | 'MIN' | 'AVG' | 'COUNT' | 'UNIQUE';
+
+      /**
+       * Aggregation field name
+       */
+      field?: string;
+    }
+
+    export interface Filter {
+      /**
+       * Conditions the event must match
+       */
+      conditions: Array<Filter.Condition>;
+    }
+
+    export namespace Filter {
+      export interface Condition {
+        /**
+         * Condition field name
+         */
+        field: string;
+
+        /**
+         * Comparison applied to the condition field
+         */
+        operation:
+          | 'EQUALS'
+          | 'NOT_EQUALS'
+          | 'GREATER_THAN'
+          | 'GREATER_THAN_OR_EQUAL'
+          | 'LESS_THAN'
+          | 'LESS_THAN_OR_EQUAL'
+          | 'IS_NULL'
+          | 'IS_NOT_NULL'
+          | 'CONTAINS'
+          | 'STARTS_WITH'
+          | 'ENDS_WITH'
+          | 'IN';
+
+        /**
+         * Condition value
+         */
+        value?: string;
+
+        values?: Array<string>;
+      }
+    }
+  }
+
   /**
    * Unit transformation to be applied to the reported usage
    */
@@ -625,7 +884,8 @@ export interface FeatureUpdateFeatureParams {
   metadata?: { [key: string]: string };
 
   /**
-   * Body param
+   * Body param: Event meter that turns reported events into usage for a metered
+   * feature
    */
   meter?: FeatureUpdateFeatureParams.Meter;
 
@@ -661,14 +921,29 @@ export namespace FeatureUpdateFeatureParams {
     value: string;
   }
 
+  /**
+   * Event meter that turns reported events into usage for a metered feature
+   */
   export interface Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
     aggregation: Meter.Aggregation;
 
+    /**
+     * Event filters. Conditions within a filter are ANDed, and filters are ORed
+     */
     filters: Array<Meter.Filter>;
   }
 
   export namespace Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
     export interface Aggregation {
+      /**
+       * Aggregation function applied to the matching events
+       */
       function: 'SUM' | 'MAX' | 'MIN' | 'AVG' | 'COUNT' | 'UNIQUE';
 
       /**
@@ -678,6 +953,9 @@ export namespace FeatureUpdateFeatureParams {
     }
 
     export interface Filter {
+      /**
+       * Conditions the event must match
+       */
       conditions: Array<Filter.Condition>;
     }
 
@@ -688,6 +966,9 @@ export namespace FeatureUpdateFeatureParams {
          */
         field: string;
 
+        /**
+         * Comparison applied to the condition field
+         */
         operation:
           | 'EQUALS'
           | 'NOT_EQUALS'

package/src/resources/v1/plans/plans.ts

@@ -199,7 +199,11 @@ export class Plans extends APIResource {
   }
 
   /**
-   * Publishes a draft plan, making it available for use in subscriptions.
+   * Publishes a draft plan, making it available for use in subscriptions. The
+   * required `migrationType` field controls whether existing subscribers are moved
+   * onto the new version immediately (`ALL_CUSTOMERS`) or stay on the version they
+   * subscribed to — grandfathered — until you explicitly migrate them, e.g. via the
+   * migrate subscription endpoint (`NEW_CUSTOMERS`).
    */
   publish(id: string, params: PlanPublishParams, options?: RequestOptions): APIPromise<PlanPublishResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -277,7 +281,9 @@ export namespace Plan {
     createdAt: string;
 
     /**
-     * Default trial configuration for the plan
+     * Default trial configuration for the plan. When set, subscriptions provisioned on
+     * this plan without explicit trial settings automatically start in trial for the
+     * configured duration; leave unset for no automatic trial.
      */
     defaultTrialConfig: Data.DefaultTrialConfig | null;
 
@@ -307,7 +313,9 @@ export namespace Plan {
     metadata: { [key: string]: string };
 
     /**
-     * The ID of the parent plan, if applicable
+     * The ID of the parent plan, if this plan should inherit entitlements from another
+     * plan. Optional — omit to create a standalone plan with no inherited
+     * entitlements.
      */
     parentPlanId: string | null;
 
@@ -339,7 +347,9 @@ export namespace Plan {
 
   export namespace Data {
     /**
-     * Default trial configuration for the plan
+     * Default trial configuration for the plan. When set, subscriptions provisioned on
+     * this plan without explicit trial settings automatically start in trial for the
+     * configured duration; leave unset for no automatic trial.
      */
     export interface DefaultTrialConfig {
       /**
@@ -416,7 +426,9 @@ export interface PlanListResponse {
   createdAt: string;
 
   /**
-   * Default trial configuration for the plan
+   * Default trial configuration for the plan. When set, subscriptions provisioned on
+   * this plan without explicit trial settings automatically start in trial for the
+   * configured duration; leave unset for no automatic trial.
    */
   defaultTrialConfig: PlanListResponse.DefaultTrialConfig | null;
 
@@ -446,7 +458,9 @@ export interface PlanListResponse {
   metadata: { [key: string]: string };
 
   /**
-   * The ID of the parent plan, if applicable
+   * The ID of the parent plan, if this plan should inherit entitlements from another
+   * plan. Optional — omit to create a standalone plan with no inherited
+   * entitlements.
    */
   parentPlanId: string | null;
 
@@ -478,7 +492,9 @@ export interface PlanListResponse {
 
 export namespace PlanListResponse {
   /**
-   * Default trial configuration for the plan
+   * Default trial configuration for the plan. When set, subscriptions provisioned on
+   * this plan without explicit trial settings automatically start in trial for the
+   * configured duration; leave unset for no automatic trial.
    */
   export interface DefaultTrialConfig {
     /**
@@ -564,7 +580,8 @@ export interface PlanListChargesResponse {
   createdAt: string;
 
   /**
-   * ISO country code for localized pricing, if any
+   * ISO country code for localized pricing, or "eu" for the European Union group you
+   * map countries into, if any
    */
   billingCountryCode?: string | null;
 
@@ -1108,7 +1125,8 @@ export interface PlanListOverageChargesResponse {
   createdAt: string;
 
   /**
-   * ISO country code for localized pricing, if any
+   * ISO country code for localized pricing, or "eu" for the European Union group you
+   * map countries into, if any
    */
   billingCountryCode?: string | null;
 
@@ -1674,7 +1692,9 @@ export interface PlanCreateParams {
   billingId?: string | null;
 
   /**
-   * Body param: Default trial configuration for the plan
+   * Body param: Default trial configuration for the plan. When set, subscriptions
+   * provisioned on this plan without explicit trial settings automatically start in
+   * trial for the configured duration; leave unset for no automatic trial.
    */
   defaultTrialConfig?: PlanCreateParams.DefaultTrialConfig | null;
 
@@ -1689,7 +1709,9 @@ export interface PlanCreateParams {
   metadata?: { [key: string]: string };
 
   /**
-   * Body param: The ID of the parent plan, if applicable
+   * Body param: The ID of the parent plan, if this plan should inherit entitlements
+   * from another plan. Optional — omit to create a standalone plan with no inherited
+   * entitlements.
    */
   parentPlanId?: string | null;
 
@@ -1719,7 +1741,9 @@ export interface PlanCreateParams {
 
 export namespace PlanCreateParams {
   /**
-   * Default trial configuration for the plan
+   * Default trial configuration for the plan. When set, subscriptions provisioned on
+   * this plan without explicit trial settings automatically start in trial for the
+   * configured duration; leave unset for no automatic trial.
    */
   export interface DefaultTrialConfig {
     /**
@@ -1783,7 +1807,9 @@ export interface PlanUpdateParams {
   billingId?: string | null;
 
   /**
-   * Body param: Pricing configuration to set on the plan draft
+   * Body param: Pricing configuration to set on the plan draft. Unlike the rest of
+   * this request, this is a full replace of the pricing configuration, not a merge —
+   * see SetPackagePricingRequest.
    */
   charges?: PlanUpdateParams.Charges;
 
@@ -1793,7 +1819,9 @@ export interface PlanUpdateParams {
   compatibleAddonIds?: Array<string> | null;
 
   /**
-   * Body param: Default trial configuration for the plan
+   * Body param: Default trial configuration for the plan. When set, subscriptions
+   * provisioned on this plan without explicit trial settings automatically start in
+   * trial for the configured duration; leave unset for no automatic trial.
    */
   defaultTrialConfig?: PlanUpdateParams.DefaultTrialConfig | null;
 
@@ -1813,7 +1841,9 @@ export interface PlanUpdateParams {
   metadata?: { [key: string]: string };
 
   /**
-   * Body param: The ID of the parent plan, if applicable
+   * Body param: The ID of the parent plan, if this plan should inherit entitlements
+   * from another plan. Optional — omit to create a standalone plan with no inherited
+   * entitlements.
    */
   parentPlanId?: string | null;
 
@@ -1833,7 +1863,9 @@ export interface PlanUpdateParams {
 
 export namespace PlanUpdateParams {
   /**
-   * Pricing configuration to set on the plan draft
+   * Pricing configuration to set on the plan draft. Unlike the rest of this request,
+   * this is a full replace of the pricing configuration, not a merge — see
+   * SetPackagePricingRequest.
    */
   export interface Charges {
     /**
@@ -1857,12 +1889,14 @@ export namespace PlanUpdateParams {
     overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
 
     /**
-     * Array of overage pricing model configurations
+     * Array of overage pricing model configurations. Replaces all existing overage
+     * pricing models on the draft — omit this to end up with no overage pricing.
      */
     overagePricingModels?: Array<Charges.OveragePricingModel>;
 
     /**
-     * Array of pricing model configurations
+     * Array of pricing model configurations. Replaces all existing base pricing models
+     * on the draft — omit this to end up with no base pricing.
      */
     pricingModels?: Array<Charges.PricingModel>;
   }
@@ -2058,7 +2092,8 @@ export namespace PlanUpdateParams {
         billingPeriod: 'MONTHLY' | 'ANNUALLY';
 
         /**
-         * ISO country code for localized pricing
+         * ISO country code for localized pricing, or "eu" for the European Union group you
+         * map countries into
          */
         billingCountryCode?: string;
 
@@ -2708,7 +2743,8 @@ export namespace PlanUpdateParams {
         billingPeriod: 'MONTHLY' | 'ANNUALLY';
 
         /**
-         * ISO country code for localized pricing
+         * ISO country code for localized pricing, or "eu" for the European Union group you
+         * map countries into
          */
         billingCountryCode?: string;
 
@@ -3216,7 +3252,9 @@ export namespace PlanUpdateParams {
   }
 
   /**
-   * Default trial configuration for the plan
+   * Default trial configuration for the plan. When set, subscriptions provisioned on
+   * this plan without explicit trial settings automatically start in trial for the
+   * configured duration; leave unset for no automatic trial.
    */
   export interface DefaultTrialConfig {
     /**
@@ -3378,7 +3416,9 @@ export interface PlanListOverageChargesParams extends MyCursorIDPageParams {
 
 export interface PlanPublishParams {
   /**
-   * Body param: The migration type of the package
+   * Body param: Who the published version applies to: NEW_CUSTOMERS (default) leaves
+   * existing subscribers on their current version, ALL_CUSTOMERS moves them onto the
+   * new version immediately.
    */
   migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
 

package/src/resources/v1/products.ts

@@ -223,7 +223,8 @@ export namespace Product {
       subscriptionStartSetup: 'PLAN_SELECTION' | 'TRIAL_PERIOD' | 'FREE_PLAN';
 
       /**
-       * ID of the plan to downgrade to at the end of the billing period
+       * ID of the plan to downgrade to at the end of the billing period. Only relevant
+       * when subscriptionEndSetup is DOWNGRADE_TO_FREE — ignored otherwise.
        */
       downgradePlanId?: string | null;
 
@@ -234,7 +235,8 @@ export namespace Product {
       prorateAtEndOfBillingPeriod?: boolean | null;
 
       /**
-       * ID of the plan to start the subscription with
+       * ID of the plan to start the subscription with. Only relevant when
+       * subscriptionStartSetup is PLAN_SELECTION — ignored otherwise.
        */
       subscriptionStartPlanId?: string | null;
     }
@@ -312,7 +314,8 @@ export namespace ProductListProductsResponse {
     subscriptionStartSetup: 'PLAN_SELECTION' | 'TRIAL_PERIOD' | 'FREE_PLAN';
 
     /**
-     * ID of the plan to downgrade to at the end of the billing period
+     * ID of the plan to downgrade to at the end of the billing period. Only relevant
+     * when subscriptionEndSetup is DOWNGRADE_TO_FREE — ignored otherwise.
      */
     downgradePlanId?: string | null;
 
@@ -323,7 +326,8 @@ export namespace ProductListProductsResponse {
     prorateAtEndOfBillingPeriod?: boolean | null;
 
     /**
-     * ID of the plan to start the subscription with
+     * ID of the plan to start the subscription with. Only relevant when
+     * subscriptionStartSetup is PLAN_SELECTION — ignored otherwise.
      */
     subscriptionStartPlanId?: string | null;
   }
@@ -499,7 +503,9 @@ export interface ProductUpdateProductParams {
   displayName?: string;
 
   /**
-   * Body param: Additional metadata for the product
+   * Body param: Additional metadata for the product. When included, this replaces
+   * the product's entire metadata object rather than merging with the existing keys
+   * — omit the field to leave existing metadata untouched.
    */
   metadata?: { [key: string]: string } | null;
 
@@ -550,7 +556,8 @@ export namespace ProductUpdateProductParams {
     subscriptionStartSetup: 'PLAN_SELECTION' | 'TRIAL_PERIOD' | 'FREE_PLAN';
 
     /**
-     * ID of the plan to downgrade to at the end of the billing period
+     * ID of the plan to downgrade to at the end of the billing period. Only relevant
+     * when subscriptionEndSetup is DOWNGRADE_TO_FREE — ignored otherwise.
      */
     downgradePlanId?: string | null;
 
@@ -561,7 +568,8 @@ export namespace ProductUpdateProductParams {
     prorateAtEndOfBillingPeriod?: boolean | null;
 
     /**
-     * ID of the plan to start the subscription with
+     * ID of the plan to start the subscription with. Only relevant when
+     * subscriptionStartSetup is PLAN_SELECTION — ignored otherwise.
      */
     subscriptionStartPlanId?: string | null;
   }