@metronome/sdk 3.4.1 → 3.6.0

package/src/internal/utils/env.ts

@@ -9,10 +9,10 @@
  */
 export const readEnv = (env: string): string | undefined => {
   if (typeof (globalThis as any).process !== 'undefined') {
-    return (globalThis as any).process.env?.[env]?.trim() ?? undefined;
+    return (globalThis as any).process.env?.[env]?.trim() || undefined;
   }
   if (typeof (globalThis as any).Deno !== 'undefined') {
-    return (globalThis as any).Deno.env?.get?.(env)?.trim();
+    return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined;
   }
   return undefined;
 };

package/src/internal/utils/log.ts

@@ -107,6 +107,8 @@ export const formatRequestDetails = (details: {
           name,
           (
             name.toLowerCase() === 'authorization' ||
+            name.toLowerCase() === 'api-key' ||
+            name.toLowerCase() === 'x-api-key' ||
             name.toLowerCase() === 'cookie' ||
             name.toLowerCase() === 'set-cookie'
           ) ?

package/src/resources/shared.ts

@@ -34,6 +34,12 @@ export interface BaseThresholdCommit {
    * will default to the commit product name.
    */
   name?: string;
+
+  /**
+   * The priority of the commit, used to determine drawdown order. Lower priority
+   * commits are consumed first. Defaults to 100 if not specified.
+   */
+  priority?: number;
 }
 
 export interface BaseUsageFilter {
@@ -755,7 +761,7 @@ export interface ContractV2 {
   /**
    * List of subscriptions on the contract.
    */
-  subscriptions?: Array<Subscription>;
+  subscriptions?: Array<ContractV2.Subscription>;
 
   total_contract_value?: number;
 
@@ -1081,6 +1087,8 @@ export namespace ContractV2 {
   export interface Override {
     id: string;
 
+    created_at: string;
+
     starting_at: string;
 
     applicable_product_tags?: Array<string>;
@@ -1123,8 +1131,6 @@ export namespace ContractV2 {
       product_tags?: Array<string>;
 
       recurring_commit_ids?: Array<string>;
-
-      recurring_credit_ids?: Array<string>;
     }
 
     export interface OverwriteRate {
@@ -1221,6 +1227,8 @@ export namespace ContractV2 {
 
     applicable_product_tags?: Array<string>;
 
+    archived_at?: string;
+
     /**
      * The current balance of the credit or commit. This balance reflects the amount of
      * credit or commit that the customer has access to use at this moment - thus,
@@ -1267,6 +1275,7 @@ export namespace ContractV2 {
       | Credit.CreditCreditedLedgerEntry
       | Credit.CreditManualLedgerEntry
       | Credit.CreditSeatBasedAdjustmentLedgerEntry
+      | Credit.CreditRolloverLedgerEntry
     >;
 
     name?: string;
@@ -1287,6 +1296,8 @@ export namespace ContractV2 {
      */
     recurring_credit_id?: string;
 
+    rolled_over_from?: Credit.RolledOverFrom;
+
     /**
      * This field's availability is dependent on your client's configuration.
      */
@@ -1397,6 +1408,24 @@ export namespace ContractV2 {
 
       type: 'CREDIT_SEAT_BASED_ADJUSTMENT';
     }
+
+    export interface CreditRolloverLedgerEntry {
+      amount: number;
+
+      new_contract_id: string;
+
+      segment_id: string;
+
+      timestamp: string;
+
+      type: 'CREDIT_ROLLOVER';
+    }
+
+    export interface RolledOverFrom {
+      contract_id: string;
+
+      credit_id: string;
+    }
   }
 
   /**
@@ -1828,6 +1857,130 @@ export namespace ContractV2 {
       reseller_contract_value?: number;
     }
   }
+
+  export interface Subscription {
+    /**
+     * Previous, current, and next billing periods for the subscription.
+     */
+    billing_periods: Subscription.BillingPeriods;
+
+    collection_schedule: 'ADVANCE' | 'ARREARS';
+
+    proration: Subscription.Proration;
+
+    /**
+     * Determines how the subscription's quantity is controlled. Defaults to
+     * QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
+     * directly on the subscription. `initial_quantity` must be provided with this
+     * option. Compatible with recurring commits/credits that use POOLED allocation.
+     * **SEAT_BASED**: Use when you want to pass specific seat identifiers (e.g. add
+     * user_123) to increment and decrement a subscription quantity, rather than
+     * directly providing the quantity. You must use a **SEAT_BASED** subscription to
+     * use a linked recurring credit with an allocation per seat. `seat_config` must be
+     * provided with this option.
+     */
+    quantity_management_mode: 'SEAT_BASED' | 'QUANTITY_ONLY';
+
+    /**
+     * List of quantity schedule items for the subscription. Only includes the current
+     * quantity and future quantity changes.
+     */
+    quantity_schedule: Array<Subscription.QuantitySchedule>;
+
+    starting_at: string;
+
+    subscription_rate: Subscription.SubscriptionRate;
+
+    id?: string;
+
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    custom_fields?: { [key: string]: string };
+
+    description?: string;
+
+    ending_before?: string;
+
+    fiat_credit_type_id?: string;
+
+    name?: string;
+
+    seat_config?: Subscription.SeatConfig;
+  }
+
+  export namespace Subscription {
+    /**
+     * Previous, current, and next billing periods for the subscription.
+     */
+    export interface BillingPeriods {
+      current?: BillingPeriods.Current;
+
+      next?: BillingPeriods.Next;
+
+      previous?: BillingPeriods.Previous;
+    }
+
+    export namespace BillingPeriods {
+      export interface Current {
+        ending_before: string;
+
+        starting_at: string;
+      }
+
+      export interface Next {
+        ending_before: string;
+
+        starting_at: string;
+      }
+
+      export interface Previous {
+        ending_before: string;
+
+        starting_at: string;
+      }
+    }
+
+    export interface Proration {
+      invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
+
+      is_prorated: boolean;
+    }
+
+    export interface QuantitySchedule {
+      quantity: number;
+
+      starting_at: string;
+
+      ending_before?: string;
+    }
+
+    export interface SubscriptionRate {
+      billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+
+      product: SubscriptionRate.Product;
+    }
+
+    export namespace SubscriptionRate {
+      export interface Product {
+        id: string;
+
+        name: string;
+      }
+    }
+
+    export interface SeatConfig {
+      /**
+       * The property name, sent on usage events, that identifies the seat ID associated
+       * with the usage event. For example, the property name might be seat_id or
+       * user_id. The property must be set as a group key on billable metrics and a
+       * presentation/pricing group key on contract products. This allows linked
+       * recurring credits with an allocation per seat to be consumed by only one seat's
+       * usage.
+       */
+      seat_group_key: string;
+    }
+  }
 }
 
 export interface ContractWithoutAmendments {
@@ -2318,6 +2471,7 @@ export interface Credit {
     | Credit.CreditCreditedLedgerEntry
     | Credit.CreditManualLedgerEntry
     | Credit.CreditSeatBasedAdjustmentLedgerEntry
+    | Credit.CreditRolloverLedgerEntry
   >;
 
   name?: string;
@@ -2341,6 +2495,8 @@ export interface Credit {
    */
   recurring_credit_id?: string;
 
+  rolled_over_from?: Credit.RolledOverFrom;
+
   /**
    * This field's availability is dependent on your client's configuration.
    */
@@ -2461,6 +2617,24 @@ export namespace Credit {
     type: 'CREDIT_SEAT_BASED_ADJUSTMENT';
   }
 
+  export interface CreditRolloverLedgerEntry {
+    amount: number;
+
+    new_contract_id: string;
+
+    segment_id: string;
+
+    timestamp: string;
+
+    type: 'CREDIT_ROLLOVER';
+  }
+
+  export interface RolledOverFrom {
+    contract_id: string;
+
+    credit_id: string;
+  }
+
   /**
    * The subscription configuration for this credit, if it was generated from a
    * recurring credit with a subscription attached.
@@ -2622,6 +2796,8 @@ export interface ID {
 export interface Override {
   id: string;
 
+  created_at: string;
+
   starting_at: string;
 
   applicable_product_tags?: Array<string>;
@@ -2696,8 +2872,6 @@ export namespace Override {
     product_tags?: Array<string>;
 
     recurring_commit_ids?: Array<string>;
-
-    recurring_credit_ids?: Array<string>;
   }
 
   export interface Product {
@@ -2899,6 +3073,8 @@ export interface PrepaidBalanceThresholdConfiguration {
    * commit amount will be in terms of this credit type instead of the fiat currency.
    */
   custom_credit_type_id?: string;
+
+  discount_configuration?: PrepaidBalanceThresholdConfiguration.DiscountConfiguration;
 }
 
 export namespace PrepaidBalanceThresholdConfiguration {
@@ -2925,6 +3101,15 @@ export namespace PrepaidBalanceThresholdConfiguration {
      */
     specifiers?: Array<Shared.CommitSpecifierInput>;
   }
+
+  export interface DiscountConfiguration {
+    /**
+     * The fraction of the original amount that the customer pays after applying the
+     * discount. For example, 0.85 means the customer pays 85% of the original amount
+     * (a 15% discount).
+     */
+    payment_fraction: number;
+  }
 }
 
 export interface PrepaidBalanceThresholdConfigurationV2 {
@@ -2955,10 +3140,12 @@ export interface PrepaidBalanceThresholdConfigurationV2 {
    * commit amount will be in terms of this credit type instead of the fiat currency.
    */
   custom_credit_type_id?: string;
+
+  discount_configuration?: PrepaidBalanceThresholdConfigurationV2.DiscountConfiguration;
 }
 
 export namespace PrepaidBalanceThresholdConfigurationV2 {
-  export interface Commit extends Shared.UpdateBaseThresholdCommit {
+  export interface Commit extends Shared.BaseThresholdCommit {
     /**
      * Which products the threshold commit applies to. If applicable_product_ids,
      * applicable_product_tags or specifiers are not provided, the commit applies to
@@ -2983,6 +3170,15 @@ export namespace PrepaidBalanceThresholdConfigurationV2 {
      */
     specifiers?: Array<Shared.CommitSpecifierInput>;
   }
+
+  export interface DiscountConfiguration {
+    /**
+     * The fraction of the original amount that the customer pays after applying the
+     * discount. For example, 0.85 means the customer pays 85% of the original amount
+     * (a 15% discount).
+     */
+    payment_fraction: number;
+  }
 }
 
 export interface PropertyFilter {
@@ -3204,10 +3400,23 @@ export interface SpendThresholdConfiguration {
    * hits this amount, a threshold charge will be initiated.
    */
   threshold_amount: number;
+
+  discount_configuration?: SpendThresholdConfiguration.DiscountConfiguration;
+}
+
+export namespace SpendThresholdConfiguration {
+  export interface DiscountConfiguration {
+    /**
+     * The fraction of the original amount that the customer pays after applying the
+     * discount. For example, 0.85 means the customer pays 85% of the original amount
+     * (a 15% discount).
+     */
+    payment_fraction: number;
+  }
 }
 
 export interface SpendThresholdConfigurationV2 {
-  commit: UpdateBaseThresholdCommit;
+  commit: BaseThresholdCommit;
 
   /**
    * When set to false, the contract will not be evaluated against the
@@ -3223,6 +3432,19 @@ export interface SpendThresholdConfigurationV2 {
    * hits this amount, a threshold charge will be initiated.
    */
   threshold_amount: number;
+
+  discount_configuration?: SpendThresholdConfigurationV2.DiscountConfiguration;
+}
+
+export namespace SpendThresholdConfigurationV2 {
+  export interface DiscountConfiguration {
+    /**
+     * The fraction of the original amount that the customer pays after applying the
+     * discount. For example, 0.85 means the customer pays 85% of the original amount
+     * (a 15% discount).
+     */
+    payment_fraction: number;
+  }
 }
 
 export interface Subscription {
@@ -3364,6 +3586,13 @@ export interface UpdateBaseThresholdCommit {
    */
   name?: string;
 
+  /**
+   * The priority of the commit, used to determine drawdown order. Lower priority
+   * commits are consumed first. Defaults to 100 if not specified. On updates, set to
+   * null to clear a previously configured priority.
+   */
+  priority?: number | null;
+
   /**
    * The commit product that will be used to generate the line item for commit
    * payment.

package/src/resources/v1/alerts.ts

@@ -229,7 +229,7 @@ export interface AlertCreateParams {
 
 export namespace AlertCreateParams {
   export interface CustomFieldFilter {
-    entity: 'Contract' | 'Commit' | 'ContractCredit';
+    entity: 'Contract' | 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
 
     key: string;