@vantage-sh/vantage-client 2.18.0 → 2.20.0

package/dist/index.d.mts

@@ -3591,11 +3591,30 @@ interface components {
             budget_alert_tokens: string[];
             /** @description The tokens of the child Budgets associated with the hierarchical Budget. */
             child_budget_tokens: string[];
+            period_cadence: components["schemas"]["PeriodCadence"];
             /** @description The budget periods associated with the Budget. */
             periods: components["schemas"]["BudgetPeriod"][];
             /** @description The historical performance of the Budget. */
             performance?: components["schemas"]["BudgetPerformance"][];
         };
+        PeriodCadence: {
+            /**
+             * @description The anchor date for budget period intervals. ISO 8601 date (YYYY-MM-DD).
+             * @example 2026-01-01
+             */
+            starts_at: string | null;
+            /**
+             * Format: int32
+             * @description The number of interval units per budget period.
+             * @example 1
+             */
+            interval_count: number;
+            /**
+             * @description The unit for budget period intervals. One of: day, week, month, year.
+             * @example month
+             */
+            interval_unit: string;
+        };
         BudgetPeriod: {
             /**
              * @description The date and time, in UTC, the Budget was created. ISO 8601 Formatted.
@@ -3640,6 +3659,24 @@ interface components {
             cost_report_token?: string;
             /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
             child_budget_tokens?: string[];
+            /** @description The interval cadence for budget periods. Requires the flexible_budget_periods feature. */
+            period_cadence?: {
+                /**
+                 * Format: date
+                 * @description The anchor date for budget period intervals.
+                 */
+                starts_at?: string | null;
+                /**
+                 * Format: int32
+                 * @description The number of interval units per budget period.
+                 */
+                interval_count?: number;
+                /**
+                 * @description The unit for budget period intervals. One of: day, week, month, year.
+                 * @enum {string}
+                 */
+                interval_unit?: "day" | "week" | "month" | "year";
+            };
             /** @description The periods for the Budget. The start_at and end_at must be iso8601 formatted e.g. YYYY-MM-DD. Ignored for hierarchical Budgets. */
             periods?: {
                 /**
@@ -3667,6 +3704,24 @@ interface components {
             cost_report_token?: string;
             /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
             child_budget_tokens?: string[];
+            /** @description The interval cadence for budget periods. Requires the flexible_budget_periods feature. */
+            period_cadence?: {
+                /**
+                 * Format: date
+                 * @description The anchor date for budget period intervals.
+                 */
+                starts_at?: string | null;
+                /**
+                 * Format: int32
+                 * @description The number of interval units per budget period.
+                 */
+                interval_count?: number;
+                /**
+                 * @description The unit for budget period intervals. One of: day, week, month, year.
+                 * @enum {string}
+                 */
+                interval_unit?: "day" | "week" | "month" | "year";
+            };
             /** @description The periods for the Budget. The start_at and end_at must be iso8601 formatted e.g. YYYY-MM-DD. Ignored for hierarchical Budgets. */
             periods?: {
                 /**
@@ -4685,11 +4740,11 @@ interface components {
             filter?: string;
             /** @description The token of the Workspace to query costs from. Ignored if 'cost_report_token' is set. Required if the API token is associated with multiple Workspaces. */
             workspace_token?: string;
-            /** @description First date you would like to filter costs from. ISO 8601 formatted. */
+            /** @description First date you would like to filter costs from. ISO 8601 formatted. When omitted with cost_report_token, the report's saved start date is used. */
             start_date?: string;
-            /** @description Last date you would like to filter costs to. ISO 8601 formatted. */
+            /** @description Last date you would like to filter costs to. ISO 8601 formatted. When omitted with cost_report_token, the report's saved end date is used. */
             end_date?: string;
-            /** @description Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
+            /** @description Group the results by specific field(s). When omitted with cost_report_token, the report's saved groupings are used; otherwise defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
             groupings?: string[];
             /**
              * @description The date bin of the costs. Defaults to the report's default or day.
@@ -4873,6 +4928,21 @@ interface components {
              * @example DataTransfer-Regional-Bytes
              */
             cost_subcategory?: string | null;
+            /**
+             * @description The charge type for the cost.
+             * @example Usage
+             */
+            charge_type?: string | null;
+            /**
+             * @description Whether the cost has tags.
+             * @example true
+             */
+            tagged?: boolean | null;
+            /**
+             * @description The unit used to measure usage.
+             * @example GB
+             */
+            usage_unit?: string | null;
             /**
              * @description The segment name for segment report costs.
              * @example Engineering
@@ -5423,6 +5493,8 @@ interface components {
             app_id: string;
             /** @description Service Principal Password. */
             password: string;
+            /** @description Microsoft Customer Agreement (MCA) or Enterprise Agreement (EA) billing account ID. Must not contain whitespace. */
+            billing_account_id?: string;
         };
         /** @description Update an Integration. */
         updateIntegration: {
@@ -9245,6 +9317,12 @@ interface operations {
                      *           "cost_report_token": "rprt_92062240b4ffda91",
                      *           "created_at": "2024-07-11T20:22:49Z",
                      *           "budget_alert_tokens": [],
+                     *           "child_budget_tokens": [],
+                     *           "period_cadence": {
+                     *             "starts_at": null,
+                     *             "interval_count": 1,
+                     *             "interval_unit": "month"
+                     *           },
                      *           "periods": [
                      *             {
                      *               "start_at": "2024-07-01",
@@ -9296,6 +9374,12 @@ interface operations {
                      *       "cost_report_token": null,
                      *       "created_at": "2024-07-11T20:22:52Z",
                      *       "budget_alert_tokens": [],
+                     *       "child_budget_tokens": [],
+                     *       "period_cadence": {
+                     *         "starts_at": null,
+                     *         "interval_count": 1,
+                     *         "interval_unit": "month"
+                     *       },
                      *       "periods": [
                      *         {
                      *           "start_at": "2024-01-01",
@@ -9389,6 +9473,12 @@ interface operations {
                      *       "cost_report_token": "rprt_9ee9f29893956951",
                      *       "created_at": "2024-07-11T20:22:41Z",
                      *       "budget_alert_tokens": [],
+                     *       "child_budget_tokens": [],
+                     *       "period_cadence": {
+                     *         "starts_at": null,
+                     *         "interval_count": 1,
+                     *         "interval_unit": "month"
+                     *       },
                      *       "periods": [
                      *         {
                      *           "start_at": "2024-07-01",
@@ -9449,6 +9539,12 @@ interface operations {
                      *       "cost_report_token": "rprt_07325bc3667263b7",
                      *       "created_at": "2024-07-11T20:22:48Z",
                      *       "budget_alert_tokens": [],
+                     *       "child_budget_tokens": [],
+                     *       "period_cadence": {
+                     *         "starts_at": null,
+                     *         "interval_count": 1,
+                     *         "interval_unit": "month"
+                     *       },
                      *       "periods": [
                      *         {
                      *           "start_at": "2023-01-01",
@@ -11343,11 +11439,11 @@ interface operations {
                 filter?: string;
                 /** @description The token of the Workspace to query costs from. Ignored if 'cost_report_token' is set. Required if the API token is associated with multiple Workspaces. */
                 workspace_token?: string;
-                /** @description First date you would like to filter costs from. ISO 8601 formatted. */
+                /** @description First date you would like to filter costs from. ISO 8601 formatted. When omitted with cost_report_token, the report's saved start date is used. */
                 start_date?: string;
-                /** @description Last date you would like to filter costs to. ISO 8601 formatted. */
+                /** @description Last date you would like to filter costs to. ISO 8601 formatted. When omitted with cost_report_token, the report's saved end date is used. */
                 end_date?: string;
-                /** @description Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
+                /** @description Group the results by specific field(s). When omitted with cost_report_token, the report's saved groupings are used; otherwise defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
                 groupings?: string[];
                 /** @description Whether to order costs by date in an ascending or descending manner. */
                 order?: "asc" | "desc";
@@ -21287,6 +21383,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
         created_at: string;
         budget_alert_tokens: string[];
         child_budget_tokens: string[];
+        period_cadence: components["schemas"]["PeriodCadence"];
         periods: components["schemas"]["BudgetPeriod"][];
         performance?: components["schemas"]["BudgetPerformance"][];
     }, null] : {
@@ -21299,6 +21396,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
         created_at: string;
         budget_alert_tokens: string[];
         child_budget_tokens: string[];
+        period_cadence: components["schemas"]["PeriodCadence"];
         periods: components["schemas"]["BudgetPeriod"][];
         performance?: components["schemas"]["BudgetPerformance"][];
     }>;
@@ -21315,6 +21413,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
         created_at: string;
         budget_alert_tokens: string[];
         child_budget_tokens: string[];
+        period_cadence: components["schemas"]["PeriodCadence"];
         periods: components["schemas"]["BudgetPeriod"][];
         performance?: components["schemas"]["BudgetPerformance"][];
     }, null] : {
@@ -21327,6 +21426,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
         created_at: string;
         budget_alert_tokens: string[];
         child_budget_tokens: string[];
+        period_cadence: components["schemas"]["PeriodCadence"];
         periods: components["schemas"]["BudgetPeriod"][];
         performance?: components["schemas"]["BudgetPerformance"][];
     }>;

package/dist/index.d.ts

@@ -3591,11 +3591,30 @@ interface components {
             budget_alert_tokens: string[];
             /** @description The tokens of the child Budgets associated with the hierarchical Budget. */
             child_budget_tokens: string[];
+            period_cadence: components["schemas"]["PeriodCadence"];
             /** @description The budget periods associated with the Budget. */
             periods: components["schemas"]["BudgetPeriod"][];
             /** @description The historical performance of the Budget. */
             performance?: components["schemas"]["BudgetPerformance"][];
         };
+        PeriodCadence: {
+            /**
+             * @description The anchor date for budget period intervals. ISO 8601 date (YYYY-MM-DD).
+             * @example 2026-01-01
+             */
+            starts_at: string | null;
+            /**
+             * Format: int32
+             * @description The number of interval units per budget period.
+             * @example 1
+             */
+            interval_count: number;
+            /**
+             * @description The unit for budget period intervals. One of: day, week, month, year.
+             * @example month
+             */
+            interval_unit: string;
+        };
         BudgetPeriod: {
             /**
              * @description The date and time, in UTC, the Budget was created. ISO 8601 Formatted.
@@ -3640,6 +3659,24 @@ interface components {
             cost_report_token?: string;
             /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
             child_budget_tokens?: string[];
+            /** @description The interval cadence for budget periods. Requires the flexible_budget_periods feature. */
+            period_cadence?: {
+                /**
+                 * Format: date
+                 * @description The anchor date for budget period intervals.
+                 */
+                starts_at?: string | null;
+                /**
+                 * Format: int32
+                 * @description The number of interval units per budget period.
+                 */
+                interval_count?: number;
+                /**
+                 * @description The unit for budget period intervals. One of: day, week, month, year.
+                 * @enum {string}
+                 */
+                interval_unit?: "day" | "week" | "month" | "year";
+            };
             /** @description The periods for the Budget. The start_at and end_at must be iso8601 formatted e.g. YYYY-MM-DD. Ignored for hierarchical Budgets. */
             periods?: {
                 /**
@@ -3667,6 +3704,24 @@ interface components {
             cost_report_token?: string;
             /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
             child_budget_tokens?: string[];
+            /** @description The interval cadence for budget periods. Requires the flexible_budget_periods feature. */
+            period_cadence?: {
+                /**
+                 * Format: date
+                 * @description The anchor date for budget period intervals.
+                 */
+                starts_at?: string | null;
+                /**
+                 * Format: int32
+                 * @description The number of interval units per budget period.
+                 */
+                interval_count?: number;
+                /**
+                 * @description The unit for budget period intervals. One of: day, week, month, year.
+                 * @enum {string}
+                 */
+                interval_unit?: "day" | "week" | "month" | "year";
+            };
             /** @description The periods for the Budget. The start_at and end_at must be iso8601 formatted e.g. YYYY-MM-DD. Ignored for hierarchical Budgets. */
             periods?: {
                 /**
@@ -4685,11 +4740,11 @@ interface components {
             filter?: string;
             /** @description The token of the Workspace to query costs from. Ignored if 'cost_report_token' is set. Required if the API token is associated with multiple Workspaces. */
             workspace_token?: string;
-            /** @description First date you would like to filter costs from. ISO 8601 formatted. */
+            /** @description First date you would like to filter costs from. ISO 8601 formatted. When omitted with cost_report_token, the report's saved start date is used. */
             start_date?: string;
-            /** @description Last date you would like to filter costs to. ISO 8601 formatted. */
+            /** @description Last date you would like to filter costs to. ISO 8601 formatted. When omitted with cost_report_token, the report's saved end date is used. */
             end_date?: string;
-            /** @description Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
+            /** @description Group the results by specific field(s). When omitted with cost_report_token, the report's saved groupings are used; otherwise defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
             groupings?: string[];
             /**
              * @description The date bin of the costs. Defaults to the report's default or day.
@@ -4873,6 +4928,21 @@ interface components {
              * @example DataTransfer-Regional-Bytes
              */
             cost_subcategory?: string | null;
+            /**
+             * @description The charge type for the cost.
+             * @example Usage
+             */
+            charge_type?: string | null;
+            /**
+             * @description Whether the cost has tags.
+             * @example true
+             */
+            tagged?: boolean | null;
+            /**
+             * @description The unit used to measure usage.
+             * @example GB
+             */
+            usage_unit?: string | null;
             /**
              * @description The segment name for segment report costs.
              * @example Engineering
@@ -5423,6 +5493,8 @@ interface components {
             app_id: string;
             /** @description Service Principal Password. */
             password: string;
+            /** @description Microsoft Customer Agreement (MCA) or Enterprise Agreement (EA) billing account ID. Must not contain whitespace. */
+            billing_account_id?: string;
         };
         /** @description Update an Integration. */
         updateIntegration: {
@@ -9245,6 +9317,12 @@ interface operations {
                      *           "cost_report_token": "rprt_92062240b4ffda91",
                      *           "created_at": "2024-07-11T20:22:49Z",
                      *           "budget_alert_tokens": [],
+                     *           "child_budget_tokens": [],
+                     *           "period_cadence": {
+                     *             "starts_at": null,
+                     *             "interval_count": 1,
+                     *             "interval_unit": "month"
+                     *           },
                      *           "periods": [
                      *             {
                      *               "start_at": "2024-07-01",
@@ -9296,6 +9374,12 @@ interface operations {
                      *       "cost_report_token": null,
                      *       "created_at": "2024-07-11T20:22:52Z",
                      *       "budget_alert_tokens": [],
+                     *       "child_budget_tokens": [],
+                     *       "period_cadence": {
+                     *         "starts_at": null,
+                     *         "interval_count": 1,
+                     *         "interval_unit": "month"
+                     *       },
                      *       "periods": [
                      *         {
                      *           "start_at": "2024-01-01",
@@ -9389,6 +9473,12 @@ interface operations {
                      *       "cost_report_token": "rprt_9ee9f29893956951",
                      *       "created_at": "2024-07-11T20:22:41Z",
                      *       "budget_alert_tokens": [],
+                     *       "child_budget_tokens": [],
+                     *       "period_cadence": {
+                     *         "starts_at": null,
+                     *         "interval_count": 1,
+                     *         "interval_unit": "month"
+                     *       },
                      *       "periods": [
                      *         {
                      *           "start_at": "2024-07-01",
@@ -9449,6 +9539,12 @@ interface operations {
                      *       "cost_report_token": "rprt_07325bc3667263b7",
                      *       "created_at": "2024-07-11T20:22:48Z",
                      *       "budget_alert_tokens": [],
+                     *       "child_budget_tokens": [],
+                     *       "period_cadence": {
+                     *         "starts_at": null,
+                     *         "interval_count": 1,
+                     *         "interval_unit": "month"
+                     *       },
                      *       "periods": [
                      *         {
                      *           "start_at": "2023-01-01",
@@ -11343,11 +11439,11 @@ interface operations {
                 filter?: string;
                 /** @description The token of the Workspace to query costs from. Ignored if 'cost_report_token' is set. Required if the API token is associated with multiple Workspaces. */
                 workspace_token?: string;
-                /** @description First date you would like to filter costs from. ISO 8601 formatted. */
+                /** @description First date you would like to filter costs from. ISO 8601 formatted. When omitted with cost_report_token, the report's saved start date is used. */
                 start_date?: string;
-                /** @description Last date you would like to filter costs to. ISO 8601 formatted. */
+                /** @description Last date you would like to filter costs to. ISO 8601 formatted. When omitted with cost_report_token, the report's saved end date is used. */
                 end_date?: string;
-                /** @description Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
+                /** @description Group the results by specific field(s). When omitted with cost_report_token, the report's saved groupings are used; otherwise defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
                 groupings?: string[];
                 /** @description Whether to order costs by date in an ascending or descending manner. */
                 order?: "asc" | "desc";
@@ -21287,6 +21383,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
         created_at: string;
         budget_alert_tokens: string[];
         child_budget_tokens: string[];
+        period_cadence: components["schemas"]["PeriodCadence"];
         periods: components["schemas"]["BudgetPeriod"][];
         performance?: components["schemas"]["BudgetPerformance"][];
     }, null] : {
@@ -21299,6 +21396,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
         created_at: string;
         budget_alert_tokens: string[];
         child_budget_tokens: string[];
+        period_cadence: components["schemas"]["PeriodCadence"];
         periods: components["schemas"]["BudgetPeriod"][];
         performance?: components["schemas"]["BudgetPerformance"][];
     }>;
@@ -21315,6 +21413,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
         created_at: string;
         budget_alert_tokens: string[];
         child_budget_tokens: string[];
+        period_cadence: components["schemas"]["PeriodCadence"];
         periods: components["schemas"]["BudgetPeriod"][];
         performance?: components["schemas"]["BudgetPerformance"][];
     }, null] : {
@@ -21327,6 +21426,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
         created_at: string;
         budget_alert_tokens: string[];
         child_budget_tokens: string[];
+        period_cadence: components["schemas"]["PeriodCadence"];
         periods: components["schemas"]["BudgetPeriod"][];
         performance?: components["schemas"]["BudgetPerformance"][];
     }>;

package/package.json

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