@metronome/sdk 0.1.0 → 0.3.0

package/src/resources/v1/alerts.ts

@@ -118,10 +118,10 @@ export interface AlertCreateParams {
   evaluate_on_create?: boolean;
 
   /**
-   * Scopes alert evaluation to a specific presentation group key on individual line
-   * items. Only present for spend alerts.
+   * Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+   * group key on individual line items.
    */
-  group_key_filter?: AlertCreateParams.GroupKeyFilter;
+  group_values?: Array<AlertCreateParams.GroupValue>;
 
   /**
    * Only supported for invoice_total_reached alerts. A list of invoice types to
@@ -152,11 +152,7 @@ export namespace AlertCreateParams {
     value: string;
   }
 
-  /**
-   * Scopes alert evaluation to a specific presentation group key on individual line
-   * items. Only present for spend alerts.
-   */
-  export interface GroupKeyFilter {
+  export interface GroupValue {
     key: string;
 
     value: string;

package/src/resources/v1/contracts/contracts.ts

@@ -1719,6 +1719,12 @@ export namespace ContractCreateParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -1866,6 +1872,18 @@ export namespace ContractCreateParams {
          * your payment type.
          */
         invoice_metadata?: { [key: string]: string };
+
+        /**
+         * If true, the payment will be made assuming the customer is present (i.e. on
+         * session).
+         *
+         * If false, the payment will be made assuming the customer is not present (i.e.
+         * off session). For cardholders from a country with an e-mandate requirement (e.g.
+         * India), the payment may be declined.
+         *
+         * If left blank, will default to false.
+         */
+        on_session_payment?: boolean;
       }
     }
 
@@ -2050,6 +2068,12 @@ export namespace ContractCreateParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -2600,6 +2624,11 @@ export namespace ContractCreateParams {
      */
     specifiers?: Array<RecurringCommit.Specifier>;
 
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    subscription_config?: RecurringCommit.SubscriptionConfig;
+
     /**
      * A temporary ID that can be used to reference the recurring commit for commit
      * specific overrides.
@@ -2617,8 +2646,8 @@ export namespace ContractCreateParams {
       unit_price: number;
 
       /**
-       * This field is currently required. Upcoming recurring commit/credit configuration
-       * options will allow it to be optional.
+       * This field is required unless a subscription is attached via
+       * `subscription_config`.
        */
       quantity?: number;
     }
@@ -2687,6 +2716,32 @@ export namespace ContractCreateParams {
        */
       product_tags?: Array<string>;
     }
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    export interface SubscriptionConfig {
+      apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+      /**
+       * ID of the subscription to configure on the recurring commit/credit.
+       */
+      subscription_id: string;
+
+      /**
+       * If set to POOLED, allocation added per seat is pooled across the account.
+       */
+      allocation?: 'POOLED';
+    }
+
+    export namespace SubscriptionConfig {
+      export interface ApplySeatIncreaseConfig {
+        /**
+         * Indicates whether a mid-period seat increase should be prorated.
+         */
+        is_prorated: boolean;
+      }
+    }
   }
 
   export interface RecurringCredit {
@@ -2784,6 +2839,11 @@ export namespace ContractCreateParams {
      */
     specifiers?: Array<RecurringCredit.Specifier>;
 
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    subscription_config?: RecurringCredit.SubscriptionConfig;
+
     /**
      * A temporary ID that can be used to reference the recurring commit for commit
      * specific overrides.
@@ -2801,8 +2861,8 @@ export namespace ContractCreateParams {
       unit_price: number;
 
       /**
-       * This field is currently required. Upcoming recurring commit/credit configuration
-       * options will allow it to be optional.
+       * This field is required unless a subscription is attached via
+       * `subscription_config`.
        */
       quantity?: number;
     }
@@ -2860,6 +2920,32 @@ export namespace ContractCreateParams {
        */
       product_tags?: Array<string>;
     }
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    export interface SubscriptionConfig {
+      apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+      /**
+       * ID of the subscription to configure on the recurring commit/credit.
+       */
+      subscription_id: string;
+
+      /**
+       * If set to POOLED, allocation added per seat is pooled across the account.
+       */
+      allocation?: 'POOLED';
+    }
+
+    export namespace SubscriptionConfig {
+      export interface ApplySeatIncreaseConfig {
+        /**
+         * Indicates whether a mid-period seat increase should be prorated.
+         */
+        is_prorated: boolean;
+      }
+    }
   }
 
   export interface ResellerRoyalty {
@@ -2914,6 +3000,8 @@ export namespace ContractCreateParams {
      */
     schedule: ScheduledCharge.Schedule;
 
+    custom_fields?: { [key: string]: string };
+
     /**
      * displayed on invoices
      */
@@ -2935,6 +3023,12 @@ export namespace ContractCreateParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -3149,15 +3243,22 @@ export namespace ContractCreateParams {
      * start date
      */
     starting_at?: string;
+
+    /**
+     * A temporary ID used to reference the subscription in recurring commit/credit
+     * subscription configs created within the same payload.
+     */
+    temporary_id?: string;
   }
 
   export namespace Subscription {
     export interface Proration {
       /**
-       * Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
-       * is selected, the quantity increase will be billed on the scheduled date. If
-       * BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed
-       * for in-arrears at the end of the period.
+       * Indicates how mid-period quantity adjustments are invoiced.
+       * **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
+       * quantity increase will be billed immediately on the scheduled date.
+       * **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
+       * in-arrears at the end of the period.
        */
       invoice_behavior?: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
 
@@ -3541,6 +3642,12 @@ export namespace ContractAmendParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -3688,6 +3795,18 @@ export namespace ContractAmendParams {
          * your payment type.
          */
         invoice_metadata?: { [key: string]: string };
+
+        /**
+         * If true, the payment will be made assuming the customer is present (i.e. on
+         * session).
+         *
+         * If false, the payment will be made assuming the customer is not present (i.e.
+         * off session). For cardholders from a country with an e-mandate requirement (e.g.
+         * India), the payment may be declined.
+         *
+         * If left blank, will default to false.
+         */
+        on_session_payment?: boolean;
       }
     }
 
@@ -3872,6 +3991,12 @@ export namespace ContractAmendParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -4214,6 +4339,8 @@ export namespace ContractAmendParams {
      */
     schedule: ScheduledCharge.Schedule;
 
+    custom_fields?: { [key: string]: string };
+
     /**
      * displayed on invoices
      */
@@ -4235,6 +4362,12 @@ export namespace ContractAmendParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and

package/src/resources/v1/contracts/products.ts

@@ -428,6 +428,8 @@ export interface ProductCreateParams {
    */
   composite_tags?: Array<string>;
 
+  custom_fields?: { [key: string]: string };
+
   /**
    * Beta feature only available for composite products. If true, products with $0
    * will not be included when computing composite usage. Defaults to false

package/src/resources/v1/customers/alerts.ts

@@ -137,6 +137,12 @@ export namespace CustomerAlert {
      */
     group_key_filter?: Alert.GroupKeyFilter;
 
+    /**
+     * Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+     * group key on individual line items.
+     */
+    group_values?: Array<Alert.GroupValue>;
+
     /**
      * Only supported for invoice_total_reached alerts. A list of invoice types to
      * evaluate.
@@ -169,6 +175,12 @@ export namespace CustomerAlert {
 
       value: string;
     }
+
+    export interface GroupValue {
+      key: string;
+
+      value: string;
+    }
   }
 }
 

package/src/resources/v1/customers/commits.ts

@@ -36,6 +36,7 @@ export class Commits extends APIResource {
    *         timestamp: '2020-03-01T00:00:00.000Z',
    *       },
    *     ],
+   *     do_not_invoice: false,
    *   },
    *   name: 'My Commit',
    * });
@@ -240,6 +241,12 @@ export namespace CommitCreateParams {
      */
     credit_type_id?: string;
 
+    /**
+     * This field is only applicable to commit invoice schedules. If true, this
+     * schedule will not generate an invoice.
+     */
+    do_not_invoice?: boolean;
+
     /**
      * Enter the unit price and quantity for the charge or instead only send the
      * amount. If amount is sent, the unit price is assumed to be the amount and

package/src/resources/v1/customers/invoices.ts

@@ -207,6 +207,15 @@ export namespace Invoice {
 
     total: number;
 
+    /**
+     * The type of line item. Possible values are 'aws_royalty',
+     * 'applied_commit_or_credit', 'scheduled', 'commit_purchase', 'cpu_conversion',
+     * 'discount', 'gcp_royalty', 'postpaid_trueup', 'professional_services',
+     * 'subscription', 'usage', 'legacy', 'minimum', 'product_charge',
+     * 'trial_discount', 'rollover', 'seat', 'grouped_charge'.
+     */
+    type: string;
+
     /**
      * Details about the credit or commit that was applied to this line item. Only
      * present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`

package/src/resources/v1/dashboards.ts

@@ -119,7 +119,9 @@ export namespace DashboardGetEmbeddableURLParams {
       | 'UsageLine_8'
       | 'UsageLine_9'
       | 'Primary_green'
-      | 'Primary_red';
+      | 'Primary_red'
+      | 'Progress_bar'
+      | 'Progress_bar_background';
 
     /**
      * Hex value representation of the color