@metronome/sdk 3.5.0 → 3.6.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,

package/src/resources/v1/packages.ts

@@ -1866,8 +1866,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>;

package/src/resources/v1/v1.ts

@@ -153,6 +153,8 @@ import {
   ContractListBalancesResponsesBodyCursorPage,
   ContractListParams,
   ContractListResponse,
+  ContractListSeatBalancesParams,
+  ContractListSeatBalancesResponse,
   ContractRetrieveParams,
   ContractRetrieveRateScheduleParams,
   ContractRetrieveRateScheduleResponse,
@@ -394,6 +396,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 +411,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,

package/src/resources/v2/contracts.ts

@@ -289,7 +289,7 @@ export namespace ContractGetEditHistoryResponse {
     /**
      * List of subscriptions on the contract.
      */
-    add_subscriptions?: Array<Shared.Subscription>;
+    add_subscriptions?: Array<Data.AddSubscription>;
 
     add_usage_filters?: Array<Data.AddUsageFilter>;
 
@@ -935,6 +935,130 @@ export namespace ContractGetEditHistoryResponse {
       }
     }
 
+    export interface AddSubscription {
+      /**
+       * Previous, current, and next billing periods for the subscription.
+       */
+      billing_periods: AddSubscription.BillingPeriods;
+
+      collection_schedule: 'ADVANCE' | 'ARREARS';
+
+      proration: AddSubscription.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<AddSubscription.QuantitySchedule>;
+
+      starting_at: string;
+
+      subscription_rate: AddSubscription.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?: AddSubscription.SeatConfig;
+    }
+
+    export namespace AddSubscription {
+      /**
+       * 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 AddUsageFilter {
       group_key: string;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.5.0'; // x-release-please-version
+export const VERSION = '3.6.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.5.0";
+export declare const VERSION = "3.6.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.5.0";
+export declare const VERSION = "3.6.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '3.5.0'; // x-release-please-version
+exports.VERSION = '3.6.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '3.5.0'; // x-release-please-version
+export const VERSION = '3.6.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map