@vantage-sh/vantage-client 2.19.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
  1. package/dist/index.d.mts +99 -1
  2. package/dist/index.d.ts +99 -1
  3. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -3530,6 +3530,8 @@ interface components {
3530
3530
  * @description The threshold amount that must be met for the alert to fire.
3531
3531
  */
3532
3532
  threshold: number;
3533
+ /** @description The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces. */
3534
+ workspace_token?: string;
3533
3535
  /** @description The tokens of the users that receive the alert. */
3534
3536
  user_tokens?: string[];
3535
3537
  /** @description Email addresses that receive the alert. Must be organization users or addresses on a verified domain. */
@@ -3550,12 +3552,14 @@ interface components {
3550
3552
  * @description The threshold amount that must be met for the alert to fire.
3551
3553
  */
3552
3554
  threshold?: number;
3555
+ /** @description The token of the Workspace the BudgetAlert belongs to. Required if the API token is associated with multiple Workspaces. */
3556
+ workspace_token?: string;
3553
3557
  /** @description The tokens of the users that receive the alert. */
3554
3558
  user_tokens?: string[];
3555
3559
  /** @description Email addresses that receive the alert. Must be organization users or addresses on a verified domain. */
3556
3560
  recipient_emails?: string[];
3557
3561
  /** @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. */
3558
- duration_in_days?: string;
3562
+ duration_in_days?: string | null;
3559
3563
  /** @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. */
3560
3564
  period_to_track?: string;
3561
3565
  /** @description The channels receiving the alerts. Requires an integration provider to be connected. */
@@ -3591,11 +3595,30 @@ interface components {
3591
3595
  budget_alert_tokens: string[];
3592
3596
  /** @description The tokens of the child Budgets associated with the hierarchical Budget. */
3593
3597
  child_budget_tokens: string[];
3598
+ period_cadence: components["schemas"]["PeriodCadence"];
3594
3599
  /** @description The budget periods associated with the Budget. */
3595
3600
  periods: components["schemas"]["BudgetPeriod"][];
3596
3601
  /** @description The historical performance of the Budget. */
3597
3602
  performance?: components["schemas"]["BudgetPerformance"][];
3598
3603
  };
3604
+ PeriodCadence: {
3605
+ /**
3606
+ * @description The anchor date for budget period intervals. ISO 8601 date (YYYY-MM-DD).
3607
+ * @example 2026-01-01
3608
+ */
3609
+ starts_at?: string | null;
3610
+ /**
3611
+ * Format: int32
3612
+ * @description The number of interval units per budget period.
3613
+ * @example 1
3614
+ */
3615
+ interval_count: number;
3616
+ /**
3617
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3618
+ * @example month
3619
+ */
3620
+ interval_unit: string;
3621
+ };
3599
3622
  BudgetPeriod: {
3600
3623
  /**
3601
3624
  * @description The date and time, in UTC, the Budget was created. ISO 8601 Formatted.
@@ -3640,6 +3663,24 @@ interface components {
3640
3663
  cost_report_token?: string;
3641
3664
  /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
3642
3665
  child_budget_tokens?: string[];
3666
+ /** @description The interval cadence for budget periods. Requires the flexible_budget_periods feature. */
3667
+ period_cadence?: {
3668
+ /**
3669
+ * Format: date
3670
+ * @description The anchor date for budget period intervals. Send null to clear.
3671
+ */
3672
+ starts_at: string | null;
3673
+ /**
3674
+ * Format: int32
3675
+ * @description The number of interval units per budget period.
3676
+ */
3677
+ interval_count?: number;
3678
+ /**
3679
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3680
+ * @enum {string}
3681
+ */
3682
+ interval_unit?: "day" | "week" | "month" | "year";
3683
+ };
3643
3684
  /** @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. */
3644
3685
  periods?: {
3645
3686
  /**
@@ -3667,6 +3708,24 @@ interface components {
3667
3708
  cost_report_token?: string;
3668
3709
  /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
3669
3710
  child_budget_tokens?: string[];
3711
+ /** @description The interval cadence for budget periods. Changing cadence after creation is rejected. */
3712
+ period_cadence?: {
3713
+ /**
3714
+ * Format: date
3715
+ * @description The anchor date for budget period intervals. Send null to clear.
3716
+ */
3717
+ starts_at: string | null;
3718
+ /**
3719
+ * Format: int32
3720
+ * @description The number of interval units per budget period.
3721
+ */
3722
+ interval_count?: number;
3723
+ /**
3724
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3725
+ * @enum {string}
3726
+ */
3727
+ interval_unit?: "day" | "week" | "month" | "year";
3728
+ };
3670
3729
  /** @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. */
3671
3730
  periods?: {
3672
3731
  /**
@@ -5438,6 +5497,8 @@ interface components {
5438
5497
  app_id: string;
5439
5498
  /** @description Service Principal Password. */
5440
5499
  password: string;
5500
+ /** @description Microsoft Customer Agreement (MCA) or Enterprise Agreement (EA) billing account ID. Must not contain whitespace. */
5501
+ billing_account_id?: string;
5441
5502
  };
5442
5503
  /** @description Update an Integration. */
5443
5504
  updateIntegration: {
@@ -9177,6 +9238,15 @@ interface operations {
9177
9238
  "application/json": components["schemas"]["BudgetAlert"];
9178
9239
  };
9179
9240
  };
9241
+ /** @description BadRequest */
9242
+ 400: {
9243
+ headers: {
9244
+ [name: string]: unknown;
9245
+ };
9246
+ content: {
9247
+ "application/json": components["schemas"]["Errors"];
9248
+ };
9249
+ };
9180
9250
  /** @description NotFound */
9181
9251
  404: {
9182
9252
  headers: {
@@ -9260,6 +9330,12 @@ interface operations {
9260
9330
  * "cost_report_token": "rprt_92062240b4ffda91",
9261
9331
  * "created_at": "2024-07-11T20:22:49Z",
9262
9332
  * "budget_alert_tokens": [],
9333
+ * "child_budget_tokens": [],
9334
+ * "period_cadence": {
9335
+ * "starts_at": null,
9336
+ * "interval_count": 1,
9337
+ * "interval_unit": "month"
9338
+ * },
9263
9339
  * "periods": [
9264
9340
  * {
9265
9341
  * "start_at": "2024-07-01",
@@ -9311,6 +9387,12 @@ interface operations {
9311
9387
  * "cost_report_token": null,
9312
9388
  * "created_at": "2024-07-11T20:22:52Z",
9313
9389
  * "budget_alert_tokens": [],
9390
+ * "child_budget_tokens": [],
9391
+ * "period_cadence": {
9392
+ * "starts_at": null,
9393
+ * "interval_count": 1,
9394
+ * "interval_unit": "month"
9395
+ * },
9314
9396
  * "periods": [
9315
9397
  * {
9316
9398
  * "start_at": "2024-01-01",
@@ -9404,6 +9486,12 @@ interface operations {
9404
9486
  * "cost_report_token": "rprt_9ee9f29893956951",
9405
9487
  * "created_at": "2024-07-11T20:22:41Z",
9406
9488
  * "budget_alert_tokens": [],
9489
+ * "child_budget_tokens": [],
9490
+ * "period_cadence": {
9491
+ * "starts_at": null,
9492
+ * "interval_count": 1,
9493
+ * "interval_unit": "month"
9494
+ * },
9407
9495
  * "periods": [
9408
9496
  * {
9409
9497
  * "start_at": "2024-07-01",
@@ -9464,6 +9552,12 @@ interface operations {
9464
9552
  * "cost_report_token": "rprt_07325bc3667263b7",
9465
9553
  * "created_at": "2024-07-11T20:22:48Z",
9466
9554
  * "budget_alert_tokens": [],
9555
+ * "child_budget_tokens": [],
9556
+ * "period_cadence": {
9557
+ * "starts_at": null,
9558
+ * "interval_count": 1,
9559
+ * "interval_unit": "month"
9560
+ * },
9467
9561
  * "periods": [
9468
9562
  * {
9469
9563
  * "start_at": "2023-01-01",
@@ -21302,6 +21396,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21302
21396
  created_at: string;
21303
21397
  budget_alert_tokens: string[];
21304
21398
  child_budget_tokens: string[];
21399
+ period_cadence: components["schemas"]["PeriodCadence"];
21305
21400
  periods: components["schemas"]["BudgetPeriod"][];
21306
21401
  performance?: components["schemas"]["BudgetPerformance"][];
21307
21402
  }, null] : {
@@ -21314,6 +21409,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21314
21409
  created_at: string;
21315
21410
  budget_alert_tokens: string[];
21316
21411
  child_budget_tokens: string[];
21412
+ period_cadence: components["schemas"]["PeriodCadence"];
21317
21413
  periods: components["schemas"]["BudgetPeriod"][];
21318
21414
  performance?: components["schemas"]["BudgetPerformance"][];
21319
21415
  }>;
@@ -21330,6 +21426,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21330
21426
  created_at: string;
21331
21427
  budget_alert_tokens: string[];
21332
21428
  child_budget_tokens: string[];
21429
+ period_cadence: components["schemas"]["PeriodCadence"];
21333
21430
  periods: components["schemas"]["BudgetPeriod"][];
21334
21431
  performance?: components["schemas"]["BudgetPerformance"][];
21335
21432
  }, null] : {
@@ -21342,6 +21439,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21342
21439
  created_at: string;
21343
21440
  budget_alert_tokens: string[];
21344
21441
  child_budget_tokens: string[];
21442
+ period_cadence: components["schemas"]["PeriodCadence"];
21345
21443
  periods: components["schemas"]["BudgetPeriod"][];
21346
21444
  performance?: components["schemas"]["BudgetPerformance"][];
21347
21445
  }>;
package/dist/index.d.ts CHANGED
@@ -3530,6 +3530,8 @@ interface components {
3530
3530
  * @description The threshold amount that must be met for the alert to fire.
3531
3531
  */
3532
3532
  threshold: number;
3533
+ /** @description The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces. */
3534
+ workspace_token?: string;
3533
3535
  /** @description The tokens of the users that receive the alert. */
3534
3536
  user_tokens?: string[];
3535
3537
  /** @description Email addresses that receive the alert. Must be organization users or addresses on a verified domain. */
@@ -3550,12 +3552,14 @@ interface components {
3550
3552
  * @description The threshold amount that must be met for the alert to fire.
3551
3553
  */
3552
3554
  threshold?: number;
3555
+ /** @description The token of the Workspace the BudgetAlert belongs to. Required if the API token is associated with multiple Workspaces. */
3556
+ workspace_token?: string;
3553
3557
  /** @description The tokens of the users that receive the alert. */
3554
3558
  user_tokens?: string[];
3555
3559
  /** @description Email addresses that receive the alert. Must be organization users or addresses on a verified domain. */
3556
3560
  recipient_emails?: string[];
3557
3561
  /** @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. */
3558
- duration_in_days?: string;
3562
+ duration_in_days?: string | null;
3559
3563
  /** @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. */
3560
3564
  period_to_track?: string;
3561
3565
  /** @description The channels receiving the alerts. Requires an integration provider to be connected. */
@@ -3591,11 +3595,30 @@ interface components {
3591
3595
  budget_alert_tokens: string[];
3592
3596
  /** @description The tokens of the child Budgets associated with the hierarchical Budget. */
3593
3597
  child_budget_tokens: string[];
3598
+ period_cadence: components["schemas"]["PeriodCadence"];
3594
3599
  /** @description The budget periods associated with the Budget. */
3595
3600
  periods: components["schemas"]["BudgetPeriod"][];
3596
3601
  /** @description The historical performance of the Budget. */
3597
3602
  performance?: components["schemas"]["BudgetPerformance"][];
3598
3603
  };
3604
+ PeriodCadence: {
3605
+ /**
3606
+ * @description The anchor date for budget period intervals. ISO 8601 date (YYYY-MM-DD).
3607
+ * @example 2026-01-01
3608
+ */
3609
+ starts_at?: string | null;
3610
+ /**
3611
+ * Format: int32
3612
+ * @description The number of interval units per budget period.
3613
+ * @example 1
3614
+ */
3615
+ interval_count: number;
3616
+ /**
3617
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3618
+ * @example month
3619
+ */
3620
+ interval_unit: string;
3621
+ };
3599
3622
  BudgetPeriod: {
3600
3623
  /**
3601
3624
  * @description The date and time, in UTC, the Budget was created. ISO 8601 Formatted.
@@ -3640,6 +3663,24 @@ interface components {
3640
3663
  cost_report_token?: string;
3641
3664
  /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
3642
3665
  child_budget_tokens?: string[];
3666
+ /** @description The interval cadence for budget periods. Requires the flexible_budget_periods feature. */
3667
+ period_cadence?: {
3668
+ /**
3669
+ * Format: date
3670
+ * @description The anchor date for budget period intervals. Send null to clear.
3671
+ */
3672
+ starts_at: string | null;
3673
+ /**
3674
+ * Format: int32
3675
+ * @description The number of interval units per budget period.
3676
+ */
3677
+ interval_count?: number;
3678
+ /**
3679
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3680
+ * @enum {string}
3681
+ */
3682
+ interval_unit?: "day" | "week" | "month" | "year";
3683
+ };
3643
3684
  /** @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. */
3644
3685
  periods?: {
3645
3686
  /**
@@ -3667,6 +3708,24 @@ interface components {
3667
3708
  cost_report_token?: string;
3668
3709
  /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
3669
3710
  child_budget_tokens?: string[];
3711
+ /** @description The interval cadence for budget periods. Changing cadence after creation is rejected. */
3712
+ period_cadence?: {
3713
+ /**
3714
+ * Format: date
3715
+ * @description The anchor date for budget period intervals. Send null to clear.
3716
+ */
3717
+ starts_at: string | null;
3718
+ /**
3719
+ * Format: int32
3720
+ * @description The number of interval units per budget period.
3721
+ */
3722
+ interval_count?: number;
3723
+ /**
3724
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3725
+ * @enum {string}
3726
+ */
3727
+ interval_unit?: "day" | "week" | "month" | "year";
3728
+ };
3670
3729
  /** @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. */
3671
3730
  periods?: {
3672
3731
  /**
@@ -5438,6 +5497,8 @@ interface components {
5438
5497
  app_id: string;
5439
5498
  /** @description Service Principal Password. */
5440
5499
  password: string;
5500
+ /** @description Microsoft Customer Agreement (MCA) or Enterprise Agreement (EA) billing account ID. Must not contain whitespace. */
5501
+ billing_account_id?: string;
5441
5502
  };
5442
5503
  /** @description Update an Integration. */
5443
5504
  updateIntegration: {
@@ -9177,6 +9238,15 @@ interface operations {
9177
9238
  "application/json": components["schemas"]["BudgetAlert"];
9178
9239
  };
9179
9240
  };
9241
+ /** @description BadRequest */
9242
+ 400: {
9243
+ headers: {
9244
+ [name: string]: unknown;
9245
+ };
9246
+ content: {
9247
+ "application/json": components["schemas"]["Errors"];
9248
+ };
9249
+ };
9180
9250
  /** @description NotFound */
9181
9251
  404: {
9182
9252
  headers: {
@@ -9260,6 +9330,12 @@ interface operations {
9260
9330
  * "cost_report_token": "rprt_92062240b4ffda91",
9261
9331
  * "created_at": "2024-07-11T20:22:49Z",
9262
9332
  * "budget_alert_tokens": [],
9333
+ * "child_budget_tokens": [],
9334
+ * "period_cadence": {
9335
+ * "starts_at": null,
9336
+ * "interval_count": 1,
9337
+ * "interval_unit": "month"
9338
+ * },
9263
9339
  * "periods": [
9264
9340
  * {
9265
9341
  * "start_at": "2024-07-01",
@@ -9311,6 +9387,12 @@ interface operations {
9311
9387
  * "cost_report_token": null,
9312
9388
  * "created_at": "2024-07-11T20:22:52Z",
9313
9389
  * "budget_alert_tokens": [],
9390
+ * "child_budget_tokens": [],
9391
+ * "period_cadence": {
9392
+ * "starts_at": null,
9393
+ * "interval_count": 1,
9394
+ * "interval_unit": "month"
9395
+ * },
9314
9396
  * "periods": [
9315
9397
  * {
9316
9398
  * "start_at": "2024-01-01",
@@ -9404,6 +9486,12 @@ interface operations {
9404
9486
  * "cost_report_token": "rprt_9ee9f29893956951",
9405
9487
  * "created_at": "2024-07-11T20:22:41Z",
9406
9488
  * "budget_alert_tokens": [],
9489
+ * "child_budget_tokens": [],
9490
+ * "period_cadence": {
9491
+ * "starts_at": null,
9492
+ * "interval_count": 1,
9493
+ * "interval_unit": "month"
9494
+ * },
9407
9495
  * "periods": [
9408
9496
  * {
9409
9497
  * "start_at": "2024-07-01",
@@ -9464,6 +9552,12 @@ interface operations {
9464
9552
  * "cost_report_token": "rprt_07325bc3667263b7",
9465
9553
  * "created_at": "2024-07-11T20:22:48Z",
9466
9554
  * "budget_alert_tokens": [],
9555
+ * "child_budget_tokens": [],
9556
+ * "period_cadence": {
9557
+ * "starts_at": null,
9558
+ * "interval_count": 1,
9559
+ * "interval_unit": "month"
9560
+ * },
9467
9561
  * "periods": [
9468
9562
  * {
9469
9563
  * "start_at": "2023-01-01",
@@ -21302,6 +21396,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21302
21396
  created_at: string;
21303
21397
  budget_alert_tokens: string[];
21304
21398
  child_budget_tokens: string[];
21399
+ period_cadence: components["schemas"]["PeriodCadence"];
21305
21400
  periods: components["schemas"]["BudgetPeriod"][];
21306
21401
  performance?: components["schemas"]["BudgetPerformance"][];
21307
21402
  }, null] : {
@@ -21314,6 +21409,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21314
21409
  created_at: string;
21315
21410
  budget_alert_tokens: string[];
21316
21411
  child_budget_tokens: string[];
21412
+ period_cadence: components["schemas"]["PeriodCadence"];
21317
21413
  periods: components["schemas"]["BudgetPeriod"][];
21318
21414
  performance?: components["schemas"]["BudgetPerformance"][];
21319
21415
  }>;
@@ -21330,6 +21426,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21330
21426
  created_at: string;
21331
21427
  budget_alert_tokens: string[];
21332
21428
  child_budget_tokens: string[];
21429
+ period_cadence: components["schemas"]["PeriodCadence"];
21333
21430
  periods: components["schemas"]["BudgetPeriod"][];
21334
21431
  performance?: components["schemas"]["BudgetPerformance"][];
21335
21432
  }, null] : {
@@ -21342,6 +21439,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21342
21439
  created_at: string;
21343
21440
  budget_alert_tokens: string[];
21344
21441
  child_budget_tokens: string[];
21442
+ period_cadence: components["schemas"]["PeriodCadence"];
21345
21443
  periods: components["schemas"]["BudgetPeriod"][];
21346
21444
  performance?: components["schemas"]["BudgetPerformance"][];
21347
21445
  }>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vantage-sh/vantage-client",
3
- "version": "2.19.0",
3
+ "version": "2.21.0",
4
4
  "description": "The Vantage Client SDK for TypeScript and JavaScript applications.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",