@vantage-sh/vantage-client 2.19.0 → 2.20.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 +85 -0
  2. package/dist/index.d.ts +85 -0
  3. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -3591,11 +3591,30 @@ interface components {
3591
3591
  budget_alert_tokens: string[];
3592
3592
  /** @description The tokens of the child Budgets associated with the hierarchical Budget. */
3593
3593
  child_budget_tokens: string[];
3594
+ period_cadence: components["schemas"]["PeriodCadence"];
3594
3595
  /** @description The budget periods associated with the Budget. */
3595
3596
  periods: components["schemas"]["BudgetPeriod"][];
3596
3597
  /** @description The historical performance of the Budget. */
3597
3598
  performance?: components["schemas"]["BudgetPerformance"][];
3598
3599
  };
3600
+ PeriodCadence: {
3601
+ /**
3602
+ * @description The anchor date for budget period intervals. ISO 8601 date (YYYY-MM-DD).
3603
+ * @example 2026-01-01
3604
+ */
3605
+ starts_at: string | null;
3606
+ /**
3607
+ * Format: int32
3608
+ * @description The number of interval units per budget period.
3609
+ * @example 1
3610
+ */
3611
+ interval_count: number;
3612
+ /**
3613
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3614
+ * @example month
3615
+ */
3616
+ interval_unit: string;
3617
+ };
3599
3618
  BudgetPeriod: {
3600
3619
  /**
3601
3620
  * @description The date and time, in UTC, the Budget was created. ISO 8601 Formatted.
@@ -3640,6 +3659,24 @@ interface components {
3640
3659
  cost_report_token?: string;
3641
3660
  /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
3642
3661
  child_budget_tokens?: string[];
3662
+ /** @description The interval cadence for budget periods. Requires the flexible_budget_periods feature. */
3663
+ period_cadence?: {
3664
+ /**
3665
+ * Format: date
3666
+ * @description The anchor date for budget period intervals.
3667
+ */
3668
+ starts_at?: string | null;
3669
+ /**
3670
+ * Format: int32
3671
+ * @description The number of interval units per budget period.
3672
+ */
3673
+ interval_count?: number;
3674
+ /**
3675
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3676
+ * @enum {string}
3677
+ */
3678
+ interval_unit?: "day" | "week" | "month" | "year";
3679
+ };
3643
3680
  /** @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
3681
  periods?: {
3645
3682
  /**
@@ -3667,6 +3704,24 @@ interface components {
3667
3704
  cost_report_token?: string;
3668
3705
  /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
3669
3706
  child_budget_tokens?: string[];
3707
+ /** @description The interval cadence for budget periods. Requires the flexible_budget_periods feature. */
3708
+ period_cadence?: {
3709
+ /**
3710
+ * Format: date
3711
+ * @description The anchor date for budget period intervals.
3712
+ */
3713
+ starts_at?: string | null;
3714
+ /**
3715
+ * Format: int32
3716
+ * @description The number of interval units per budget period.
3717
+ */
3718
+ interval_count?: number;
3719
+ /**
3720
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3721
+ * @enum {string}
3722
+ */
3723
+ interval_unit?: "day" | "week" | "month" | "year";
3724
+ };
3670
3725
  /** @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
3726
  periods?: {
3672
3727
  /**
@@ -5438,6 +5493,8 @@ interface components {
5438
5493
  app_id: string;
5439
5494
  /** @description Service Principal Password. */
5440
5495
  password: string;
5496
+ /** @description Microsoft Customer Agreement (MCA) or Enterprise Agreement (EA) billing account ID. Must not contain whitespace. */
5497
+ billing_account_id?: string;
5441
5498
  };
5442
5499
  /** @description Update an Integration. */
5443
5500
  updateIntegration: {
@@ -9260,6 +9317,12 @@ interface operations {
9260
9317
  * "cost_report_token": "rprt_92062240b4ffda91",
9261
9318
  * "created_at": "2024-07-11T20:22:49Z",
9262
9319
  * "budget_alert_tokens": [],
9320
+ * "child_budget_tokens": [],
9321
+ * "period_cadence": {
9322
+ * "starts_at": null,
9323
+ * "interval_count": 1,
9324
+ * "interval_unit": "month"
9325
+ * },
9263
9326
  * "periods": [
9264
9327
  * {
9265
9328
  * "start_at": "2024-07-01",
@@ -9311,6 +9374,12 @@ interface operations {
9311
9374
  * "cost_report_token": null,
9312
9375
  * "created_at": "2024-07-11T20:22:52Z",
9313
9376
  * "budget_alert_tokens": [],
9377
+ * "child_budget_tokens": [],
9378
+ * "period_cadence": {
9379
+ * "starts_at": null,
9380
+ * "interval_count": 1,
9381
+ * "interval_unit": "month"
9382
+ * },
9314
9383
  * "periods": [
9315
9384
  * {
9316
9385
  * "start_at": "2024-01-01",
@@ -9404,6 +9473,12 @@ interface operations {
9404
9473
  * "cost_report_token": "rprt_9ee9f29893956951",
9405
9474
  * "created_at": "2024-07-11T20:22:41Z",
9406
9475
  * "budget_alert_tokens": [],
9476
+ * "child_budget_tokens": [],
9477
+ * "period_cadence": {
9478
+ * "starts_at": null,
9479
+ * "interval_count": 1,
9480
+ * "interval_unit": "month"
9481
+ * },
9407
9482
  * "periods": [
9408
9483
  * {
9409
9484
  * "start_at": "2024-07-01",
@@ -9464,6 +9539,12 @@ interface operations {
9464
9539
  * "cost_report_token": "rprt_07325bc3667263b7",
9465
9540
  * "created_at": "2024-07-11T20:22:48Z",
9466
9541
  * "budget_alert_tokens": [],
9542
+ * "child_budget_tokens": [],
9543
+ * "period_cadence": {
9544
+ * "starts_at": null,
9545
+ * "interval_count": 1,
9546
+ * "interval_unit": "month"
9547
+ * },
9467
9548
  * "periods": [
9468
9549
  * {
9469
9550
  * "start_at": "2023-01-01",
@@ -21302,6 +21383,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21302
21383
  created_at: string;
21303
21384
  budget_alert_tokens: string[];
21304
21385
  child_budget_tokens: string[];
21386
+ period_cadence: components["schemas"]["PeriodCadence"];
21305
21387
  periods: components["schemas"]["BudgetPeriod"][];
21306
21388
  performance?: components["schemas"]["BudgetPerformance"][];
21307
21389
  }, null] : {
@@ -21314,6 +21396,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21314
21396
  created_at: string;
21315
21397
  budget_alert_tokens: string[];
21316
21398
  child_budget_tokens: string[];
21399
+ period_cadence: components["schemas"]["PeriodCadence"];
21317
21400
  periods: components["schemas"]["BudgetPeriod"][];
21318
21401
  performance?: components["schemas"]["BudgetPerformance"][];
21319
21402
  }>;
@@ -21330,6 +21413,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21330
21413
  created_at: string;
21331
21414
  budget_alert_tokens: string[];
21332
21415
  child_budget_tokens: string[];
21416
+ period_cadence: components["schemas"]["PeriodCadence"];
21333
21417
  periods: components["schemas"]["BudgetPeriod"][];
21334
21418
  performance?: components["schemas"]["BudgetPerformance"][];
21335
21419
  }, null] : {
@@ -21342,6 +21426,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21342
21426
  created_at: string;
21343
21427
  budget_alert_tokens: string[];
21344
21428
  child_budget_tokens: string[];
21429
+ period_cadence: components["schemas"]["PeriodCadence"];
21345
21430
  periods: components["schemas"]["BudgetPeriod"][];
21346
21431
  performance?: components["schemas"]["BudgetPerformance"][];
21347
21432
  }>;
package/dist/index.d.ts CHANGED
@@ -3591,11 +3591,30 @@ interface components {
3591
3591
  budget_alert_tokens: string[];
3592
3592
  /** @description The tokens of the child Budgets associated with the hierarchical Budget. */
3593
3593
  child_budget_tokens: string[];
3594
+ period_cadence: components["schemas"]["PeriodCadence"];
3594
3595
  /** @description The budget periods associated with the Budget. */
3595
3596
  periods: components["schemas"]["BudgetPeriod"][];
3596
3597
  /** @description The historical performance of the Budget. */
3597
3598
  performance?: components["schemas"]["BudgetPerformance"][];
3598
3599
  };
3600
+ PeriodCadence: {
3601
+ /**
3602
+ * @description The anchor date for budget period intervals. ISO 8601 date (YYYY-MM-DD).
3603
+ * @example 2026-01-01
3604
+ */
3605
+ starts_at: string | null;
3606
+ /**
3607
+ * Format: int32
3608
+ * @description The number of interval units per budget period.
3609
+ * @example 1
3610
+ */
3611
+ interval_count: number;
3612
+ /**
3613
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3614
+ * @example month
3615
+ */
3616
+ interval_unit: string;
3617
+ };
3599
3618
  BudgetPeriod: {
3600
3619
  /**
3601
3620
  * @description The date and time, in UTC, the Budget was created. ISO 8601 Formatted.
@@ -3640,6 +3659,24 @@ interface components {
3640
3659
  cost_report_token?: string;
3641
3660
  /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
3642
3661
  child_budget_tokens?: string[];
3662
+ /** @description The interval cadence for budget periods. Requires the flexible_budget_periods feature. */
3663
+ period_cadence?: {
3664
+ /**
3665
+ * Format: date
3666
+ * @description The anchor date for budget period intervals.
3667
+ */
3668
+ starts_at?: string | null;
3669
+ /**
3670
+ * Format: int32
3671
+ * @description The number of interval units per budget period.
3672
+ */
3673
+ interval_count?: number;
3674
+ /**
3675
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3676
+ * @enum {string}
3677
+ */
3678
+ interval_unit?: "day" | "week" | "month" | "year";
3679
+ };
3643
3680
  /** @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
3681
  periods?: {
3645
3682
  /**
@@ -3667,6 +3704,24 @@ interface components {
3667
3704
  cost_report_token?: string;
3668
3705
  /** @description The tokens of any child Budgets when creating a hierarchical Budget. */
3669
3706
  child_budget_tokens?: string[];
3707
+ /** @description The interval cadence for budget periods. Requires the flexible_budget_periods feature. */
3708
+ period_cadence?: {
3709
+ /**
3710
+ * Format: date
3711
+ * @description The anchor date for budget period intervals.
3712
+ */
3713
+ starts_at?: string | null;
3714
+ /**
3715
+ * Format: int32
3716
+ * @description The number of interval units per budget period.
3717
+ */
3718
+ interval_count?: number;
3719
+ /**
3720
+ * @description The unit for budget period intervals. One of: day, week, month, year.
3721
+ * @enum {string}
3722
+ */
3723
+ interval_unit?: "day" | "week" | "month" | "year";
3724
+ };
3670
3725
  /** @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
3726
  periods?: {
3672
3727
  /**
@@ -5438,6 +5493,8 @@ interface components {
5438
5493
  app_id: string;
5439
5494
  /** @description Service Principal Password. */
5440
5495
  password: string;
5496
+ /** @description Microsoft Customer Agreement (MCA) or Enterprise Agreement (EA) billing account ID. Must not contain whitespace. */
5497
+ billing_account_id?: string;
5441
5498
  };
5442
5499
  /** @description Update an Integration. */
5443
5500
  updateIntegration: {
@@ -9260,6 +9317,12 @@ interface operations {
9260
9317
  * "cost_report_token": "rprt_92062240b4ffda91",
9261
9318
  * "created_at": "2024-07-11T20:22:49Z",
9262
9319
  * "budget_alert_tokens": [],
9320
+ * "child_budget_tokens": [],
9321
+ * "period_cadence": {
9322
+ * "starts_at": null,
9323
+ * "interval_count": 1,
9324
+ * "interval_unit": "month"
9325
+ * },
9263
9326
  * "periods": [
9264
9327
  * {
9265
9328
  * "start_at": "2024-07-01",
@@ -9311,6 +9374,12 @@ interface operations {
9311
9374
  * "cost_report_token": null,
9312
9375
  * "created_at": "2024-07-11T20:22:52Z",
9313
9376
  * "budget_alert_tokens": [],
9377
+ * "child_budget_tokens": [],
9378
+ * "period_cadence": {
9379
+ * "starts_at": null,
9380
+ * "interval_count": 1,
9381
+ * "interval_unit": "month"
9382
+ * },
9314
9383
  * "periods": [
9315
9384
  * {
9316
9385
  * "start_at": "2024-01-01",
@@ -9404,6 +9473,12 @@ interface operations {
9404
9473
  * "cost_report_token": "rprt_9ee9f29893956951",
9405
9474
  * "created_at": "2024-07-11T20:22:41Z",
9406
9475
  * "budget_alert_tokens": [],
9476
+ * "child_budget_tokens": [],
9477
+ * "period_cadence": {
9478
+ * "starts_at": null,
9479
+ * "interval_count": 1,
9480
+ * "interval_unit": "month"
9481
+ * },
9407
9482
  * "periods": [
9408
9483
  * {
9409
9484
  * "start_at": "2024-07-01",
@@ -9464,6 +9539,12 @@ interface operations {
9464
9539
  * "cost_report_token": "rprt_07325bc3667263b7",
9465
9540
  * "created_at": "2024-07-11T20:22:48Z",
9466
9541
  * "budget_alert_tokens": [],
9542
+ * "child_budget_tokens": [],
9543
+ * "period_cadence": {
9544
+ * "starts_at": null,
9545
+ * "interval_count": 1,
9546
+ * "interval_unit": "month"
9547
+ * },
9467
9548
  * "periods": [
9468
9549
  * {
9469
9550
  * "start_at": "2023-01-01",
@@ -21302,6 +21383,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21302
21383
  created_at: string;
21303
21384
  budget_alert_tokens: string[];
21304
21385
  child_budget_tokens: string[];
21386
+ period_cadence: components["schemas"]["PeriodCadence"];
21305
21387
  periods: components["schemas"]["BudgetPeriod"][];
21306
21388
  performance?: components["schemas"]["BudgetPerformance"][];
21307
21389
  }, null] : {
@@ -21314,6 +21396,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21314
21396
  created_at: string;
21315
21397
  budget_alert_tokens: string[];
21316
21398
  child_budget_tokens: string[];
21399
+ period_cadence: components["schemas"]["PeriodCadence"];
21317
21400
  periods: components["schemas"]["BudgetPeriod"][];
21318
21401
  performance?: components["schemas"]["BudgetPerformance"][];
21319
21402
  }>;
@@ -21330,6 +21413,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21330
21413
  created_at: string;
21331
21414
  budget_alert_tokens: string[];
21332
21415
  child_budget_tokens: string[];
21416
+ period_cadence: components["schemas"]["PeriodCadence"];
21333
21417
  periods: components["schemas"]["BudgetPeriod"][];
21334
21418
  performance?: components["schemas"]["BudgetPerformance"][];
21335
21419
  }, null] : {
@@ -21342,6 +21426,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
21342
21426
  created_at: string;
21343
21427
  budget_alert_tokens: string[];
21344
21428
  child_budget_tokens: string[];
21429
+ period_cadence: components["schemas"]["PeriodCadence"];
21345
21430
  periods: components["schemas"]["BudgetPeriod"][];
21346
21431
  performance?: components["schemas"]["BudgetPerformance"][];
21347
21432
  }>;
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.20.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",