@metronome/sdk 3.5.0 → 3.7.0

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

@@ -10,6 +10,7 @@ export {
   type ContractCreateHistoricalInvoicesResponse,
   type ContractGetNetBalanceResponse,
   type ContractListBalancesResponse,
+  type ContractListSeatBalancesResponse,
   type ContractRetrieveRateScheduleResponse,
   type ContractRetrieveSubscriptionQuantityHistoryResponse,
   type ContractScheduleProServicesInvoiceResponse,
@@ -23,6 +24,7 @@ export {
   type ContractCreateHistoricalInvoicesParams,
   type ContractGetNetBalanceParams,
   type ContractListBalancesParams,
+  type ContractListSeatBalancesParams,
   type ContractRetrieveRateScheduleParams,
   type ContractRetrieveSubscriptionQuantityHistoryParams,
   type ContractScheduleProServicesInvoiceParams,

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

@@ -503,6 +503,16 @@ export interface ProductCreateParams {
    */
   quantity_rounding?: QuantityRounding | null;
 
+  /**
+   * Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
+   * If set to 'service_period' (default), the usage will be evaluated once for all
+   * events the invoice service period and the usage will be applied at the last
+   * instant of the invoice. If set to 'hour', it will be broken down and evaluated
+   * for each hour. For most use cases, 'hour' is recommended. The setting has no
+   * effect for Streaming Billable Metrics.
+   */
+  sql_breakdown_granularity?: 'HOUR' | 'SERVICE_PERIOD';
+
   tags?: Array<string>;
 }
 
@@ -604,6 +614,16 @@ export interface ProductUpdateParams {
    */
   quantity_rounding?: QuantityRounding | null;
 
+  /**
+   * Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
+   * If set to 'service_period' (default), the usage will be evaluated once for all
+   * events the invoice service period and the usage will be applied at the last
+   * instant of the invoice. If set to 'hour', it will be broken down and evaluated
+   * for each hour. For most use cases, 'hour' is recommended. The setting has no
+   * effect for Streaming Billable Metrics.
+   */
+  sql_breakdown_granularity?: 'HOUR' | 'SERVICE_PERIOD';
+
   /**
    * If not provided, defaults to product's current tags
    */

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

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

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

@@ -365,6 +365,8 @@ export interface Invoice {
 
   plan_name?: string;
 
+  regenerated_from_invoice_id?: string;
+
   /**
    * Only present for contract invoices with reseller royalties.
    */
@@ -1007,6 +1009,11 @@ export interface InvoiceListParams extends CursorPageParams {
    */
   customer_id: string;
 
+  /**
+   * Query param: Only return invoices for the specified contract
+   */
+  contract_id?: string;
+
   /**
    * Query param: Only return invoices for the specified credit type
    */
@@ -1040,6 +1047,11 @@ export interface InvoiceListParams extends CursorPageParams {
    * Query param: Invoice status, e.g. DRAFT, FINALIZED, or VOID
    */
   status?: string;
+
+  /**
+   * Query param: Filter invoices by type. Defaults to returning all invoice types.
+   */
+  type?: 'USAGE' | 'USAGE_CONSOLIDATED' | 'SCHEDULED';
 }
 
 export interface InvoiceAddChargeParams {

package/src/resources/v1/index.ts

@@ -35,6 +35,7 @@ export {
   type ContractCreateHistoricalInvoicesResponse,
   type ContractGetNetBalanceResponse,
   type ContractListBalancesResponse,
+  type ContractListSeatBalancesResponse,
   type ContractRetrieveRateScheduleResponse,
   type ContractRetrieveSubscriptionQuantityHistoryResponse,
   type ContractScheduleProServicesInvoiceResponse,
@@ -48,6 +49,7 @@ export {
   type ContractCreateHistoricalInvoicesParams,
   type ContractGetNetBalanceParams,
   type ContractListBalancesParams,
+  type ContractListSeatBalancesParams,
   type ContractRetrieveRateScheduleParams,
   type ContractRetrieveSubscriptionQuantityHistoryParams,
   type ContractScheduleProServicesInvoiceParams,
@@ -141,17 +143,6 @@ export {
   type PackageListResponsesCursorPage,
   type PackageListContractsOnPackageResponsesCursorPage,
 } from './packages';
-export {
-  Payments,
-  type Payment,
-  type PaymentStatus,
-  type PaymentAttemptResponse,
-  type PaymentCancelResponse,
-  type PaymentListParams,
-  type PaymentAttemptParams,
-  type PaymentCancelParams,
-  type PaymentsBodyCursorPage,
-} from './payments';
 export {
   Plans,
   type PlanDetail,

package/src/resources/v1/packages.ts

@@ -145,10 +145,9 @@ export class Packages extends APIResource {
    *
    * ### **Usage guidelines:**
    *
-   * Use the **`starting_at`**, **`covering_date`**,
-   * and **`include_archived`** parameters to filter the list of returned contracts.
-   * For example, to list only currently active contracts,
-   * pass **`covering_date`** equal to the current time.
+   * Use the **`starting_at`**, **`covering_date`**, and **`include_archived`**
+   * parameters to filter the list of returned contracts. For example, to list only
+   * currently active contracts, pass **`covering_date`** equal to the current time.
    *
    * @example
    * ```ts
@@ -259,6 +258,8 @@ export namespace PackageRetrieveResponse {
 
     spend_threshold_configuration?: Shared.SpendThresholdConfiguration;
 
+    spend_trackers?: Array<Data.SpendTracker>;
+
     subscriptions?: Array<Data.Subscription>;
 
     /**
@@ -924,6 +925,29 @@ export namespace PackageRetrieveResponse {
       }
     }
 
+    export interface SpendTracker {
+      /**
+       * Human-readable identifier, unique per contract.
+       */
+      alias: string;
+
+      applicable_spend_specifiers: Array<SpendTracker.ApplicableSpendSpecifier>;
+
+      credit_type_id: string;
+
+      reset_frequency: 'BILLING_PERIOD';
+    }
+
+    export namespace SpendTracker {
+      export interface ApplicableSpendSpecifier {
+        sources: Array<'THRESHOLD_RECHARGE' | 'MANUAL'>;
+
+        spend_type: 'COMMIT_PURCHASE';
+
+        discounted?: 'ANY' | 'DISCOUNTED_ONLY' | 'UNDISCOUNTED_ONLY';
+      }
+    }
+
     export interface Subscription {
       collection_schedule: 'ADVANCE' | 'ARREARS';
 
@@ -1086,6 +1110,8 @@ export interface PackageListResponse {
 
   spend_threshold_configuration?: Shared.SpendThresholdConfiguration;
 
+  spend_trackers?: Array<PackageListResponse.SpendTracker>;
+
   subscriptions?: Array<PackageListResponse.Subscription>;
 
   /**
@@ -1751,6 +1777,29 @@ export namespace PackageListResponse {
     }
   }
 
+  export interface SpendTracker {
+    /**
+     * Human-readable identifier, unique per contract.
+     */
+    alias: string;
+
+    applicable_spend_specifiers: Array<SpendTracker.ApplicableSpendSpecifier>;
+
+    credit_type_id: string;
+
+    reset_frequency: 'BILLING_PERIOD';
+  }
+
+  export namespace SpendTracker {
+    export interface ApplicableSpendSpecifier {
+      sources: Array<'THRESHOLD_RECHARGE' | 'MANUAL'>;
+
+      spend_type: 'COMMIT_PURCHASE';
+
+      discounted?: 'ANY' | 'DISCOUNTED_ONLY' | 'UNDISCOUNTED_ONLY';
+    }
+  }
+
   export interface Subscription {
     collection_schedule: 'ADVANCE' | 'ARREARS';
 
@@ -1866,8 +1915,6 @@ export interface PackageCreateParams {
    */
   aliases?: Array<PackageCreateParams.Alias>;
 
-  billing_anchor_date?: 'contract_start_date' | 'first_billing_period';
-
   billing_provider?: 'aws_marketplace' | 'azure_marketplace' | 'gcp_marketplace' | 'stripe' | 'netsuite';
 
   commits?: Array<PackageCreateParams.Commit>;
@@ -1919,6 +1966,8 @@ export interface PackageCreateParams {
 
   spend_threshold_configuration?: Shared.SpendThresholdConfiguration;
 
+  spend_trackers?: Array<PackageCreateParams.SpendTracker>;
+
   subscriptions?: Array<PackageCreateParams.Subscription>;
 
   /**
@@ -2840,6 +2889,32 @@ export namespace PackageCreateParams {
     }
   }
 
+  export interface SpendTracker {
+    /**
+     * Human-readable identifier, unique per contract.
+     */
+    alias: string;
+
+    applicable_spend_specifiers: Array<SpendTracker.ApplicableSpendSpecifier>;
+
+    credit_type_id: string;
+
+    reset_frequency: 'BILLING_PERIOD';
+  }
+
+  export namespace SpendTracker {
+    export interface ApplicableSpendSpecifier {
+      sources: Array<'THRESHOLD_RECHARGE' | 'MANUAL'>;
+
+      spend_type: 'COMMIT_PURCHASE';
+
+      /**
+       * Filter by whether the spend was discounted. Defaults to ANY if omitted.
+       */
+      discounted?: 'ANY' | 'DISCOUNTED_ONLY' | 'UNDISCOUNTED_ONLY';
+    }
+  }
+
   export interface Subscription {
     collection_schedule: 'ADVANCE' | 'ARREARS';
 

package/src/resources/v1/v1.ts

@@ -85,18 +85,6 @@ import {
   PackageRetrieveResponse,
   Packages,
 } from './packages';
-import * as PaymentsAPI from './payments';
-import {
-  Payment,
-  PaymentAttemptParams,
-  PaymentAttemptResponse,
-  PaymentCancelParams,
-  PaymentCancelResponse,
-  PaymentListParams,
-  PaymentStatus,
-  Payments,
-  PaymentsBodyCursorPage,
-} from './payments';
 import * as PlansAPI from './plans';
 import {
   PlanDetail,
@@ -153,6 +141,8 @@ import {
   ContractListBalancesResponsesBodyCursorPage,
   ContractListParams,
   ContractListResponse,
+  ContractListSeatBalancesParams,
+  ContractListSeatBalancesResponse,
   ContractRetrieveParams,
   ContractRetrieveRateScheduleParams,
   ContractRetrieveRateScheduleResponse,
@@ -220,7 +210,6 @@ export class V1 extends APIResource {
   invoices: InvoicesAPI.Invoices = new InvoicesAPI.Invoices(this._client);
   contracts: ContractsAPI.Contracts = new ContractsAPI.Contracts(this._client);
   packages: PackagesAPI.Packages = new PackagesAPI.Packages(this._client);
-  payments: PaymentsAPI.Payments = new PaymentsAPI.Payments(this._client);
   settings: SettingsAPI.Settings = new SettingsAPI.Settings(this._client);
 }
 
@@ -238,7 +227,6 @@ V1.Services = Services;
 V1.Invoices = Invoices;
 V1.Contracts = Contracts;
 V1.Packages = Packages;
-V1.Payments = Payments;
 V1.Settings = Settings;
 
 export declare namespace V1 {
@@ -394,6 +382,7 @@ export declare namespace V1 {
     type ContractCreateHistoricalInvoicesResponse as ContractCreateHistoricalInvoicesResponse,
     type ContractGetNetBalanceResponse as ContractGetNetBalanceResponse,
     type ContractListBalancesResponse as ContractListBalancesResponse,
+    type ContractListSeatBalancesResponse as ContractListSeatBalancesResponse,
     type ContractRetrieveRateScheduleResponse as ContractRetrieveRateScheduleResponse,
     type ContractRetrieveSubscriptionQuantityHistoryResponse as ContractRetrieveSubscriptionQuantityHistoryResponse,
     type ContractScheduleProServicesInvoiceResponse as ContractScheduleProServicesInvoiceResponse,
@@ -408,6 +397,7 @@ export declare namespace V1 {
     type ContractCreateHistoricalInvoicesParams as ContractCreateHistoricalInvoicesParams,
     type ContractGetNetBalanceParams as ContractGetNetBalanceParams,
     type ContractListBalancesParams as ContractListBalancesParams,
+    type ContractListSeatBalancesParams as ContractListSeatBalancesParams,
     type ContractRetrieveRateScheduleParams as ContractRetrieveRateScheduleParams,
     type ContractRetrieveSubscriptionQuantityHistoryParams as ContractRetrieveSubscriptionQuantityHistoryParams,
     type ContractScheduleProServicesInvoiceParams as ContractScheduleProServicesInvoiceParams,
@@ -431,18 +421,6 @@ export declare namespace V1 {
     type PackageListContractsOnPackageParams as PackageListContractsOnPackageParams,
   };
 
-  export {
-    Payments as Payments,
-    type Payment as Payment,
-    type PaymentStatus as PaymentStatus,
-    type PaymentAttemptResponse as PaymentAttemptResponse,
-    type PaymentCancelResponse as PaymentCancelResponse,
-    type PaymentsBodyCursorPage as PaymentsBodyCursorPage,
-    type PaymentListParams as PaymentListParams,
-    type PaymentAttemptParams as PaymentAttemptParams,
-    type PaymentCancelParams as PaymentCancelParams,
-  };
-
   export {
     Settings as Settings,
     type SettingUpsertAvalaraCredentialsResponse as SettingUpsertAvalaraCredentialsResponse,