@metronome/sdk 0.1.0-alpha.2 → 0.1.0-alpha.4

package/src/resources/custom-fields.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as CustomFieldsAPI from "./custom-fields";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as CustomFieldsAPI from './custom-fields';
 
 export class CustomFields extends APIResource {
   /**

package/src/resources/customers/alerts.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import * as AlertsAPI from "./alerts";
-import * as Shared from "../shared";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as AlertsAPI from './alerts';
+import * as Shared from '../shared';
 
 export class Alerts extends APIResource {
   /**
@@ -87,6 +87,7 @@ export namespace CustomerAlert {
       | 'low_remaining_days_for_contract_credit_segment_reached'
       | 'low_remaining_contract_credit_balance_reached'
       | 'low_remaining_contract_credit_percentage_reached'
+      | 'low_remaining_contract_credit_and_commit_balance_reached'
       | 'invoice_total_reached';
 
     /**
@@ -94,6 +95,13 @@ export namespace CustomerAlert {
      */
     updated_at: string;
 
+    /**
+     * An array of strings, representing a way to filter the credit grant this alert
+     * applies to, by looking at the credit_grant_type field on the credit grant. This
+     * field is only defined for CreditPercentage and CreditBalance alerts
+     */
+    credit_grant_type_filters?: Array<string>;
+
     credit_type?: Shared.CreditType | null;
 
     /**

package/src/resources/customers/billing-config.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import * as BillingConfigAPI from "./billing-config";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as BillingConfigAPI from './billing-config';
 
 export class BillingConfig extends APIResource {
   /**

package/src/resources/customers/customers.ts

@@ -1,15 +1,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import { isRequestOptions } from "../../core";
-import * as CustomersAPI from "./customers";
-import * as Shared from "../shared";
-import * as AlertsAPI from "./alerts";
-import * as BillingConfigAPI from "./billing-config";
-import * as InvoicesAPI from "./invoices";
-import * as PlansAPI from "./plans";
-import { CursorPage, type CursorPageParams } from "../../pagination";
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as CustomersAPI from './customers';
+import * as Shared from '../shared';
+import * as AlertsAPI from './alerts';
+import * as BillingConfigAPI from './billing-config';
+import * as InvoicesAPI from './invoices';
+import * as PlansAPI from './plans';
+import { CursorPage, type CursorPageParams } from '../../pagination';
 
 export class Customers extends APIResource {
   alerts: AlertsAPI.Alerts = new AlertsAPI.Alerts(this._client);
@@ -60,7 +60,7 @@ export class Customers extends APIResource {
   }
 
   /**
-   * List all billable metrics.
+   * Get all billable metrics for a given customer.
    */
   listBillableMetrics(
     customerId: string,
@@ -190,8 +190,6 @@ export interface CustomerDetail {
    */
   id: string;
 
-  current_billable_status: CustomerDetail.CurrentBillableStatus;
-
   custom_fields: Record<string, string>;
 
   customer_config: CustomerDetail.CustomerConfig;
@@ -209,21 +207,29 @@ export interface CustomerDetail {
   ingest_aliases: Array<string>;
 
   name: string;
+
+  /**
+   * This field's availability is dependent on your client's configuration.
+   */
+  current_billable_status?: CustomerDetail.CurrentBillableStatus;
 }
 
 export namespace CustomerDetail {
-  export interface CurrentBillableStatus {
-    value: 'billable' | 'unbillable';
-
-    effective_at?: string | null;
-  }
-
   export interface CustomerConfig {
     /**
      * The Salesforce account ID for the customer
      */
     salesforce_account_id: string | null;
   }
+
+  /**
+   * This field's availability is dependent on your client's configuration.
+   */
+  export interface CurrentBillableStatus {
+    value: 'billable' | 'unbillable';
+
+    effective_at?: string | null;
+  }
 }
 
 export interface CustomerCreateResponse {
@@ -243,7 +249,124 @@ export interface CustomerListBillableMetricsResponse {
 
   name: string;
 
+  /**
+   * (DEPRECATED) use aggregation_type instead
+   */
+  aggregate?: string;
+
+  /**
+   * (DEPRECATED) use aggregation_key instead
+   */
+  aggregate_keys?: Array<string>;
+
+  /**
+   * A key that specifies which property of the event is used to aggregate data. This
+   * key must be one of the property filter names and is not applicable when the
+   * aggregation type is 'count'.
+   */
+  aggregation_key?: string;
+
+  /**
+   * Specifies the type of aggregation performed on matching events.
+   */
+  aggregation_type?:
+    | 'count'
+    | 'Count'
+    | 'COUNT'
+    | 'latest'
+    | 'Latest'
+    | 'LATEST'
+    | 'max'
+    | 'Max'
+    | 'MAX'
+    | 'sum'
+    | 'Sum'
+    | 'SUM'
+    | 'unique'
+    | 'Unique'
+    | 'UNIQUE';
+
+  custom_fields?: Record<string, string>;
+
+  /**
+   * An optional filtering rule to match the 'event_type' property of an event.
+   */
+  event_type_filter?: CustomerListBillableMetricsResponse.EventTypeFilter;
+
+  /**
+   * (DEPRECATED) use property_filters & event_type_filter instead
+   */
+  filter?: Record<string, unknown>;
+
+  /**
+   * (DEPRECATED) use group_keys instead
+   */
   group_by?: Array<string>;
+
+  /**
+   * Property names that are used to group usage costs on an invoice. Each entry
+   * represents a set of properties used to slice events into distinct buckets.
+   */
+  group_keys?: Array<Array<string>>;
+
+  /**
+   * A list of filters to match events to this billable metric. Each filter defines a
+   * rule on an event property. All rules must pass for the event to match the
+   * billable metric.
+   */
+  property_filters?: Array<CustomerListBillableMetricsResponse.PropertyFilter>;
+}
+
+export namespace CustomerListBillableMetricsResponse {
+  /**
+   * An optional filtering rule to match the 'event_type' property of an event.
+   */
+  export interface EventTypeFilter {
+    /**
+     * A list of event types that are explicitly included in the billable metric. If
+     * specified, only events of these types will match the billable metric. Must be
+     * non-empty if present.
+     */
+    in_values?: Array<string>;
+
+    /**
+     * A list of event types that are explicitly excluded from the billable metric. If
+     * specified, events of these types will not match the billable metric. Must be
+     * non-empty if present.
+     */
+    not_in_values?: Array<string>;
+  }
+
+  export interface PropertyFilter {
+    /**
+     * The name of the event property.
+     */
+    name: string;
+
+    /**
+     * Determines whether the property must exist in the event. If true, only events
+     * with this property will pass the filter. If false, only events without this
+     * property will pass the filter. If null or omitted, the existence of the property
+     * is optional.
+     */
+    exists?: boolean;
+
+    /**
+     * Specifies the allowed values for the property to match an event. An event will
+     * pass the filter only if its property value is included in this list. If
+     * undefined, all property values will pass the filter. Must be non-empty if
+     * present.
+     */
+    in_values?: Array<string>;
+
+    /**
+     * Specifies the values that prevent an event from matching the filter. An event
+     * will not pass the filter if its property value is included in this list. If null
+     * or empty, all property values will pass the filter. Must be non-empty if
+     * present.
+     */
+    not_in_values?: Array<string>;
+  }
 }
 
 export interface CustomerListCostsResponse {
@@ -281,6 +404,9 @@ export interface CustomerSetNameResponse {
 }
 
 export interface CustomerCreateParams {
+  /**
+   * This will be truncated to 160 characters if the provided name is longer.
+   */
   name: string;
 
   billing_config?: CustomerCreateParams.BillingConfig;
@@ -399,7 +525,8 @@ export interface CustomerSetIngestAliasesParams {
 
 export interface CustomerSetNameParams {
   /**
-   * The new name for the customer
+   * The new name for the customer. This will be truncated to 160 characters if the
+   * provided name is longer.
    */
   name: string;
 }

package/src/resources/customers/invoices.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import { isRequestOptions } from "../../core";
-import * as InvoicesAPI from "./invoices";
-import * as Shared from "../shared";
-import { CursorPage, type CursorPageParams } from "../../pagination";
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as InvoicesAPI from './invoices';
+import * as Shared from '../shared';
+import { CursorPage, type CursorPageParams } from '../../pagination';
 
 export class Invoices extends APIResource {
   /**
@@ -75,8 +75,6 @@ export class InvoicesCursorPage extends CursorPage<Invoice> {}
 export interface Invoice {
   id: string;
 
-  billable_status: 'billable' | 'unbillable';
-
   credit_type: Shared.CreditType;
 
   customer_id: string;
@@ -91,6 +89,11 @@ export interface Invoice {
 
   amendment_id?: string;
 
+  /**
+   * This field's availability is dependent on your client's configuration.
+   */
+  billable_status?: 'billable' | 'unbillable';
+
   contract_custom_fields?: Record<string, string>;
 
   contract_id?: string;
@@ -298,16 +301,40 @@ export namespace Invoice {
 
       credit_grant_id?: string;
 
+      /**
+       * The end date for the charge (for seats charges only).
+       */
+      end_date?: string;
+
       /**
        * the unit price for this charge, present only if the charge is not tiered and the
        * quantity is nonzero
        */
       price?: number;
 
+      /**
+       * The start date for the charge (for seats charges only).
+       */
+      start_date?: string;
+
+      /**
+       * when the current tier started and ends (for tiered charges only)
+       */
+      tier_period?: SubLineItem.TierPeriod;
+
       tiers?: Array<SubLineItem.Tier>;
     }
 
     export namespace SubLineItem {
+      /**
+       * when the current tier started and ends (for tiered charges only)
+       */
+      export interface TierPeriod {
+        starting_at: string;
+
+        ending_before?: string;
+      }
+
       export interface Tier {
         price: number;
 
@@ -400,6 +427,8 @@ export namespace Invoice {
 
     total: number;
 
+    credit_grant_custom_fields?: Record<string, string>;
+
     credit_grant_id?: string;
   }
 

package/src/resources/customers/plans.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import { isRequestOptions } from "../../core";
-import * as PlansAPI from "./plans";
-import * as Shared from "../shared";
-import { CursorPage, type CursorPageParams } from "../../pagination";
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as PlansAPI from './plans';
+import * as Shared from '../shared';
+import { CursorPage, type CursorPageParams } from '../../pagination';
 
 export class Plans extends APIResource {
   /**

package/src/resources/dashboards.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import * as DashboardsAPI from "./dashboards";
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as DashboardsAPI from './dashboards';
 
 export class Dashboards extends APIResource {
   /**

package/src/resources/plans.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as PlansAPI from "./plans";
-import * as Shared from "./shared";
-import * as CustomersAPI from "./customers/customers";
-import { CursorPage, type CursorPageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as PlansAPI from './plans';
+import * as Shared from './shared';
+import * as CustomersAPI from './customers/customers';
+import { CursorPage, type CursorPageParams } from '../pagination';
 
 export class Plans extends APIResource {
   /**
@@ -203,6 +203,12 @@ export interface PlanListChargesResponse {
    */
   start_period?: number;
 
+  /**
+   * Used in pricing tiers. Indicates how often the tier resets. Default is 1 - the
+   * tier count resets every billing period.
+   */
+  tier_reset_frequency?: number;
+
   /**
    * Specifies how quantities for usage based charges will be converted.
    */

package/src/resources/services.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import * as ServicesAPI from "./services";
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as ServicesAPI from './services';
 
 export class Services extends APIResource {
   /**

package/src/resources/shared.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Shared from "./shared";
+import * as Shared from './shared';
 
 export interface Commit {
   id: string;
@@ -348,6 +348,9 @@ export interface ContractWithoutAmendments {
    */
   salesforce_opportunity_id?: string;
 
+  /**
+   * This field's availability is dependent on your client's configuration.
+   */
   total_contract_value?: number;
 
   usage_filter?: ContractWithoutAmendments.UsageFilter;
@@ -751,6 +754,8 @@ export interface Rate {
     | 'TIERED'
     | 'tiered';
 
+  credit_type?: CreditType;
+
   /**
    * Only set for CUSTOM rate_type. This field is interpreted by custom rate
    * processors.

package/src/resources/usage.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import * as UsageAPI from "./usage";
-import { CursorPage, type CursorPageParams } from "../pagination";
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as UsageAPI from './usage';
+import { CursorPage, type CursorPageParams } from '../pagination';
 
 export class Usage extends APIResource {
   /**

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-alpha.2'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.4'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.2";
+export declare const VERSION = "0.1.0-alpha.4";
 //# 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 = '0.1.0-alpha.2'; // x-release-please-version
+exports.VERSION = '0.1.0-alpha.4'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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