@metronome/sdk 0.1.0 → 0.2.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.
@@ -2600,6 +2600,11 @@ export namespace ContractCreateParams {
2600
2600
  */
2601
2601
  specifiers?: Array<RecurringCommit.Specifier>;
2602
2602
 
2603
+ /**
2604
+ * Attach a subscription to the recurring commit/credit.
2605
+ */
2606
+ subscription_config?: RecurringCommit.SubscriptionConfig;
2607
+
2603
2608
  /**
2604
2609
  * A temporary ID that can be used to reference the recurring commit for commit
2605
2610
  * specific overrides.
@@ -2687,6 +2692,32 @@ export namespace ContractCreateParams {
2687
2692
  */
2688
2693
  product_tags?: Array<string>;
2689
2694
  }
2695
+
2696
+ /**
2697
+ * Attach a subscription to the recurring commit/credit.
2698
+ */
2699
+ export interface SubscriptionConfig {
2700
+ apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
2701
+
2702
+ /**
2703
+ * ID of the subscription to configure on the recurring commit/credit.
2704
+ */
2705
+ subscription_id: string;
2706
+
2707
+ /**
2708
+ * If set to POOLED, allocation added per seat is pooled across the account.
2709
+ */
2710
+ allocation?: 'POOLED';
2711
+ }
2712
+
2713
+ export namespace SubscriptionConfig {
2714
+ export interface ApplySeatIncreaseConfig {
2715
+ /**
2716
+ * Indicates whether a mid-period seat increase should be prorated.
2717
+ */
2718
+ is_prorated: boolean;
2719
+ }
2720
+ }
2690
2721
  }
2691
2722
 
2692
2723
  export interface RecurringCredit {
@@ -2784,6 +2815,11 @@ export namespace ContractCreateParams {
2784
2815
  */
2785
2816
  specifiers?: Array<RecurringCredit.Specifier>;
2786
2817
 
2818
+ /**
2819
+ * Attach a subscription to the recurring commit/credit.
2820
+ */
2821
+ subscription_config?: RecurringCredit.SubscriptionConfig;
2822
+
2787
2823
  /**
2788
2824
  * A temporary ID that can be used to reference the recurring commit for commit
2789
2825
  * specific overrides.
@@ -2860,6 +2896,32 @@ export namespace ContractCreateParams {
2860
2896
  */
2861
2897
  product_tags?: Array<string>;
2862
2898
  }
2899
+
2900
+ /**
2901
+ * Attach a subscription to the recurring commit/credit.
2902
+ */
2903
+ export interface SubscriptionConfig {
2904
+ apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
2905
+
2906
+ /**
2907
+ * ID of the subscription to configure on the recurring commit/credit.
2908
+ */
2909
+ subscription_id: string;
2910
+
2911
+ /**
2912
+ * If set to POOLED, allocation added per seat is pooled across the account.
2913
+ */
2914
+ allocation?: 'POOLED';
2915
+ }
2916
+
2917
+ export namespace SubscriptionConfig {
2918
+ export interface ApplySeatIncreaseConfig {
2919
+ /**
2920
+ * Indicates whether a mid-period seat increase should be prorated.
2921
+ */
2922
+ is_prorated: boolean;
2923
+ }
2924
+ }
2863
2925
  }
2864
2926
 
2865
2927
  export interface ResellerRoyalty {
@@ -3149,15 +3211,22 @@ export namespace ContractCreateParams {
3149
3211
  * start date
3150
3212
  */
3151
3213
  starting_at?: string;
3214
+
3215
+ /**
3216
+ * A temporary ID used to reference the subscription in recurring commit/credit
3217
+ * subscription configs created within the same payload.
3218
+ */
3219
+ temporary_id?: string;
3152
3220
  }
3153
3221
 
3154
3222
  export namespace Subscription {
3155
3223
  export interface Proration {
3156
3224
  /**
3157
- * Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
3158
- * is selected, the quantity increase will be billed on the scheduled date. If
3159
- * BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed
3160
- * for in-arrears at the end of the period.
3225
+ * Indicates how mid-period quantity adjustments are invoiced.
3226
+ * **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
3227
+ * quantity increase will be billed immediately on the scheduled date.
3228
+ * **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
3229
+ * in-arrears at the end of the period.
3161
3230
  */
3162
3231
  invoice_behavior?: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
3163
3232
 
@@ -137,6 +137,12 @@ export namespace CustomerAlert {
137
137
  */
138
138
  group_key_filter?: Alert.GroupKeyFilter;
139
139
 
140
+ /**
141
+ * Only present for `spend_threshold_reached` alerts. Scope alert to a specific
142
+ * group key on individual line items.
143
+ */
144
+ group_values?: Array<Alert.GroupValue>;
145
+
140
146
  /**
141
147
  * Only supported for invoice_total_reached alerts. A list of invoice types to
142
148
  * evaluate.
@@ -169,6 +175,12 @@ export namespace CustomerAlert {
169
175
 
170
176
  value: string;
171
177
  }
178
+
179
+ export interface GroupValue {
180
+ key: string;
181
+
182
+ value: string;
183
+ }
172
184
  }
173
185
  }
174
186
 
@@ -119,7 +119,9 @@ export namespace DashboardGetEmbeddableURLParams {
119
119
  | 'UsageLine_8'
120
120
  | 'UsageLine_9'
121
121
  | 'Primary_green'
122
- | 'Primary_red';
122
+ | 'Primary_red'
123
+ | 'Progress_bar'
124
+ | 'Progress_bar_background';
123
125
 
124
126
  /**
125
127
  * Hex value representation of the color