npm - @vantage-sh/vantage-client - Versions diffs - 2.20.0 → 2.21.0 - Mend

@vantage-sh/vantage-client 2.20.0 → 2.21.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

@@ -3530,6 +3530,8 @@ interface components {
              * @description The threshold amount that must be met for the alert to fire.
              */
             threshold: number;
+            /** @description The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces. */
+            workspace_token?: string;
             /** @description The tokens of the users that receive the alert. */
             user_tokens?: string[];
             /** @description Email addresses that receive the alert. Must be organization users or addresses on a verified domain. */
@@ -3550,12 +3552,14 @@ interface components {
              * @description The threshold amount that must be met for the alert to fire.
              */
             threshold?: number;
+            /** @description The token of the Workspace the BudgetAlert belongs to. Required if the API token is associated with multiple Workspaces. */
+            workspace_token?: string;
             /** @description The tokens of the users that receive the alert. */
             user_tokens?: string[];
             /** @description Email addresses that receive the alert. Must be organization users or addresses on a verified domain. */
             recipient_emails?: string[];
             /** @description The number of days from the start or end of the month to trigger the alert if the threshold is reached. For the full month, pass an empty value. */
-            duration_in_days?: string;
+            duration_in_days?: string | null;
             /** @description The period tracked on the alert. Used with duration_in_days to determine the time window of the alert. Defaults to start_of_the_month if not passed. Possible values: start_of_the_month, end_of_the_month. */
             period_to_track?: string;
             /** @description The channels receiving the alerts. Requires an integration provider to be connected. */
@@ -3602,7 +3606,7 @@ interface components {
              * @description The anchor date for budget period intervals. ISO 8601 date (YYYY-MM-DD).
              * @example 2026-01-01
              */
-            starts_at: string | null;
+            starts_at?: string | null;
             /**
              * Format: int32
              * @description The number of interval units per budget period.
@@ -3663,9 +3667,9 @@ interface components {
             period_cadence?: {
                 /**
                  * Format: date
-                 * @description The anchor date for budget period intervals.
+                 * @description The anchor date for budget period intervals. Send null to clear.
                  */
-                starts_at?: string | null;
+                starts_at: string | null;
                 /**
                  * Format: int32
                  * @description The number of interval units per budget period.
@@ -3704,13 +3708,13 @@ 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. */
+            /** @description The interval cadence for budget periods. Changing cadence after creation is rejected. */
             period_cadence?: {
                 /**
                  * Format: date
-                 * @description The anchor date for budget period intervals.
+                 * @description The anchor date for budget period intervals. Send null to clear.
                  */
-                starts_at?: string | null;
+                starts_at: string | null;
                 /**
                  * Format: int32
                  * @description The number of interval units per budget period.
@@ -9234,6 +9238,15 @@ interface operations {
                     "application/json": components["schemas"]["BudgetAlert"];
                 };
             };
+            /** @description BadRequest */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Errors"];
+                };
+            };
             /** @description NotFound */
             404: {
                 headers: {

package/dist/index.d.ts CHANGED Viewed

@@ -3530,6 +3530,8 @@ interface components {
              * @description The threshold amount that must be met for the alert to fire.
              */
             threshold: number;
+            /** @description The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces. */
+            workspace_token?: string;
             /** @description The tokens of the users that receive the alert. */
             user_tokens?: string[];
             /** @description Email addresses that receive the alert. Must be organization users or addresses on a verified domain. */
@@ -3550,12 +3552,14 @@ interface components {
              * @description The threshold amount that must be met for the alert to fire.
              */
             threshold?: number;
+            /** @description The token of the Workspace the BudgetAlert belongs to. Required if the API token is associated with multiple Workspaces. */
+            workspace_token?: string;
             /** @description The tokens of the users that receive the alert. */
             user_tokens?: string[];
             /** @description Email addresses that receive the alert. Must be organization users or addresses on a verified domain. */
             recipient_emails?: string[];
             /** @description The number of days from the start or end of the month to trigger the alert if the threshold is reached. For the full month, pass an empty value. */
-            duration_in_days?: string;
+            duration_in_days?: string | null;
             /** @description The period tracked on the alert. Used with duration_in_days to determine the time window of the alert. Defaults to start_of_the_month if not passed. Possible values: start_of_the_month, end_of_the_month. */
             period_to_track?: string;
             /** @description The channels receiving the alerts. Requires an integration provider to be connected. */
@@ -3602,7 +3606,7 @@ interface components {
              * @description The anchor date for budget period intervals. ISO 8601 date (YYYY-MM-DD).
              * @example 2026-01-01
              */
-            starts_at: string | null;
+            starts_at?: string | null;
             /**
              * Format: int32
              * @description The number of interval units per budget period.
@@ -3663,9 +3667,9 @@ interface components {
             period_cadence?: {
                 /**
                  * Format: date
-                 * @description The anchor date for budget period intervals.
+                 * @description The anchor date for budget period intervals. Send null to clear.
                  */
-                starts_at?: string | null;
+                starts_at: string | null;
                 /**
                  * Format: int32
                  * @description The number of interval units per budget period.
@@ -3704,13 +3708,13 @@ 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. */
+            /** @description The interval cadence for budget periods. Changing cadence after creation is rejected. */
             period_cadence?: {
                 /**
                  * Format: date
-                 * @description The anchor date for budget period intervals.
+                 * @description The anchor date for budget period intervals. Send null to clear.
                  */
-                starts_at?: string | null;
+                starts_at: string | null;
                 /**
                  * Format: int32
                  * @description The number of interval units per budget period.
@@ -9234,6 +9238,15 @@ interface operations {
                     "application/json": components["schemas"]["BudgetAlert"];
                 };
             };
+            /** @description BadRequest */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Errors"];
+                };
+            };
             /** @description NotFound */
             404: {
                 headers: {

package/package.json CHANGED Viewed

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