npm - @vantage-sh/vantage-client - Versions diffs - 2.8.0 → 2.10.0 - Mend

@vantage-sh/vantage-client 2.8.0 → 2.10.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.

Files changed (3) hide show

package/dist/index.d.mts CHANGED Viewed

@@ -3591,6 +3591,14 @@ interface components {
                  * @enum {string}
                  */
                 unit_scale?: "per_unit" | "per_hundred" | "per_thousand" | "per_million" | "per_billion";
+                /**
+                 * @description The calculation type applied when this BusinessMetric is used in the CostReport.
+                 * @default unit_cost
+                 * @enum {string}
+                 */
+                calculation_type?: "unit_cost" | "gross_margin" | "usage_unit_cost" | "raw_business_metric";
+                /** @description Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type. */
+                label?: string;
                 /** @description Include only values with these labels in the CostReport. */
                 label_filter?: string[];
                 /**
@@ -3668,6 +3676,14 @@ interface components {
                  * @enum {string}
                  */
                 unit_scale?: "per_unit" | "per_hundred" | "per_thousand" | "per_million" | "per_billion";
+                /**
+                 * @description The calculation type applied when this BusinessMetric is used in the CostReport.
+                 * @default unit_cost
+                 * @enum {string}
+                 */
+                calculation_type?: "unit_cost" | "gross_margin" | "usage_unit_cost" | "raw_business_metric";
+                /** @description Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type. */
+                label?: string;
                 /** @description Include only values with these labels in the CostReport. */
                 label_filter?: string[];
                 /**
@@ -3964,13 +3980,7 @@ interface components {
             saved_filter_tokens?: string[] | null;
             /** @description The tokens for the BusinessMetrics assigned to the CostReport, the unit scale, and label filter. */
             business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-            /**
-             * @description The default forecast selection for the CostReport.
-             * @example {
-             *       "kind": "baseline"
-             *     }
-             */
-            default_forecast: Record<string, any>;
+            default_forecast: components["schemas"]["DefaultForecast"];
             /** @description The filter applied to the CostReport. Additional documentation available at https://docs.vantage.sh/vql. */
             filter: string | null;
             /**
@@ -4011,12 +4021,13 @@ interface components {
                  */
                 unallocated?: boolean | null;
                 /**
-                 * @description Report will aggregate by cost or usage.
+                 * @description Report will aggregate by cost, usage, or count.
                  * @default cost
+                 * @enum {string|null}
                  */
-                aggregate_by?: string | null;
+                aggregate_by?: "cost" | "usage" | "count" | null;
                 /**
-                 * @description Report will show previous period costs or usage comparison.
+                 * @description Report will show previous period cost, usage, or count comparison.
                  * @default true
                  */
                 show_previous_period?: boolean | null;
@@ -4098,11 +4109,25 @@ interface components {
              *       ]
              *     }
              */
-            label_filters?: Record<string, any> | null;
+            label_filters?: {
+                [key: string]: string[];
+            } | null;
+        };
+        DefaultForecast: {
+            /**
+             * @description The default forecast selection kind.
+             * @enum {string}
+             */
+            kind: "baseline" | "report_forecast";
+            /** @description The token for the report forecast selected as the default. */
+            report_forecast_token?: string | null;
         };
         ChartSettings: {
-            /** @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'. */
-            y_axis_dimension: string;
+            /**
+             * @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
+             * @enum {string}
+             */
+            y_axis_dimension: "cost" | "usage" | "count";
             /** @description The dimension used to group or label data along the x-axis (e.g., by date, region, or service). NOTE: Only one value is allowed at this time. Defaults to ['date']. */
             x_axis_dimension: string[];
         };
@@ -4162,6 +4187,14 @@ interface components {
                  * @enum {string}
                  */
                 unit_scale?: "per_unit" | "per_hundred" | "per_thousand" | "per_million" | "per_billion";
+                /**
+                 * @description The calculation type applied when this BusinessMetric is used in the CostReport.
+                 * @default unit_cost
+                 * @enum {string}
+                 */
+                calculation_type?: "unit_cost" | "gross_margin" | "usage_unit_cost" | "raw_business_metric";
+                /** @description Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type. */
+                label?: string;
                 /** @description Include only values with these labels in the CostReport. */
                 label_filter?: string[];
                 /**
@@ -4215,12 +4248,13 @@ interface components {
                  */
                 unallocated?: boolean;
                 /**
-                 * @description Report will aggregate by cost or usage.
+                 * @description Report will aggregate by cost, usage, or count.
                  * @default cost
+                 * @enum {string}
                  */
-                aggregate_by?: string;
+                aggregate_by?: "cost" | "usage" | "count";
                 /**
-                 * @description Report will show previous period costs or usage comparison.
+                 * @description Report will show previous period cost, usage, or count comparison.
                  * @default true
                  */
                 show_previous_period?: boolean;
@@ -4259,8 +4293,11 @@ interface components {
             chart_settings?: {
                 /** @description The dimension used to group or label data along the x-axis (e.g., by date, region, or service). NOTE: Only one value is allowed at this time. Defaults to ['date']. */
                 x_axis_dimension?: string[];
-                /** @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'. */
-                y_axis_dimension?: string;
+                /**
+                 * @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
+                 * @enum {string}
+                 */
+                y_axis_dimension?: "cost" | "usage" | "count";
             };
         };
         /** @description Update a CostReport. */
@@ -4283,6 +4320,14 @@ interface components {
                  * @enum {string}
                  */
                 unit_scale?: "per_unit" | "per_hundred" | "per_thousand" | "per_million" | "per_billion";
+                /**
+                 * @description The calculation type applied when this BusinessMetric is used in the CostReport.
+                 * @default unit_cost
+                 * @enum {string}
+                 */
+                calculation_type?: "unit_cost" | "gross_margin" | "usage_unit_cost" | "raw_business_metric";
+                /** @description Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type. */
+                label?: string;
                 /** @description Include only values with these labels in the CostReport. */
                 label_filter?: string[];
                 /**
@@ -4327,9 +4372,12 @@ interface components {
                 amortize?: boolean | null;
                 /** @description Report will show unallocated costs. */
                 unallocated?: boolean | null;
-                /** @description Report will aggregate by cost or usage. */
-                aggregate_by?: string | null;
-                /** @description Report will show previous period costs or usage comparison. */
+                /**
+                 * @description Report will aggregate by cost, usage, or count.
+                 * @enum {string|null}
+                 */
+                aggregate_by?: "cost" | "usage" | "count" | null;
+                /** @description Report will show previous period cost, usage, or count comparison. */
                 show_previous_period?: boolean | null;
                 /** @description Report will restrict date ranges to completed periods only. */
                 complete_period?: boolean;
@@ -4338,8 +4386,11 @@ interface components {
             chart_settings?: {
                 /** @description The dimension used to group or label data along the x-axis (e.g., by date, region, or service). NOTE: Only one value is allowed at this time. Defaults to ['date']. */
                 x_axis_dimension?: string[];
-                /** @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'. */
-                y_axis_dimension?: string;
+                /**
+                 * @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
+                 * @enum {string}
+                 */
+                y_axis_dimension?: "cost" | "usage" | "count";
             };
             /** @description The previous period start date of the CostReport. ISO 8601 Formatted. */
             previous_period_start_date?: string;
@@ -4423,12 +4474,13 @@ interface components {
                  */
                 unallocated?: boolean;
                 /**
-                 * @description Results will aggregate by cost or usage.
+                 * @description Results will aggregate by cost, usage, or count.
                  * @default cost
+                 * @enum {string}
                  */
-                aggregate_by?: string;
+                aggregate_by?: "cost" | "usage" | "count";
                 /**
-                 * @description Results will show previous period costs or usage comparison.
+                 * @description Results will show previous period cost, usage, or count comparison.
                  * @default true
                  */
                 show_previous_period?: boolean;
@@ -4440,6 +4492,13 @@ interface components {
             total_cost: components["schemas"]["CostPartial"];
             /** @description The sum of all usage for the CostReport for the requested period, rounded to 2 decimal places, grouped by usage unit. */
             total_usage?: components["schemas"]["UsagePartial"][];
+            /**
+             * Format: int64
+             * @description The sum of the date-binned counts. Present when settings.aggregate_by is 'count'.
+             */
+            total_count?: number | null;
+            /** @description Distinct Group By permutation counts for the full requested period, unaffected by page and limit. Bins without cost are omitted. Present when settings.aggregate_by is 'count'. */
+            counts?: components["schemas"]["CostCount"][];
             costs: components["schemas"]["Cost"][];
         };
         CostPartial: {
@@ -4466,6 +4525,19 @@ interface components {
              */
             unit: string;
         };
+        CostCount: {
+            /**
+             * @description The date bin for the count. ISO 8601 Formatted.
+             * @example 2023-09-05+00:00
+             */
+            accrued_at: string;
+            /**
+             * Format: int64
+             * @description The number of distinct Group By permutations carrying cost in the date bin.
+             * @example 2
+             */
+            count: number;
+        };
         /** @description Cost model */
         Cost: {
             links?: components["schemas"]["Links"];
@@ -10534,9 +10606,9 @@ interface operations {
                 "settings[amortize]"?: boolean;
                 /** @description Results will show unallocated costs. */
                 "settings[unallocated]"?: boolean;
-                /** @description Results will aggregate by cost or usage. */
-                "settings[aggregate_by]"?: string;
-                /** @description Results will show previous period costs or usage comparison. */
+                /** @description Results will aggregate by cost, usage, or count. */
+                "settings[aggregate_by]"?: "cost" | "usage" | "count";
+                /** @description Results will show previous period cost, usage, or count comparison. */
                 "settings[show_previous_period]"?: boolean;
             };
             header?: never;
@@ -19863,7 +19935,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -19873,7 +19945,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -19893,7 +19965,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -19903,7 +19975,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -19927,7 +19999,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -19937,7 +20009,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -19957,7 +20029,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -19967,7 +20039,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -19991,7 +20063,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -20001,7 +20073,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -20021,7 +20093,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -20031,7 +20103,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -20073,6 +20145,8 @@ declare class CostsApi<NeverThrow extends boolean> {
         links?: components["schemas"]["Links"];
         total_cost: components["schemas"]["CostPartial"];
         total_usage?: components["schemas"]["UsagePartial"][];
+        total_count?: number | null;
+        counts?: components["schemas"]["CostCount"][];
         costs: components["schemas"]["Cost"][];
     }, "total_usage"> & {
         total_usage?: {
@@ -20082,6 +20156,8 @@ declare class CostsApi<NeverThrow extends boolean> {
         links?: components["schemas"]["Links"];
         total_cost: components["schemas"]["CostPartial"];
         total_usage?: components["schemas"]["UsagePartial"][];
+        total_count?: number | null;
+        counts?: components["schemas"]["CostCount"][];
         costs: components["schemas"]["Cost"][];
     }, "total_usage"> & {
         total_usage?: {

package/dist/index.d.ts CHANGED Viewed

@@ -3591,6 +3591,14 @@ interface components {
                  * @enum {string}
                  */
                 unit_scale?: "per_unit" | "per_hundred" | "per_thousand" | "per_million" | "per_billion";
+                /**
+                 * @description The calculation type applied when this BusinessMetric is used in the CostReport.
+                 * @default unit_cost
+                 * @enum {string}
+                 */
+                calculation_type?: "unit_cost" | "gross_margin" | "usage_unit_cost" | "raw_business_metric";
+                /** @description Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type. */
+                label?: string;
                 /** @description Include only values with these labels in the CostReport. */
                 label_filter?: string[];
                 /**
@@ -3668,6 +3676,14 @@ interface components {
                  * @enum {string}
                  */
                 unit_scale?: "per_unit" | "per_hundred" | "per_thousand" | "per_million" | "per_billion";
+                /**
+                 * @description The calculation type applied when this BusinessMetric is used in the CostReport.
+                 * @default unit_cost
+                 * @enum {string}
+                 */
+                calculation_type?: "unit_cost" | "gross_margin" | "usage_unit_cost" | "raw_business_metric";
+                /** @description Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type. */
+                label?: string;
                 /** @description Include only values with these labels in the CostReport. */
                 label_filter?: string[];
                 /**
@@ -3964,13 +3980,7 @@ interface components {
             saved_filter_tokens?: string[] | null;
             /** @description The tokens for the BusinessMetrics assigned to the CostReport, the unit scale, and label filter. */
             business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-            /**
-             * @description The default forecast selection for the CostReport.
-             * @example {
-             *       "kind": "baseline"
-             *     }
-             */
-            default_forecast: Record<string, any>;
+            default_forecast: components["schemas"]["DefaultForecast"];
             /** @description The filter applied to the CostReport. Additional documentation available at https://docs.vantage.sh/vql. */
             filter: string | null;
             /**
@@ -4011,12 +4021,13 @@ interface components {
                  */
                 unallocated?: boolean | null;
                 /**
-                 * @description Report will aggregate by cost or usage.
+                 * @description Report will aggregate by cost, usage, or count.
                  * @default cost
+                 * @enum {string|null}
                  */
-                aggregate_by?: string | null;
+                aggregate_by?: "cost" | "usage" | "count" | null;
                 /**
-                 * @description Report will show previous period costs or usage comparison.
+                 * @description Report will show previous period cost, usage, or count comparison.
                  * @default true
                  */
                 show_previous_period?: boolean | null;
@@ -4098,11 +4109,25 @@ interface components {
              *       ]
              *     }
              */
-            label_filters?: Record<string, any> | null;
+            label_filters?: {
+                [key: string]: string[];
+            } | null;
+        };
+        DefaultForecast: {
+            /**
+             * @description The default forecast selection kind.
+             * @enum {string}
+             */
+            kind: "baseline" | "report_forecast";
+            /** @description The token for the report forecast selected as the default. */
+            report_forecast_token?: string | null;
         };
         ChartSettings: {
-            /** @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'. */
-            y_axis_dimension: string;
+            /**
+             * @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
+             * @enum {string}
+             */
+            y_axis_dimension: "cost" | "usage" | "count";
             /** @description The dimension used to group or label data along the x-axis (e.g., by date, region, or service). NOTE: Only one value is allowed at this time. Defaults to ['date']. */
             x_axis_dimension: string[];
         };
@@ -4162,6 +4187,14 @@ interface components {
                  * @enum {string}
                  */
                 unit_scale?: "per_unit" | "per_hundred" | "per_thousand" | "per_million" | "per_billion";
+                /**
+                 * @description The calculation type applied when this BusinessMetric is used in the CostReport.
+                 * @default unit_cost
+                 * @enum {string}
+                 */
+                calculation_type?: "unit_cost" | "gross_margin" | "usage_unit_cost" | "raw_business_metric";
+                /** @description Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type. */
+                label?: string;
                 /** @description Include only values with these labels in the CostReport. */
                 label_filter?: string[];
                 /**
@@ -4215,12 +4248,13 @@ interface components {
                  */
                 unallocated?: boolean;
                 /**
-                 * @description Report will aggregate by cost or usage.
+                 * @description Report will aggregate by cost, usage, or count.
                  * @default cost
+                 * @enum {string}
                  */
-                aggregate_by?: string;
+                aggregate_by?: "cost" | "usage" | "count";
                 /**
-                 * @description Report will show previous period costs or usage comparison.
+                 * @description Report will show previous period cost, usage, or count comparison.
                  * @default true
                  */
                 show_previous_period?: boolean;
@@ -4259,8 +4293,11 @@ interface components {
             chart_settings?: {
                 /** @description The dimension used to group or label data along the x-axis (e.g., by date, region, or service). NOTE: Only one value is allowed at this time. Defaults to ['date']. */
                 x_axis_dimension?: string[];
-                /** @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'. */
-                y_axis_dimension?: string;
+                /**
+                 * @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
+                 * @enum {string}
+                 */
+                y_axis_dimension?: "cost" | "usage" | "count";
             };
         };
         /** @description Update a CostReport. */
@@ -4283,6 +4320,14 @@ interface components {
                  * @enum {string}
                  */
                 unit_scale?: "per_unit" | "per_hundred" | "per_thousand" | "per_million" | "per_billion";
+                /**
+                 * @description The calculation type applied when this BusinessMetric is used in the CostReport.
+                 * @default unit_cost
+                 * @enum {string}
+                 */
+                calculation_type?: "unit_cost" | "gross_margin" | "usage_unit_cost" | "raw_business_metric";
+                /** @description Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type. */
+                label?: string;
                 /** @description Include only values with these labels in the CostReport. */
                 label_filter?: string[];
                 /**
@@ -4327,9 +4372,12 @@ interface components {
                 amortize?: boolean | null;
                 /** @description Report will show unallocated costs. */
                 unallocated?: boolean | null;
-                /** @description Report will aggregate by cost or usage. */
-                aggregate_by?: string | null;
-                /** @description Report will show previous period costs or usage comparison. */
+                /**
+                 * @description Report will aggregate by cost, usage, or count.
+                 * @enum {string|null}
+                 */
+                aggregate_by?: "cost" | "usage" | "count" | null;
+                /** @description Report will show previous period cost, usage, or count comparison. */
                 show_previous_period?: boolean | null;
                 /** @description Report will restrict date ranges to completed periods only. */
                 complete_period?: boolean;
@@ -4338,8 +4386,11 @@ interface components {
             chart_settings?: {
                 /** @description The dimension used to group or label data along the x-axis (e.g., by date, region, or service). NOTE: Only one value is allowed at this time. Defaults to ['date']. */
                 x_axis_dimension?: string[];
-                /** @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'. */
-                y_axis_dimension?: string;
+                /**
+                 * @description The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
+                 * @enum {string}
+                 */
+                y_axis_dimension?: "cost" | "usage" | "count";
             };
             /** @description The previous period start date of the CostReport. ISO 8601 Formatted. */
             previous_period_start_date?: string;
@@ -4423,12 +4474,13 @@ interface components {
                  */
                 unallocated?: boolean;
                 /**
-                 * @description Results will aggregate by cost or usage.
+                 * @description Results will aggregate by cost, usage, or count.
                  * @default cost
+                 * @enum {string}
                  */
-                aggregate_by?: string;
+                aggregate_by?: "cost" | "usage" | "count";
                 /**
-                 * @description Results will show previous period costs or usage comparison.
+                 * @description Results will show previous period cost, usage, or count comparison.
                  * @default true
                  */
                 show_previous_period?: boolean;
@@ -4440,6 +4492,13 @@ interface components {
             total_cost: components["schemas"]["CostPartial"];
             /** @description The sum of all usage for the CostReport for the requested period, rounded to 2 decimal places, grouped by usage unit. */
             total_usage?: components["schemas"]["UsagePartial"][];
+            /**
+             * Format: int64
+             * @description The sum of the date-binned counts. Present when settings.aggregate_by is 'count'.
+             */
+            total_count?: number | null;
+            /** @description Distinct Group By permutation counts for the full requested period, unaffected by page and limit. Bins without cost are omitted. Present when settings.aggregate_by is 'count'. */
+            counts?: components["schemas"]["CostCount"][];
             costs: components["schemas"]["Cost"][];
         };
         CostPartial: {
@@ -4466,6 +4525,19 @@ interface components {
              */
             unit: string;
         };
+        CostCount: {
+            /**
+             * @description The date bin for the count. ISO 8601 Formatted.
+             * @example 2023-09-05+00:00
+             */
+            accrued_at: string;
+            /**
+             * Format: int64
+             * @description The number of distinct Group By permutations carrying cost in the date bin.
+             * @example 2
+             */
+            count: number;
+        };
         /** @description Cost model */
         Cost: {
             links?: components["schemas"]["Links"];
@@ -10534,9 +10606,9 @@ interface operations {
                 "settings[amortize]"?: boolean;
                 /** @description Results will show unallocated costs. */
                 "settings[unallocated]"?: boolean;
-                /** @description Results will aggregate by cost or usage. */
-                "settings[aggregate_by]"?: string;
-                /** @description Results will show previous period costs or usage comparison. */
+                /** @description Results will aggregate by cost, usage, or count. */
+                "settings[aggregate_by]"?: "cost" | "usage" | "count";
+                /** @description Results will show previous period cost, usage, or count comparison. */
                 "settings[show_previous_period]"?: boolean;
             };
             header?: never;
@@ -19863,7 +19935,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -19873,7 +19945,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -19893,7 +19965,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -19903,7 +19975,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -19927,7 +19999,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -19937,7 +20009,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -19957,7 +20029,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -19967,7 +20039,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -19991,7 +20063,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -20001,7 +20073,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -20021,7 +20093,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
         folder_token?: string | null;
         saved_filter_tokens?: string[] | null;
         business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
-        default_forecast: Record<string, any>;
+        default_forecast: components["schemas"]["DefaultForecast"];
         filter: string | null;
         groupings?: string | null;
         settings?: {
@@ -20031,7 +20103,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
             include_tax?: boolean | null;
             amortize?: boolean | null;
             unallocated?: boolean | null;
-            aggregate_by?: string | null;
+            aggregate_by?: "cost" | "usage" | "count" | null;
             show_previous_period?: boolean | null;
             complete_period?: boolean | null;
         };
@@ -20073,6 +20145,8 @@ declare class CostsApi<NeverThrow extends boolean> {
         links?: components["schemas"]["Links"];
         total_cost: components["schemas"]["CostPartial"];
         total_usage?: components["schemas"]["UsagePartial"][];
+        total_count?: number | null;
+        counts?: components["schemas"]["CostCount"][];
         costs: components["schemas"]["Cost"][];
     }, "total_usage"> & {
         total_usage?: {
@@ -20082,6 +20156,8 @@ declare class CostsApi<NeverThrow extends boolean> {
         links?: components["schemas"]["Links"];
         total_cost: components["schemas"]["CostPartial"];
         total_usage?: components["schemas"]["UsagePartial"][];
+        total_count?: number | null;
+        counts?: components["schemas"]["CostCount"][];
         costs: components["schemas"]["Cost"][];
     }, "total_usage"> & {
         total_usage?: {

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@vantage-sh/vantage-client",
-    "version": "2.8.0",
+    "version": "2.10.0",
     "description": "The Vantage Client SDK for TypeScript and JavaScript applications.",
     "main": "dist/index.js",
     "module": "dist/index.mjs",