@vantage-sh/vantage-client 2.2.0 → 2.3.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.
- package/README.md +2 -2
- package/dist/index.d.mts +509 -788
- package/dist/index.d.ts +509 -788
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +3 -4
package/dist/index.d.mts
CHANGED
|
@@ -1421,7 +1421,11 @@ interface paths {
|
|
|
1421
1421
|
* @description Configure SSO for a Managed Account.
|
|
1422
1422
|
*/
|
|
1423
1423
|
post: operations["createSsoConnectionForManagedAccount"];
|
|
1424
|
-
|
|
1424
|
+
/**
|
|
1425
|
+
* Delete SSO connection for managed account
|
|
1426
|
+
* @description Delete SSO connection for a Managed Account.
|
|
1427
|
+
*/
|
|
1428
|
+
delete: operations["deleteSsoConnectionForManagedAccount"];
|
|
1425
1429
|
options?: never;
|
|
1426
1430
|
head?: never;
|
|
1427
1431
|
patch?: never;
|
|
@@ -1439,7 +1443,11 @@ interface paths {
|
|
|
1439
1443
|
* @description Get information about the authenticated BearerToken.
|
|
1440
1444
|
*/
|
|
1441
1445
|
get: operations["getMe"];
|
|
1442
|
-
|
|
1446
|
+
/**
|
|
1447
|
+
* Update authenticated user
|
|
1448
|
+
* @description Update the authenticated User.
|
|
1449
|
+
*/
|
|
1450
|
+
put: operations["updateMe"];
|
|
1443
1451
|
post?: never;
|
|
1444
1452
|
delete?: never;
|
|
1445
1453
|
options?: never;
|
|
@@ -1648,7 +1656,7 @@ interface paths {
|
|
|
1648
1656
|
};
|
|
1649
1657
|
/**
|
|
1650
1658
|
* Get all recommendations
|
|
1651
|
-
* @description Return all Recommendations.
|
|
1659
|
+
* @description Return all Recommendations. Use the `type` query parameter with a fuzzy fragment to filter recommendation type case-insensitively (for example: aws, aws:ec2, aws:ec2:rightsizing).
|
|
1652
1660
|
*/
|
|
1653
1661
|
get: operations["getRecommendations"];
|
|
1654
1662
|
put?: never;
|
|
@@ -2271,7 +2279,11 @@ interface paths {
|
|
|
2271
2279
|
* @description Return a specific User.
|
|
2272
2280
|
*/
|
|
2273
2281
|
get: operations["getUser"];
|
|
2274
|
-
|
|
2282
|
+
/**
|
|
2283
|
+
* Update a user
|
|
2284
|
+
* @description Update a specific User.
|
|
2285
|
+
*/
|
|
2286
|
+
put: operations["updateUser"];
|
|
2275
2287
|
post?: never;
|
|
2276
2288
|
delete?: never;
|
|
2277
2289
|
options?: never;
|
|
@@ -3123,7 +3135,7 @@ interface components {
|
|
|
3123
3135
|
*/
|
|
3124
3136
|
created_at: string;
|
|
3125
3137
|
/** @description The token for the Workspace the ResourceReport is a part of. */
|
|
3126
|
-
workspace_token: string;
|
|
3138
|
+
workspace_token: string | null;
|
|
3127
3139
|
/** @description The token for the User who created this BudgetAlert. */
|
|
3128
3140
|
user_token?: string | null;
|
|
3129
3141
|
/** @description The Users that receive the alert. */
|
|
@@ -3593,7 +3605,7 @@ interface components {
|
|
|
3593
3605
|
threshold: number;
|
|
3594
3606
|
/** @description The unit type used to compare costs. Options are 'currency' or 'percentage'. */
|
|
3595
3607
|
unit_type: string;
|
|
3596
|
-
/** @description The minimum
|
|
3608
|
+
/** @description The minimum monetary amount threshold for percentage-based alerts. When set, alerts will only trigger if the cost change meets this minimum, even if the percentage threshold is exceeded. */
|
|
3597
3609
|
minimum_threshold: number | null;
|
|
3598
3610
|
/** @description The tokens of the reports to alert on. */
|
|
3599
3611
|
report_tokens: string[];
|
|
@@ -3623,7 +3635,7 @@ interface components {
|
|
|
3623
3635
|
teams_channels?: string[];
|
|
3624
3636
|
/**
|
|
3625
3637
|
* Format: float
|
|
3626
|
-
* @description The minimum
|
|
3638
|
+
* @description The minimum monetary amount threshold for percentage-based alerts. Only applicable when unit_type is 'percentage'.
|
|
3627
3639
|
*/
|
|
3628
3640
|
minimum_threshold?: number;
|
|
3629
3641
|
};
|
|
@@ -3650,7 +3662,7 @@ interface components {
|
|
|
3650
3662
|
report_tokens?: string[];
|
|
3651
3663
|
/**
|
|
3652
3664
|
* Format: float
|
|
3653
|
-
* @description The minimum
|
|
3665
|
+
* @description The minimum monetary amount threshold for percentage-based alerts. Only applicable when unit_type is 'percentage'.
|
|
3654
3666
|
*/
|
|
3655
3667
|
minimum_threshold?: number;
|
|
3656
3668
|
};
|
|
@@ -3971,21 +3983,21 @@ interface components {
|
|
|
3971
3983
|
/** @description Report settings. */
|
|
3972
3984
|
settings?: {
|
|
3973
3985
|
/** @description Report will include credits. */
|
|
3974
|
-
include_credits?: boolean;
|
|
3986
|
+
include_credits?: boolean | null;
|
|
3975
3987
|
/** @description Report will include refunds. */
|
|
3976
|
-
include_refunds?: boolean;
|
|
3988
|
+
include_refunds?: boolean | null;
|
|
3977
3989
|
/** @description Report will include discounts. */
|
|
3978
|
-
include_discounts?: boolean;
|
|
3990
|
+
include_discounts?: boolean | null;
|
|
3979
3991
|
/** @description Report will include tax. */
|
|
3980
|
-
include_tax?: boolean;
|
|
3992
|
+
include_tax?: boolean | null;
|
|
3981
3993
|
/** @description Report will amortize. */
|
|
3982
|
-
amortize?: boolean;
|
|
3994
|
+
amortize?: boolean | null;
|
|
3983
3995
|
/** @description Report will show unallocated costs. */
|
|
3984
|
-
unallocated?: boolean;
|
|
3996
|
+
unallocated?: boolean | null;
|
|
3985
3997
|
/** @description Report will aggregate by cost or usage. */
|
|
3986
|
-
aggregate_by?: string;
|
|
3998
|
+
aggregate_by?: string | null;
|
|
3987
3999
|
/** @description Report will show previous period costs or usage comparison. */
|
|
3988
|
-
show_previous_period?: boolean;
|
|
4000
|
+
show_previous_period?: boolean | null;
|
|
3989
4001
|
};
|
|
3990
4002
|
/** @description Report chart settings. */
|
|
3991
4003
|
chart_settings?: {
|
|
@@ -4042,7 +4054,7 @@ interface components {
|
|
|
4042
4054
|
* @default vntg
|
|
4043
4055
|
* @enum {string}
|
|
4044
4056
|
*/
|
|
4045
|
-
schema?: "vntg" | "focus";
|
|
4057
|
+
schema?: "vntg" | "focus" | "comparison";
|
|
4046
4058
|
};
|
|
4047
4059
|
/** @description Costs model */
|
|
4048
4060
|
Costs: {
|
|
@@ -4612,6 +4624,8 @@ interface components {
|
|
|
4612
4624
|
* @example 2023-08-04T00:00:00Z
|
|
4613
4625
|
*/
|
|
4614
4626
|
created_at: string;
|
|
4627
|
+
/** @description The tokens for any Managed Accounts that are associated with the Integration. */
|
|
4628
|
+
managed_account_tokens: string[];
|
|
4615
4629
|
};
|
|
4616
4630
|
/** @description Create a Custom Provider Integration */
|
|
4617
4631
|
createCustomProviderIntegration: {
|
|
@@ -4737,6 +4751,14 @@ interface components {
|
|
|
4737
4751
|
*/
|
|
4738
4752
|
file_type: "pdf" | "csv";
|
|
4739
4753
|
};
|
|
4754
|
+
/** @description DownloadInvoice model */
|
|
4755
|
+
DownloadInvoice: {
|
|
4756
|
+
/**
|
|
4757
|
+
* @description The URL to download the invoice file.
|
|
4758
|
+
* @example https://example.com/invoice.pdf
|
|
4759
|
+
*/
|
|
4760
|
+
download_url: string;
|
|
4761
|
+
};
|
|
4740
4762
|
/** @description SendInvoice model */
|
|
4741
4763
|
SendInvoice: {
|
|
4742
4764
|
recipients: string[];
|
|
@@ -4911,6 +4933,13 @@ interface components {
|
|
|
4911
4933
|
email_domain?: string | null;
|
|
4912
4934
|
/** @description Token of the MSP billing profile used for this managed account (MSP invoicing accounts only) */
|
|
4913
4935
|
msp_billing_profile_token?: string | null;
|
|
4936
|
+
/**
|
|
4937
|
+
* Format: int32
|
|
4938
|
+
* @description Number of days until payment is due after invoice date (MSP invoicing accounts only)
|
|
4939
|
+
*/
|
|
4940
|
+
payment_terms_days?: number | null;
|
|
4941
|
+
/** @description Whether to include managed account's own integrations in invoice cost calculations (MSP invoicing accounts only) */
|
|
4942
|
+
include_managed_account_integrations?: boolean | null;
|
|
4914
4943
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
4915
4944
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
4916
4945
|
};
|
|
@@ -4941,6 +4970,13 @@ interface components {
|
|
|
4941
4970
|
email_domain?: string;
|
|
4942
4971
|
/** @description Token of the MSP billing profile to use for this managed account (MSP invoicing accounts only). */
|
|
4943
4972
|
msp_billing_profile_token?: string;
|
|
4973
|
+
/**
|
|
4974
|
+
* Format: int32
|
|
4975
|
+
* @description Number of days until payment is due after invoice date (MSP invoicing accounts only). Defaults to 10.
|
|
4976
|
+
*/
|
|
4977
|
+
payment_terms_days?: number;
|
|
4978
|
+
/** @description Whether to include managed account's own integrations in invoice cost calculations (MSP invoicing accounts only). Defaults to false. */
|
|
4979
|
+
include_managed_account_integrations?: boolean;
|
|
4944
4980
|
/** @description Billing address and contact information (MSP invoicing accounts only) */
|
|
4945
4981
|
billing_information_attributes?: {
|
|
4946
4982
|
/** Format: int32 */
|
|
@@ -5002,6 +5038,8 @@ interface components {
|
|
|
5002
5038
|
/** @description Me model */
|
|
5003
5039
|
Me: {
|
|
5004
5040
|
default_workspace_token: string | null;
|
|
5041
|
+
/** @description The token of the default Dashboard for the User. */
|
|
5042
|
+
default_dashboard_token?: string | null;
|
|
5005
5043
|
workspaces: components["schemas"]["Workspace"][];
|
|
5006
5044
|
bearer_token: components["schemas"]["BearerToken"];
|
|
5007
5045
|
};
|
|
@@ -5039,6 +5077,11 @@ interface components {
|
|
|
5039
5077
|
/** @description The scopes applied to the BearerToken used to authenticate this request. */
|
|
5040
5078
|
scope: string[];
|
|
5041
5079
|
};
|
|
5080
|
+
/** @description Update the authenticated User. */
|
|
5081
|
+
updateMe: {
|
|
5082
|
+
/** @description The token of a Dashboard to set as the User default. Send null to clear. */
|
|
5083
|
+
default_dashboard_token?: string;
|
|
5084
|
+
};
|
|
5042
5085
|
/** @description CostProviders model */
|
|
5043
5086
|
CostProviders: {
|
|
5044
5087
|
links?: components["schemas"]["Links"];
|
|
@@ -5769,15 +5812,15 @@ interface components {
|
|
|
5769
5812
|
/** @description Report settings configurable on top-level Segments. */
|
|
5770
5813
|
report_settings?: {
|
|
5771
5814
|
/** @description Reports created under this Segment will include credits. */
|
|
5772
|
-
include_credits?: boolean;
|
|
5815
|
+
include_credits?: boolean | null;
|
|
5773
5816
|
/** @description Reports created under this Segment will include refunds. */
|
|
5774
|
-
include_refunds?: boolean;
|
|
5817
|
+
include_refunds?: boolean | null;
|
|
5775
5818
|
/** @description Reports created under this Segment will include discounts. */
|
|
5776
|
-
include_discounts?: boolean;
|
|
5819
|
+
include_discounts?: boolean | null;
|
|
5777
5820
|
/** @description Reports created under this Segment will include tax. */
|
|
5778
|
-
include_tax?: boolean;
|
|
5821
|
+
include_tax?: boolean | null;
|
|
5779
5822
|
/** @description Reports created under this Segment will amortize. */
|
|
5780
|
-
amortize?: boolean;
|
|
5823
|
+
amortize?: boolean | null;
|
|
5781
5824
|
};
|
|
5782
5825
|
/** @description The token of the Workspace to add the Segment to. Ignored if 'segment_token' is set. Required if the API token is associated with multiple Workspaces. */
|
|
5783
5826
|
workspace_token?: string;
|
|
@@ -5805,15 +5848,15 @@ interface components {
|
|
|
5805
5848
|
/** @description Report settings configurable on top-level Segments. */
|
|
5806
5849
|
report_settings?: {
|
|
5807
5850
|
/** @description Reports created under this Segment will include credits. */
|
|
5808
|
-
include_credits?: boolean;
|
|
5851
|
+
include_credits?: boolean | null;
|
|
5809
5852
|
/** @description Reports created under this Segment will include refunds. */
|
|
5810
|
-
include_refunds?: boolean;
|
|
5853
|
+
include_refunds?: boolean | null;
|
|
5811
5854
|
/** @description Reports created under this Segment will include discounts. */
|
|
5812
|
-
include_discounts?: boolean;
|
|
5855
|
+
include_discounts?: boolean | null;
|
|
5813
5856
|
/** @description Reports created under this Segment will include tax. */
|
|
5814
|
-
include_tax?: boolean;
|
|
5857
|
+
include_tax?: boolean | null;
|
|
5815
5858
|
/** @description Reports created under this Segment will amortize. */
|
|
5816
|
-
amortize?: boolean;
|
|
5859
|
+
amortize?: boolean | null;
|
|
5817
5860
|
};
|
|
5818
5861
|
/** @description The filter query language to apply to the Segment. Additional documentation available at https://docs.vantage.sh/vql. */
|
|
5819
5862
|
filter?: string;
|
|
@@ -5881,6 +5924,11 @@ interface components {
|
|
|
5881
5924
|
user_emails: string[];
|
|
5882
5925
|
/** @description The tokens for Users that belong to the Team */
|
|
5883
5926
|
user_tokens: string[];
|
|
5927
|
+
/**
|
|
5928
|
+
* @description The token of the default Dashboard for the Team.
|
|
5929
|
+
* @example dshbrd_abcd1234
|
|
5930
|
+
*/
|
|
5931
|
+
default_dashboard_token: string | null;
|
|
5884
5932
|
};
|
|
5885
5933
|
/** @description Create a new Team. */
|
|
5886
5934
|
createTeam: {
|
|
@@ -5899,6 +5947,8 @@ interface components {
|
|
|
5899
5947
|
* @enum {string}
|
|
5900
5948
|
*/
|
|
5901
5949
|
role?: "owner" | "editor" | "viewer";
|
|
5950
|
+
/** @description The token of a Dashboard to set as the Team default. Send null to clear. */
|
|
5951
|
+
default_dashboard_token?: string | null;
|
|
5902
5952
|
};
|
|
5903
5953
|
/** @description Update a Team. */
|
|
5904
5954
|
updateTeam: {
|
|
@@ -5917,6 +5967,8 @@ interface components {
|
|
|
5917
5967
|
* @enum {string}
|
|
5918
5968
|
*/
|
|
5919
5969
|
role?: "owner" | "editor" | "viewer";
|
|
5970
|
+
/** @description The token of a Dashboard to set as the Team default. Send null to clear. */
|
|
5971
|
+
default_dashboard_token?: string | null;
|
|
5920
5972
|
};
|
|
5921
5973
|
/** @description TeamMembers model */
|
|
5922
5974
|
TeamMembers: {
|
|
@@ -6035,12 +6087,22 @@ interface components {
|
|
|
6035
6087
|
* @example Admin
|
|
6036
6088
|
*/
|
|
6037
6089
|
role: string;
|
|
6090
|
+
/**
|
|
6091
|
+
* @description The token of the default Dashboard for the User.
|
|
6092
|
+
* @example dshbrd_abcdef123456
|
|
6093
|
+
*/
|
|
6094
|
+
default_dashboard_token?: string | null;
|
|
6038
6095
|
/**
|
|
6039
6096
|
* @description The last time the User logged in.
|
|
6040
6097
|
* @example 2024-01-01T00:00:00Z
|
|
6041
6098
|
*/
|
|
6042
6099
|
last_seen_at?: string | null;
|
|
6043
6100
|
};
|
|
6101
|
+
/** @description Update a specific User. */
|
|
6102
|
+
updateUser: {
|
|
6103
|
+
/** @description The token of a Dashboard to set as the User default. Send null to clear. */
|
|
6104
|
+
default_dashboard_token?: string;
|
|
6105
|
+
};
|
|
6044
6106
|
/** @description VirtualTagConfigs model */
|
|
6045
6107
|
VirtualTagConfigs: {
|
|
6046
6108
|
virtual_tag_configs: components["schemas"]["VirtualTagConfig"][];
|
|
@@ -6066,7 +6128,7 @@ interface components {
|
|
|
6066
6128
|
overridable: boolean;
|
|
6067
6129
|
/**
|
|
6068
6130
|
* @description The earliest month VirtualTagConfig should be backfilled to.
|
|
6069
|
-
* @example 2025-
|
|
6131
|
+
* @example 2025-09-01
|
|
6070
6132
|
*/
|
|
6071
6133
|
backfill_until: string;
|
|
6072
6134
|
/** @description Tag keys to collapse values for. */
|
|
@@ -6248,6 +6310,19 @@ interface components {
|
|
|
6248
6310
|
}[];
|
|
6249
6311
|
}[];
|
|
6250
6312
|
};
|
|
6313
|
+
/** @description AsyncVirtualTagConfigUpdate model */
|
|
6314
|
+
AsyncVirtualTagConfigUpdate: {
|
|
6315
|
+
/**
|
|
6316
|
+
* @description The request ID of the async virtual tag config update.
|
|
6317
|
+
* @example 550e8400-e29b-41d4-a716-446655440000
|
|
6318
|
+
*/
|
|
6319
|
+
request_id: string;
|
|
6320
|
+
/**
|
|
6321
|
+
* @description The status path of the async virtual tag config update.
|
|
6322
|
+
* @example /v2/virtual_tag_configs/async/550e8400-e29b-41d4-a716-446655440000
|
|
6323
|
+
*/
|
|
6324
|
+
status_url: string;
|
|
6325
|
+
};
|
|
6251
6326
|
/** @description Asynchronously updates an existing VirtualTagConfig. */
|
|
6252
6327
|
updateAsyncVirtualTagConfig: {
|
|
6253
6328
|
/** @description The key of the VirtualTagConfig. */
|
|
@@ -10743,7 +10818,8 @@ interface operations {
|
|
|
10743
10818
|
* "workspace_tokens": [
|
|
10744
10819
|
* "wrkspc_838cb4508ead3f6d"
|
|
10745
10820
|
* ],
|
|
10746
|
-
* "created_at": "2024-07-29T21:41:49Z"
|
|
10821
|
+
* "created_at": "2024-07-29T21:41:49Z",
|
|
10822
|
+
* "managed_account_tokens": []
|
|
10747
10823
|
* }
|
|
10748
10824
|
* ]
|
|
10749
10825
|
* }
|
|
@@ -10779,7 +10855,10 @@ interface operations {
|
|
|
10779
10855
|
* "workspace_tokens": [
|
|
10780
10856
|
* "wrkspc_d69f96653fb985d6"
|
|
10781
10857
|
* ],
|
|
10782
|
-
* "created_at": "2024-07-29T21:41:49Z"
|
|
10858
|
+
* "created_at": "2024-07-29T21:41:49Z",
|
|
10859
|
+
* "managed_account_tokens": [
|
|
10860
|
+
* "acct_1a2b3c4d5e6f7890"
|
|
10861
|
+
* ]
|
|
10783
10862
|
* }
|
|
10784
10863
|
*/
|
|
10785
10864
|
"application/json": components["schemas"]["Integration"];
|
|
@@ -10826,7 +10905,8 @@ interface operations {
|
|
|
10826
10905
|
* "workspace_tokens": [
|
|
10827
10906
|
* "wrkspc_6bffe31969c9f385"
|
|
10828
10907
|
* ],
|
|
10829
|
-
* "created_at": "2024-07-29T21:41:44Z"
|
|
10908
|
+
* "created_at": "2024-07-29T21:41:44Z",
|
|
10909
|
+
* "managed_account_tokens": []
|
|
10830
10910
|
* }
|
|
10831
10911
|
*/
|
|
10832
10912
|
"application/json": components["schemas"]["Integration"];
|
|
@@ -10908,7 +10988,8 @@ interface operations {
|
|
|
10908
10988
|
* "status": "imported",
|
|
10909
10989
|
* "last_updated": null,
|
|
10910
10990
|
* "workspace_tokens": [],
|
|
10911
|
-
* "created_at": "2024-08-27T22:22:24Z"
|
|
10991
|
+
* "created_at": "2024-08-27T22:22:24Z",
|
|
10992
|
+
* "managed_account_tokens": []
|
|
10912
10993
|
* }
|
|
10913
10994
|
*/
|
|
10914
10995
|
"application/json": components["schemas"]["Integration"];
|
|
@@ -11134,7 +11215,8 @@ interface operations {
|
|
|
11134
11215
|
* "status": "imported",
|
|
11135
11216
|
* "last_updated": null,
|
|
11136
11217
|
* "workspace_tokens": [],
|
|
11137
|
-
* "created_at": "2024-07-29T21:41:46Z"
|
|
11218
|
+
* "created_at": "2024-07-29T21:41:46Z",
|
|
11219
|
+
* "managed_account_tokens": []
|
|
11138
11220
|
* }
|
|
11139
11221
|
*/
|
|
11140
11222
|
"application/json": components["schemas"]["Integration"];
|
|
@@ -11177,7 +11259,8 @@ interface operations {
|
|
|
11177
11259
|
* "status": "imported",
|
|
11178
11260
|
* "last_updated": null,
|
|
11179
11261
|
* "workspace_tokens": [],
|
|
11180
|
-
* "created_at": "2024-07-29T21:41:48Z"
|
|
11262
|
+
* "created_at": "2024-07-29T21:41:48Z",
|
|
11263
|
+
* "managed_account_tokens": []
|
|
11181
11264
|
* }
|
|
11182
11265
|
*/
|
|
11183
11266
|
"application/json": components["schemas"]["Integration"];
|
|
@@ -11302,7 +11385,9 @@ interface operations {
|
|
|
11302
11385
|
headers: {
|
|
11303
11386
|
[name: string]: unknown;
|
|
11304
11387
|
};
|
|
11305
|
-
content
|
|
11388
|
+
content: {
|
|
11389
|
+
"application/json": components["schemas"]["DownloadInvoice"];
|
|
11390
|
+
};
|
|
11306
11391
|
};
|
|
11307
11392
|
/** @description NotFound */
|
|
11308
11393
|
404: {
|
|
@@ -12050,6 +12135,45 @@ interface operations {
|
|
|
12050
12135
|
};
|
|
12051
12136
|
};
|
|
12052
12137
|
};
|
|
12138
|
+
deleteSsoConnectionForManagedAccount: {
|
|
12139
|
+
parameters: {
|
|
12140
|
+
query?: never;
|
|
12141
|
+
header?: never;
|
|
12142
|
+
path: {
|
|
12143
|
+
managed_account_token: string;
|
|
12144
|
+
};
|
|
12145
|
+
cookie?: never;
|
|
12146
|
+
};
|
|
12147
|
+
requestBody?: never;
|
|
12148
|
+
responses: {
|
|
12149
|
+
204: {
|
|
12150
|
+
headers: {
|
|
12151
|
+
[name: string]: unknown;
|
|
12152
|
+
};
|
|
12153
|
+
content: {
|
|
12154
|
+
"application/json": components["schemas"]["ManagedAccount"];
|
|
12155
|
+
};
|
|
12156
|
+
};
|
|
12157
|
+
/** @description BadRequest */
|
|
12158
|
+
400: {
|
|
12159
|
+
headers: {
|
|
12160
|
+
[name: string]: unknown;
|
|
12161
|
+
};
|
|
12162
|
+
content: {
|
|
12163
|
+
"application/json": components["schemas"]["Errors"];
|
|
12164
|
+
};
|
|
12165
|
+
};
|
|
12166
|
+
/** @description NotFound */
|
|
12167
|
+
404: {
|
|
12168
|
+
headers: {
|
|
12169
|
+
[name: string]: unknown;
|
|
12170
|
+
};
|
|
12171
|
+
content: {
|
|
12172
|
+
"application/json": components["schemas"]["Errors"];
|
|
12173
|
+
};
|
|
12174
|
+
};
|
|
12175
|
+
};
|
|
12176
|
+
};
|
|
12053
12177
|
getMe: {
|
|
12054
12178
|
parameters: {
|
|
12055
12179
|
query?: never;
|
|
@@ -12070,6 +12194,38 @@ interface operations {
|
|
|
12070
12194
|
};
|
|
12071
12195
|
};
|
|
12072
12196
|
};
|
|
12197
|
+
updateMe: {
|
|
12198
|
+
parameters: {
|
|
12199
|
+
query?: never;
|
|
12200
|
+
header?: never;
|
|
12201
|
+
path?: never;
|
|
12202
|
+
cookie?: never;
|
|
12203
|
+
};
|
|
12204
|
+
requestBody: {
|
|
12205
|
+
content: {
|
|
12206
|
+
"application/json": components["schemas"]["updateMe"];
|
|
12207
|
+
};
|
|
12208
|
+
};
|
|
12209
|
+
responses: {
|
|
12210
|
+
200: {
|
|
12211
|
+
headers: {
|
|
12212
|
+
[name: string]: unknown;
|
|
12213
|
+
};
|
|
12214
|
+
content: {
|
|
12215
|
+
"application/json": components["schemas"]["Me"];
|
|
12216
|
+
};
|
|
12217
|
+
};
|
|
12218
|
+
/** @description UnprocessableEntity */
|
|
12219
|
+
422: {
|
|
12220
|
+
headers: {
|
|
12221
|
+
[name: string]: unknown;
|
|
12222
|
+
};
|
|
12223
|
+
content: {
|
|
12224
|
+
"application/json": components["schemas"]["Errors"];
|
|
12225
|
+
};
|
|
12226
|
+
};
|
|
12227
|
+
};
|
|
12228
|
+
};
|
|
12073
12229
|
getCostProviders: {
|
|
12074
12230
|
parameters: {
|
|
12075
12231
|
query?: {
|
|
@@ -12677,8 +12833,10 @@ interface operations {
|
|
|
12677
12833
|
workspace_token?: string;
|
|
12678
12834
|
/** @description Filter by provider account id (AWS account, Azure subscription id, etc). */
|
|
12679
12835
|
provider_account_id?: string;
|
|
12680
|
-
/** @description Filter by category. */
|
|
12681
|
-
category?:
|
|
12836
|
+
/** @description Filter by exact recommendation category. Ignored when type is provided. */
|
|
12837
|
+
category?: string;
|
|
12838
|
+
/** @description Fuzzy filter by recommendation type using a case-insensitive literal substring. Examples: aws, aws:ec2, aws:ec2:rightsizing. */
|
|
12839
|
+
type?: string;
|
|
12682
12840
|
/** @description Filter by provider. */
|
|
12683
12841
|
provider?: "aws" | "gcp" | "azure" | "kubernetes" | "datadog";
|
|
12684
12842
|
};
|
|
@@ -14756,7 +14914,8 @@ interface operations {
|
|
|
14756
14914
|
* ],
|
|
14757
14915
|
* "user_tokens": [
|
|
14758
14916
|
* "usr_c59398553e838116"
|
|
14759
|
-
* ]
|
|
14917
|
+
* ],
|
|
14918
|
+
* "default_dashboard_token": null
|
|
14760
14919
|
* }
|
|
14761
14920
|
* ]
|
|
14762
14921
|
* }
|
|
@@ -14794,7 +14953,8 @@ interface operations {
|
|
|
14794
14953
|
* ],
|
|
14795
14954
|
* "user_tokens": [
|
|
14796
14955
|
* "usr_a00e614b5843c234"
|
|
14797
|
-
* ]
|
|
14956
|
+
* ],
|
|
14957
|
+
* "default_dashboard_token": null
|
|
14798
14958
|
* }
|
|
14799
14959
|
*/
|
|
14800
14960
|
"application/json": components["schemas"]["Team"];
|
|
@@ -14864,7 +15024,8 @@ interface operations {
|
|
|
14864
15024
|
* ],
|
|
14865
15025
|
* "user_tokens": [
|
|
14866
15026
|
* "usr_7c309915e847cfc6"
|
|
14867
|
-
* ]
|
|
15027
|
+
* ],
|
|
15028
|
+
* "default_dashboard_token": null
|
|
14868
15029
|
* }
|
|
14869
15030
|
*/
|
|
14870
15031
|
"application/json": components["schemas"]["Team"];
|
|
@@ -14911,7 +15072,8 @@ interface operations {
|
|
|
14911
15072
|
* ],
|
|
14912
15073
|
* "user_tokens": [
|
|
14913
15074
|
* "usr_d268561e520c7aac"
|
|
14914
|
-
* ]
|
|
15075
|
+
* ],
|
|
15076
|
+
* "default_dashboard_token": null
|
|
14915
15077
|
* }
|
|
14916
15078
|
*/
|
|
14917
15079
|
"application/json": components["schemas"]["Team"];
|
|
@@ -15450,6 +15612,49 @@ interface operations {
|
|
|
15450
15612
|
};
|
|
15451
15613
|
};
|
|
15452
15614
|
};
|
|
15615
|
+
updateUser: {
|
|
15616
|
+
parameters: {
|
|
15617
|
+
query?: never;
|
|
15618
|
+
header?: never;
|
|
15619
|
+
path: {
|
|
15620
|
+
user_token: string;
|
|
15621
|
+
};
|
|
15622
|
+
cookie?: never;
|
|
15623
|
+
};
|
|
15624
|
+
requestBody: {
|
|
15625
|
+
content: {
|
|
15626
|
+
"application/json": components["schemas"]["updateUser"];
|
|
15627
|
+
};
|
|
15628
|
+
};
|
|
15629
|
+
responses: {
|
|
15630
|
+
200: {
|
|
15631
|
+
headers: {
|
|
15632
|
+
[name: string]: unknown;
|
|
15633
|
+
};
|
|
15634
|
+
content: {
|
|
15635
|
+
"application/json": components["schemas"]["User"];
|
|
15636
|
+
};
|
|
15637
|
+
};
|
|
15638
|
+
/** @description NotFound */
|
|
15639
|
+
404: {
|
|
15640
|
+
headers: {
|
|
15641
|
+
[name: string]: unknown;
|
|
15642
|
+
};
|
|
15643
|
+
content: {
|
|
15644
|
+
"application/json": components["schemas"]["Errors"];
|
|
15645
|
+
};
|
|
15646
|
+
};
|
|
15647
|
+
/** @description UnprocessableEntity */
|
|
15648
|
+
422: {
|
|
15649
|
+
headers: {
|
|
15650
|
+
[name: string]: unknown;
|
|
15651
|
+
};
|
|
15652
|
+
content: {
|
|
15653
|
+
"application/json": components["schemas"]["Errors"];
|
|
15654
|
+
};
|
|
15655
|
+
};
|
|
15656
|
+
};
|
|
15657
|
+
};
|
|
15453
15658
|
getVirtualTagConfigs: {
|
|
15454
15659
|
parameters: {
|
|
15455
15660
|
query?: never;
|
|
@@ -15705,6 +15910,15 @@ interface operations {
|
|
|
15705
15910
|
"application/json": components["schemas"]["VirtualTagConfig"];
|
|
15706
15911
|
};
|
|
15707
15912
|
};
|
|
15913
|
+
/** @description Request accepted for processing */
|
|
15914
|
+
202: {
|
|
15915
|
+
headers: {
|
|
15916
|
+
[name: string]: unknown;
|
|
15917
|
+
};
|
|
15918
|
+
content: {
|
|
15919
|
+
"application/json": components["schemas"]["AsyncVirtualTagConfigUpdate"];
|
|
15920
|
+
};
|
|
15921
|
+
};
|
|
15708
15922
|
/** @description BadRequest */
|
|
15709
15923
|
400: {
|
|
15710
15924
|
headers: {
|
|
@@ -15874,7 +16088,9 @@ interface operations {
|
|
|
15874
16088
|
headers: {
|
|
15875
16089
|
[name: string]: unknown;
|
|
15876
16090
|
};
|
|
15877
|
-
content
|
|
16091
|
+
content: {
|
|
16092
|
+
"application/json": components["schemas"]["AsyncVirtualTagConfigUpdate"];
|
|
16093
|
+
};
|
|
15878
16094
|
};
|
|
15879
16095
|
/** @description BadRequest */
|
|
15880
16096
|
400: {
|
|
@@ -16135,112 +16351,12 @@ interface operations {
|
|
|
16135
16351
|
};
|
|
16136
16352
|
}
|
|
16137
16353
|
|
|
16138
|
-
|
|
16139
|
-
|
|
16140
|
-
|
|
16141
|
-
|
|
16142
|
-
|
|
16143
|
-
declare function pathEncode(value: string): NoSlashString;
|
|
16144
|
-
type UnBracket<S extends string> = S extends `${infer X}{${string}}${infer Z}` ? UnBracket<`${X}${NoSlashString}${Z}`> : S;
|
|
16145
|
-
type PathsRedefined = {
|
|
16146
|
-
[K in keyof paths as `/v2${UnBracket<K>}`]: [paths[K], K];
|
|
16147
|
-
};
|
|
16148
|
-
/** Defines a union of paths supported by the client. */
|
|
16149
|
-
type Path = keyof PathsRedefined;
|
|
16150
|
-
type MethodsCased = {
|
|
16151
|
-
get: "GET";
|
|
16152
|
-
post: "POST";
|
|
16153
|
-
put: "PUT";
|
|
16154
|
-
delete: "DELETE";
|
|
16155
|
-
patch: "PATCH";
|
|
16156
|
-
head: "HEAD";
|
|
16157
|
-
options: "OPTIONS";
|
|
16158
|
-
trace: "TRACE";
|
|
16159
|
-
};
|
|
16160
|
-
type MethodsInverted = {
|
|
16161
|
-
[K in keyof MethodsCased as MethodsCased[K]]: K;
|
|
16162
|
-
};
|
|
16163
|
-
type MethodsPossiblyUndefined = {
|
|
16164
|
-
[K in keyof MethodsCased]?: any;
|
|
16165
|
-
};
|
|
16166
|
-
type Methods<P extends MethodsPossiblyUndefined> = {
|
|
16167
|
-
[K in keyof MethodsCased]: P[K] extends undefined ? never : MethodsCased[K];
|
|
16168
|
-
}[keyof MethodsCased];
|
|
16169
|
-
/** Defines the supported request methods for a given path. */
|
|
16170
|
-
type SupportedMethods<P extends Path> = Methods<PathsRedefined[P][0]>;
|
|
16171
|
-
type Query<T extends {
|
|
16172
|
-
parameters?: {
|
|
16173
|
-
query?: any;
|
|
16174
|
-
};
|
|
16175
|
-
} | undefined> = T["parameters"]["query"] extends never | undefined ? {} : T["parameters"]["query"];
|
|
16176
|
-
type ReqBody<T extends {
|
|
16177
|
-
requestBody?: {
|
|
16178
|
-
content: any;
|
|
16179
|
-
};
|
|
16180
|
-
} | undefined> = T extends {
|
|
16181
|
-
requestBody: {
|
|
16182
|
-
content: {
|
|
16183
|
-
"application/json": infer R;
|
|
16184
|
-
};
|
|
16185
|
-
};
|
|
16186
|
-
} ? R : T extends {
|
|
16187
|
-
requestBody: {
|
|
16188
|
-
content: {
|
|
16189
|
-
"multipart/form-data": infer R;
|
|
16190
|
-
};
|
|
16191
|
-
};
|
|
16192
|
-
} ? R : {};
|
|
16193
|
-
/** Defines the request body type for a given path and method. */
|
|
16194
|
-
type RequestBodyForPathAndMethod<P extends Path, M extends SupportedMethods<P>> = M extends "GET" ? Query<PathsRedefined[P][0][MethodsInverted[M]]> : ReqBody<PathsRedefined[P][0][MethodsInverted[M]]>;
|
|
16195
|
-
type ExtendsGoodResponseCode<Code extends number, Output> = {
|
|
16196
|
-
[C in Code]: {
|
|
16197
|
-
responses: {
|
|
16198
|
-
[_ in C]: {
|
|
16199
|
-
content: {
|
|
16200
|
-
"application/json": Output;
|
|
16201
|
-
};
|
|
16202
|
-
};
|
|
16203
|
-
};
|
|
16204
|
-
};
|
|
16205
|
-
}[Code];
|
|
16206
|
-
/** Patches for specific endpoints go here. This is useful for when the OpenAPI spec is not specific enough for our liking. */
|
|
16207
|
-
type PathAndMethodSpecificPatches = {
|
|
16208
|
-
"/v2/costs": {
|
|
16209
|
-
GET: {
|
|
16210
|
-
total_usage?: {
|
|
16211
|
-
[usageUnit: string]: string;
|
|
16212
|
-
};
|
|
16213
|
-
};
|
|
16214
|
-
};
|
|
16215
|
-
};
|
|
16216
|
-
type LookupTableType = {
|
|
16217
|
-
[P in Path]: Partial<{
|
|
16218
|
-
[M in SupportedMethods<P>]: any;
|
|
16219
|
-
}>;
|
|
16220
|
-
};
|
|
16221
|
-
type ExecutePatch<Patch, Response> = keyof Patch extends never ? Response : Omit<Response, keyof Patch> & Patch;
|
|
16222
|
-
type DoPathSpecificPatches<P extends Path, M extends SupportedMethods<P>, Response, LookupTable extends Partial<LookupTableType>> = LookupTable[P] extends never ? Response : ExecutePatch<LookupTable[P][M], Response>;
|
|
16223
|
-
/** Defines the response body type for a given path and method. */
|
|
16224
|
-
type ResponseBodyForPathAndMethod<P extends Path, M extends SupportedMethods<P>> = PathsRedefined[P][0][MethodsInverted[M]] extends ExtendsGoodResponseCode<200 | 201 | 202 | 203 | 204, infer R> ? DoPathSpecificPatches<P, M, R, PathAndMethodSpecificPatches> : void;
|
|
16225
|
-
/** Defines a vantage API failure */
|
|
16226
|
-
declare class VantageAPIError extends Error {
|
|
16227
|
-
readonly status: number | null;
|
|
16228
|
-
readonly statusText: string | null;
|
|
16229
|
-
readonly body: string;
|
|
16230
|
-
readonly errors: string[] | null;
|
|
16231
|
-
constructor(status: number | null, statusText: string | null, body: string);
|
|
16232
|
-
}
|
|
16233
|
-
type NeverThrowResult<T> = [null, VantageAPIError] | [T, null];
|
|
16234
|
-
/** Defines the base client for all API requests. */
|
|
16235
|
-
declare class BaseClient<NeverThrow extends boolean> {
|
|
16236
|
-
private readonly bearerToken;
|
|
16237
|
-
private readonly neverThrow;
|
|
16238
|
-
readonly baseUrl: string;
|
|
16239
|
-
constructor(bearerToken: string, neverThrow: NeverThrow, baseUrl: string);
|
|
16240
|
-
/** Sends a request to the API. */
|
|
16241
|
-
request<RequestPath extends Path, RequestMethod extends SupportedMethods<RequestPath>>(path: RequestPath, method: RequestMethod, body: RequestBodyForPathAndMethod<RequestPath, RequestMethod>): Promise<NeverThrow extends true ? NeverThrowResult<ResponseBodyForPathAndMethod<RequestPath, RequestMethod>> : ResponseBodyForPathAndMethod<RequestPath, RequestMethod>>;
|
|
16354
|
+
interface PathResponseEdgecases {
|
|
16355
|
+
"POST /v2/costs/data_exports": string;
|
|
16356
|
+
"POST /v2/kubernetes_efficiency_reports/data_exports": string;
|
|
16357
|
+
"POST /v2/unit_costs/data_exports": string;
|
|
16358
|
+
[key: `GET /v2/virtual_tag_configs/async/${NoSlashString}`]: boolean;
|
|
16242
16359
|
}
|
|
16243
|
-
|
|
16244
16360
|
/**
|
|
16245
16361
|
* Return all Access Grants that the current API token has access to.
|
|
16246
16362
|
*/
|
|
@@ -16949,10 +17065,22 @@ type CreateSsoConnectionForManagedAccountRequest = RequestBodyForPathAndMethod<`
|
|
|
16949
17065
|
* Response type for Configure SSO for managed account
|
|
16950
17066
|
*/
|
|
16951
17067
|
type CreateSsoConnectionForManagedAccountResponse = ResponseBodyForPathAndMethod<`/v2/managed_accounts/${NoSlashString}/sso_connection`, "POST">;
|
|
17068
|
+
/**
|
|
17069
|
+
* Response type for Delete SSO connection for managed account
|
|
17070
|
+
*/
|
|
17071
|
+
type DeleteSsoConnectionForManagedAccountResponse = ResponseBodyForPathAndMethod<`/v2/managed_accounts/${NoSlashString}/sso_connection`, "DELETE">;
|
|
16952
17072
|
/**
|
|
16953
17073
|
* Response type for Get authenticated user info
|
|
16954
17074
|
*/
|
|
16955
17075
|
type GetMeResponse = ResponseBodyForPathAndMethod<"/v2/me", "GET">;
|
|
17076
|
+
/**
|
|
17077
|
+
* Update the authenticated User.
|
|
17078
|
+
*/
|
|
17079
|
+
type UpdateMeRequest = RequestBodyForPathAndMethod<"/v2/me", "PUT">;
|
|
17080
|
+
/**
|
|
17081
|
+
* Response type for Update authenticated user
|
|
17082
|
+
*/
|
|
17083
|
+
type UpdateMeResponse = ResponseBodyForPathAndMethod<"/v2/me", "PUT">;
|
|
16956
17084
|
/**
|
|
16957
17085
|
* List CostProviders available to query in a given Workspace.
|
|
16958
17086
|
*/
|
|
@@ -17034,7 +17162,7 @@ type GetProductsResponse = ResponseBodyForPathAndMethod<"/v2/products", "GET">;
|
|
|
17034
17162
|
*/
|
|
17035
17163
|
type GetProductResponse = ResponseBodyForPathAndMethod<`/v2/products/${NoSlashString}`, "GET">;
|
|
17036
17164
|
/**
|
|
17037
|
-
* Return all Recommendations.
|
|
17165
|
+
* Return all Recommendations. Use the `type` query parameter with a fuzzy fragment to filter recommendation type case-insensitively (for example: aws, aws:ec2, aws:ec2:rightsizing).
|
|
17038
17166
|
*/
|
|
17039
17167
|
type GetRecommendationsRequest = RequestBodyForPathAndMethod<"/v2/recommendations", "GET">;
|
|
17040
17168
|
/**
|
|
@@ -17353,6 +17481,14 @@ type GetUsersResponse = ResponseBodyForPathAndMethod<"/v2/users", "GET">;
|
|
|
17353
17481
|
* Response type for Get user by token
|
|
17354
17482
|
*/
|
|
17355
17483
|
type GetUserResponse = ResponseBodyForPathAndMethod<`/v2/users/${NoSlashString}`, "GET">;
|
|
17484
|
+
/**
|
|
17485
|
+
* Update a specific User.
|
|
17486
|
+
*/
|
|
17487
|
+
type UpdateUserRequest = RequestBodyForPathAndMethod<`/v2/users/${NoSlashString}`, "PUT">;
|
|
17488
|
+
/**
|
|
17489
|
+
* Response type for Update a user
|
|
17490
|
+
*/
|
|
17491
|
+
type UpdateUserResponse = ResponseBodyForPathAndMethod<`/v2/users/${NoSlashString}`, "PUT">;
|
|
17356
17492
|
/**
|
|
17357
17493
|
* Response type for Get all virtual tag configs
|
|
17358
17494
|
*/
|
|
@@ -17435,6 +17571,7 @@ declare class APIV2Client<NeverThrow extends boolean = false> extends BaseClient
|
|
|
17435
17571
|
* @param baseUrl The base URL for the API. Defaults to "https://api.vantage.sh".
|
|
17436
17572
|
*/
|
|
17437
17573
|
constructor(bearerToken: string, neverThrow?: NeverThrow, baseUrl?: string);
|
|
17574
|
+
protected routeEdgecases: ReadonlyMap<string, string>;
|
|
17438
17575
|
private _accessGrants?;
|
|
17439
17576
|
private _anomalyAlerts?;
|
|
17440
17577
|
private _anomalyNotifications?;
|
|
@@ -17592,21 +17729,7 @@ declare class AccessGrantsApi<NeverThrow extends boolean> {
|
|
|
17592
17729
|
/**
|
|
17593
17730
|
* Delete an Access Grant.
|
|
17594
17731
|
*/
|
|
17595
|
-
delete(accessGrantToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
17596
|
-
token: string;
|
|
17597
|
-
resource_token: string;
|
|
17598
|
-
access: string;
|
|
17599
|
-
team_token: string | null;
|
|
17600
|
-
created_at: string;
|
|
17601
|
-
created_by: string | null;
|
|
17602
|
-
}, null] : {
|
|
17603
|
-
token: string;
|
|
17604
|
-
resource_token: string;
|
|
17605
|
-
access: string;
|
|
17606
|
-
team_token: string | null;
|
|
17607
|
-
created_at: string;
|
|
17608
|
-
created_by: string | null;
|
|
17609
|
-
}>;
|
|
17732
|
+
delete(accessGrantToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
17610
17733
|
}
|
|
17611
17734
|
declare class AnomalyAlertsApi<NeverThrow extends boolean> {
|
|
17612
17735
|
private client;
|
|
@@ -17766,23 +17889,7 @@ declare class AnomalyNotificationsApi<NeverThrow extends boolean> {
|
|
|
17766
17889
|
/**
|
|
17767
17890
|
* Delete an Anomaly Notification.
|
|
17768
17891
|
*/
|
|
17769
|
-
delete(anomalyNotificationToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
17770
|
-
token: string;
|
|
17771
|
-
cost_report_token: string;
|
|
17772
|
-
created_at: string;
|
|
17773
|
-
updated_at: string;
|
|
17774
|
-
threshold: number;
|
|
17775
|
-
user_tokens: string[];
|
|
17776
|
-
recipient_channels: string[];
|
|
17777
|
-
}, null] : {
|
|
17778
|
-
token: string;
|
|
17779
|
-
cost_report_token: string;
|
|
17780
|
-
created_at: string;
|
|
17781
|
-
updated_at: string;
|
|
17782
|
-
threshold: number;
|
|
17783
|
-
user_tokens: string[];
|
|
17784
|
-
recipient_channels: string[];
|
|
17785
|
-
}>;
|
|
17892
|
+
delete(anomalyNotificationToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
17786
17893
|
}
|
|
17787
17894
|
declare class AuditLogsApi<NeverThrow extends boolean> {
|
|
17788
17895
|
private client;
|
|
@@ -17916,27 +18023,7 @@ declare class BillingProfilesApi<NeverThrow extends boolean> {
|
|
|
17916
18023
|
/**
|
|
17917
18024
|
* Requires MSP invoicing to be enabled on the account.
|
|
17918
18025
|
*/
|
|
17919
|
-
delete(billingProfileToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
17920
|
-
token: string;
|
|
17921
|
-
nickname: string;
|
|
17922
|
-
created_at: string;
|
|
17923
|
-
updated_at: string;
|
|
17924
|
-
billing_information_attributes: components["schemas"]["BillingInformation"];
|
|
17925
|
-
business_information_attributes: components["schemas"]["BusinessInformation"];
|
|
17926
|
-
banking_information_attributes?: components["schemas"]["BankingInformation"];
|
|
17927
|
-
invoice_adjustment_attributes: components["schemas"]["InvoiceAdjustment"];
|
|
17928
|
-
managed_accounts_count: string;
|
|
17929
|
-
}, null] : {
|
|
17930
|
-
token: string;
|
|
17931
|
-
nickname: string;
|
|
17932
|
-
created_at: string;
|
|
17933
|
-
updated_at: string;
|
|
17934
|
-
billing_information_attributes: components["schemas"]["BillingInformation"];
|
|
17935
|
-
business_information_attributes: components["schemas"]["BusinessInformation"];
|
|
17936
|
-
banking_information_attributes?: components["schemas"]["BankingInformation"];
|
|
17937
|
-
invoice_adjustment_attributes: components["schemas"]["InvoiceAdjustment"];
|
|
17938
|
-
managed_accounts_count: string;
|
|
17939
|
-
}>;
|
|
18026
|
+
delete(billingProfileToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
17940
18027
|
}
|
|
17941
18028
|
declare class BillingRulesApi<NeverThrow extends boolean> {
|
|
17942
18029
|
private client;
|
|
@@ -18068,41 +18155,7 @@ declare class BillingRulesApi<NeverThrow extends boolean> {
|
|
|
18068
18155
|
/**
|
|
18069
18156
|
* Delete a BillingRule.
|
|
18070
18157
|
*/
|
|
18071
|
-
delete(billingRuleToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
18072
|
-
token: string;
|
|
18073
|
-
title: string;
|
|
18074
|
-
type: string;
|
|
18075
|
-
start_date?: string | null;
|
|
18076
|
-
end_date?: string | null;
|
|
18077
|
-
apply_to_all: boolean | null;
|
|
18078
|
-
created_by_token: string;
|
|
18079
|
-
created_at: string;
|
|
18080
|
-
service?: string | null;
|
|
18081
|
-
category?: string | null;
|
|
18082
|
-
percentage?: string | null;
|
|
18083
|
-
charge_type?: string | null;
|
|
18084
|
-
sub_category?: string | null;
|
|
18085
|
-
start_period?: string | null;
|
|
18086
|
-
amount?: string | null;
|
|
18087
|
-
sql_query?: string | null;
|
|
18088
|
-
}, null] : {
|
|
18089
|
-
token: string;
|
|
18090
|
-
title: string;
|
|
18091
|
-
type: string;
|
|
18092
|
-
start_date?: string | null;
|
|
18093
|
-
end_date?: string | null;
|
|
18094
|
-
apply_to_all: boolean | null;
|
|
18095
|
-
created_by_token: string;
|
|
18096
|
-
created_at: string;
|
|
18097
|
-
service?: string | null;
|
|
18098
|
-
category?: string | null;
|
|
18099
|
-
percentage?: string | null;
|
|
18100
|
-
charge_type?: string | null;
|
|
18101
|
-
sub_category?: string | null;
|
|
18102
|
-
start_period?: string | null;
|
|
18103
|
-
amount?: string | null;
|
|
18104
|
-
sql_query?: string | null;
|
|
18105
|
-
}>;
|
|
18158
|
+
delete(billingRuleToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
18106
18159
|
}
|
|
18107
18160
|
declare class BudgetAlertsApi<NeverThrow extends boolean> {
|
|
18108
18161
|
private client;
|
|
@@ -18124,7 +18177,7 @@ declare class BudgetAlertsApi<NeverThrow extends boolean> {
|
|
|
18124
18177
|
token: string;
|
|
18125
18178
|
budget_tokens: string[];
|
|
18126
18179
|
created_at: string;
|
|
18127
|
-
workspace_token: string;
|
|
18180
|
+
workspace_token: string | null;
|
|
18128
18181
|
user_token?: string | null;
|
|
18129
18182
|
user_tokens: string[];
|
|
18130
18183
|
duration_in_days: number | null;
|
|
@@ -18136,7 +18189,7 @@ declare class BudgetAlertsApi<NeverThrow extends boolean> {
|
|
|
18136
18189
|
token: string;
|
|
18137
18190
|
budget_tokens: string[];
|
|
18138
18191
|
created_at: string;
|
|
18139
|
-
workspace_token: string;
|
|
18192
|
+
workspace_token: string | null;
|
|
18140
18193
|
user_token?: string | null;
|
|
18141
18194
|
user_tokens: string[];
|
|
18142
18195
|
duration_in_days: number | null;
|
|
@@ -18152,7 +18205,7 @@ declare class BudgetAlertsApi<NeverThrow extends boolean> {
|
|
|
18152
18205
|
token: string;
|
|
18153
18206
|
budget_tokens: string[];
|
|
18154
18207
|
created_at: string;
|
|
18155
|
-
workspace_token: string;
|
|
18208
|
+
workspace_token: string | null;
|
|
18156
18209
|
user_token?: string | null;
|
|
18157
18210
|
user_tokens: string[];
|
|
18158
18211
|
duration_in_days: number | null;
|
|
@@ -18164,7 +18217,7 @@ declare class BudgetAlertsApi<NeverThrow extends boolean> {
|
|
|
18164
18217
|
token: string;
|
|
18165
18218
|
budget_tokens: string[];
|
|
18166
18219
|
created_at: string;
|
|
18167
|
-
workspace_token: string;
|
|
18220
|
+
workspace_token: string | null;
|
|
18168
18221
|
user_token?: string | null;
|
|
18169
18222
|
user_tokens: string[];
|
|
18170
18223
|
duration_in_days: number | null;
|
|
@@ -18180,7 +18233,7 @@ declare class BudgetAlertsApi<NeverThrow extends boolean> {
|
|
|
18180
18233
|
token: string;
|
|
18181
18234
|
budget_tokens: string[];
|
|
18182
18235
|
created_at: string;
|
|
18183
|
-
workspace_token: string;
|
|
18236
|
+
workspace_token: string | null;
|
|
18184
18237
|
user_token?: string | null;
|
|
18185
18238
|
user_tokens: string[];
|
|
18186
18239
|
duration_in_days: number | null;
|
|
@@ -18192,7 +18245,7 @@ declare class BudgetAlertsApi<NeverThrow extends boolean> {
|
|
|
18192
18245
|
token: string;
|
|
18193
18246
|
budget_tokens: string[];
|
|
18194
18247
|
created_at: string;
|
|
18195
|
-
workspace_token: string;
|
|
18248
|
+
workspace_token: string | null;
|
|
18196
18249
|
user_token?: string | null;
|
|
18197
18250
|
user_tokens: string[];
|
|
18198
18251
|
duration_in_days: number | null;
|
|
@@ -18204,31 +18257,7 @@ declare class BudgetAlertsApi<NeverThrow extends boolean> {
|
|
|
18204
18257
|
/**
|
|
18205
18258
|
* Delete a BudgetAlert.
|
|
18206
18259
|
*/
|
|
18207
|
-
delete(budgetAlertToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
18208
|
-
token: string;
|
|
18209
|
-
budget_tokens: string[];
|
|
18210
|
-
created_at: string;
|
|
18211
|
-
workspace_token: string;
|
|
18212
|
-
user_token?: string | null;
|
|
18213
|
-
user_tokens: string[];
|
|
18214
|
-
duration_in_days: number | null;
|
|
18215
|
-
threshold: number;
|
|
18216
|
-
period_to_track: string | null;
|
|
18217
|
-
integration_provider?: string | null;
|
|
18218
|
-
recipient_channels: string[] | null;
|
|
18219
|
-
}, null] : {
|
|
18220
|
-
token: string;
|
|
18221
|
-
budget_tokens: string[];
|
|
18222
|
-
created_at: string;
|
|
18223
|
-
workspace_token: string;
|
|
18224
|
-
user_token?: string | null;
|
|
18225
|
-
user_tokens: string[];
|
|
18226
|
-
duration_in_days: number | null;
|
|
18227
|
-
threshold: number;
|
|
18228
|
-
period_to_track: string | null;
|
|
18229
|
-
integration_provider?: string | null;
|
|
18230
|
-
recipient_channels: string[] | null;
|
|
18231
|
-
}>;
|
|
18260
|
+
delete(budgetAlertToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
18232
18261
|
}
|
|
18233
18262
|
declare class BudgetsApi<NeverThrow extends boolean> {
|
|
18234
18263
|
private client;
|
|
@@ -18302,31 +18331,7 @@ declare class BudgetsApi<NeverThrow extends boolean> {
|
|
|
18302
18331
|
/**
|
|
18303
18332
|
* Delete a Budget.
|
|
18304
18333
|
*/
|
|
18305
|
-
delete(budgetToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
18306
|
-
token: string;
|
|
18307
|
-
name: string | null;
|
|
18308
|
-
workspace_token: string;
|
|
18309
|
-
user_token?: string | null;
|
|
18310
|
-
created_by_token?: string | null;
|
|
18311
|
-
cost_report_token?: string | null;
|
|
18312
|
-
created_at: string;
|
|
18313
|
-
budget_alert_tokens: string[];
|
|
18314
|
-
child_budget_tokens: string[];
|
|
18315
|
-
periods: components["schemas"]["BudgetPeriod"][];
|
|
18316
|
-
performance?: components["schemas"]["BudgetPerformance"][];
|
|
18317
|
-
}, null] : {
|
|
18318
|
-
token: string;
|
|
18319
|
-
name: string | null;
|
|
18320
|
-
workspace_token: string;
|
|
18321
|
-
user_token?: string | null;
|
|
18322
|
-
created_by_token?: string | null;
|
|
18323
|
-
cost_report_token?: string | null;
|
|
18324
|
-
created_at: string;
|
|
18325
|
-
budget_alert_tokens: string[];
|
|
18326
|
-
child_budget_tokens: string[];
|
|
18327
|
-
periods: components["schemas"]["BudgetPeriod"][];
|
|
18328
|
-
performance?: components["schemas"]["BudgetPerformance"][];
|
|
18329
|
-
}>;
|
|
18334
|
+
delete(budgetToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
18330
18335
|
}
|
|
18331
18336
|
declare class BusinessMetricsApi<NeverThrow extends boolean> {
|
|
18332
18337
|
private client;
|
|
@@ -18408,25 +18413,7 @@ declare class BusinessMetricsApi<NeverThrow extends boolean> {
|
|
|
18408
18413
|
/**
|
|
18409
18414
|
* Deletes an existing BusinessMetric.
|
|
18410
18415
|
*/
|
|
18411
|
-
delete(businessMetricToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
18412
|
-
token: string;
|
|
18413
|
-
title: string;
|
|
18414
|
-
created_by_token?: string | null;
|
|
18415
|
-
cost_report_tokens_with_metadata: components["schemas"]["AttachedCostReportForBusinessMetric"][];
|
|
18416
|
-
import_type: "datadog_metrics" | "cloudwatch" | "csv" | null;
|
|
18417
|
-
integration_token: string | null;
|
|
18418
|
-
cloudwatch_fields?: components["schemas"]["CloudwatchFields"];
|
|
18419
|
-
datadog_metric_fields?: components["schemas"]["DatadogMetricFields"];
|
|
18420
|
-
}, null] : {
|
|
18421
|
-
token: string;
|
|
18422
|
-
title: string;
|
|
18423
|
-
created_by_token?: string | null;
|
|
18424
|
-
cost_report_tokens_with_metadata: components["schemas"]["AttachedCostReportForBusinessMetric"][];
|
|
18425
|
-
import_type: "datadog_metrics" | "cloudwatch" | "csv" | null;
|
|
18426
|
-
integration_token: string | null;
|
|
18427
|
-
cloudwatch_fields?: components["schemas"]["CloudwatchFields"];
|
|
18428
|
-
datadog_metric_fields?: components["schemas"]["DatadogMetricFields"];
|
|
18429
|
-
}>;
|
|
18416
|
+
delete(businessMetricToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
18430
18417
|
/**
|
|
18431
18418
|
* Return values of a BusinessMetric
|
|
18432
18419
|
*/
|
|
@@ -18558,35 +18545,7 @@ declare class CostAlertsApi<NeverThrow extends boolean> {
|
|
|
18558
18545
|
/**
|
|
18559
18546
|
* Delete a Cost Alert
|
|
18560
18547
|
*/
|
|
18561
|
-
delete(costAlertToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
18562
|
-
token: string;
|
|
18563
|
-
title: string;
|
|
18564
|
-
email_recipients: string[];
|
|
18565
|
-
slack_channels: string[];
|
|
18566
|
-
teams_channels: string[];
|
|
18567
|
-
created_at: string;
|
|
18568
|
-
updated_at: string;
|
|
18569
|
-
workspace_token: string;
|
|
18570
|
-
interval: string;
|
|
18571
|
-
threshold: number;
|
|
18572
|
-
unit_type: string;
|
|
18573
|
-
minimum_threshold: number | null;
|
|
18574
|
-
report_tokens: string[];
|
|
18575
|
-
}, null] : {
|
|
18576
|
-
token: string;
|
|
18577
|
-
title: string;
|
|
18578
|
-
email_recipients: string[];
|
|
18579
|
-
slack_channels: string[];
|
|
18580
|
-
teams_channels: string[];
|
|
18581
|
-
created_at: string;
|
|
18582
|
-
updated_at: string;
|
|
18583
|
-
workspace_token: string;
|
|
18584
|
-
interval: string;
|
|
18585
|
-
threshold: number;
|
|
18586
|
-
unit_type: string;
|
|
18587
|
-
minimum_threshold: number | null;
|
|
18588
|
-
report_tokens: string[];
|
|
18589
|
-
}>;
|
|
18548
|
+
delete(costAlertToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
18590
18549
|
/**
|
|
18591
18550
|
* Get all CostAlertEvents
|
|
18592
18551
|
*/
|
|
@@ -18830,63 +18789,7 @@ declare class CostReportsApi<NeverThrow extends boolean> {
|
|
|
18830
18789
|
/**
|
|
18831
18790
|
* Delete a CostReport.
|
|
18832
18791
|
*/
|
|
18833
|
-
delete(costReportToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
18834
|
-
token: string;
|
|
18835
|
-
title: string;
|
|
18836
|
-
folder_token?: string | null;
|
|
18837
|
-
saved_filter_tokens?: string[] | null;
|
|
18838
|
-
business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
|
|
18839
|
-
filter: string | null;
|
|
18840
|
-
groupings?: string | null;
|
|
18841
|
-
settings?: {
|
|
18842
|
-
include_credits?: boolean | null;
|
|
18843
|
-
include_refunds?: boolean | null;
|
|
18844
|
-
include_discounts?: boolean | null;
|
|
18845
|
-
include_tax?: boolean | null;
|
|
18846
|
-
amortize?: boolean | null;
|
|
18847
|
-
unallocated?: boolean | null;
|
|
18848
|
-
aggregate_by?: string | null;
|
|
18849
|
-
show_previous_period?: boolean | null;
|
|
18850
|
-
};
|
|
18851
|
-
created_at: string;
|
|
18852
|
-
workspace_token: string;
|
|
18853
|
-
previous_period_start_date?: string | null;
|
|
18854
|
-
previous_period_end_date?: string | null;
|
|
18855
|
-
start_date?: string | null;
|
|
18856
|
-
end_date?: string | null;
|
|
18857
|
-
date_interval: string;
|
|
18858
|
-
chart_type: string;
|
|
18859
|
-
date_bin: string;
|
|
18860
|
-
chart_settings: components["schemas"]["ChartSettings"];
|
|
18861
|
-
}, null] : {
|
|
18862
|
-
token: string;
|
|
18863
|
-
title: string;
|
|
18864
|
-
folder_token?: string | null;
|
|
18865
|
-
saved_filter_tokens?: string[] | null;
|
|
18866
|
-
business_metric_tokens_with_metadata: components["schemas"]["AttachedBusinessMetricForCostReport"][];
|
|
18867
|
-
filter: string | null;
|
|
18868
|
-
groupings?: string | null;
|
|
18869
|
-
settings?: {
|
|
18870
|
-
include_credits?: boolean | null;
|
|
18871
|
-
include_refunds?: boolean | null;
|
|
18872
|
-
include_discounts?: boolean | null;
|
|
18873
|
-
include_tax?: boolean | null;
|
|
18874
|
-
amortize?: boolean | null;
|
|
18875
|
-
unallocated?: boolean | null;
|
|
18876
|
-
aggregate_by?: string | null;
|
|
18877
|
-
show_previous_period?: boolean | null;
|
|
18878
|
-
};
|
|
18879
|
-
created_at: string;
|
|
18880
|
-
workspace_token: string;
|
|
18881
|
-
previous_period_start_date?: string | null;
|
|
18882
|
-
previous_period_end_date?: string | null;
|
|
18883
|
-
start_date?: string | null;
|
|
18884
|
-
end_date?: string | null;
|
|
18885
|
-
date_interval: string;
|
|
18886
|
-
chart_type: string;
|
|
18887
|
-
date_bin: string;
|
|
18888
|
-
chart_settings: components["schemas"]["ChartSettings"];
|
|
18889
|
-
}>;
|
|
18792
|
+
delete(costReportToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
18890
18793
|
/**
|
|
18891
18794
|
* Return all ForecastedCosts.
|
|
18892
18795
|
*/
|
|
@@ -18928,7 +18831,7 @@ declare class CostsApi<NeverThrow extends boolean> {
|
|
|
18928
18831
|
/**
|
|
18929
18832
|
* Generate a DataExport of costs.
|
|
18930
18833
|
*/
|
|
18931
|
-
createExport(body: CreateCostExportRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
18834
|
+
createExport(body: CreateCostExportRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [string, null] : string>;
|
|
18932
18835
|
}
|
|
18933
18836
|
declare class DashboardsApi<NeverThrow extends boolean> {
|
|
18934
18837
|
private client;
|
|
@@ -19030,31 +18933,7 @@ declare class DashboardsApi<NeverThrow extends boolean> {
|
|
|
19030
18933
|
/**
|
|
19031
18934
|
* Delete a Dashboard.
|
|
19032
18935
|
*/
|
|
19033
|
-
delete(dashboardToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
19034
|
-
token: string;
|
|
19035
|
-
title: string;
|
|
19036
|
-
widgets: components["schemas"]["DashboardWidget"][];
|
|
19037
|
-
saved_filter_tokens: string[];
|
|
19038
|
-
date_bin: "cumulative" | "day" | "week" | "month" | null;
|
|
19039
|
-
date_interval: "this_month" | "last_7_days" | "last_30_days" | "last_month" | "last_3_months" | "last_6_months" | "custom" | "last_12_months" | "last_24_months" | "last_36_months" | "next_month" | "next_3_months" | "next_6_months" | "next_12_months" | "year_to_date" | "last_3_days" | "last_14_days" | null;
|
|
19040
|
-
start_date?: string | null;
|
|
19041
|
-
end_date?: string | null;
|
|
19042
|
-
created_at: string;
|
|
19043
|
-
updated_at: string;
|
|
19044
|
-
workspace_token: string;
|
|
19045
|
-
}, null] : {
|
|
19046
|
-
token: string;
|
|
19047
|
-
title: string;
|
|
19048
|
-
widgets: components["schemas"]["DashboardWidget"][];
|
|
19049
|
-
saved_filter_tokens: string[];
|
|
19050
|
-
date_bin: "cumulative" | "day" | "week" | "month" | null;
|
|
19051
|
-
date_interval: "this_month" | "last_7_days" | "last_30_days" | "last_month" | "last_3_months" | "last_6_months" | "custom" | "last_12_months" | "last_24_months" | "last_36_months" | "next_month" | "next_3_months" | "next_6_months" | "next_12_months" | "year_to_date" | "last_3_days" | "last_14_days" | null;
|
|
19052
|
-
start_date?: string | null;
|
|
19053
|
-
end_date?: string | null;
|
|
19054
|
-
created_at: string;
|
|
19055
|
-
updated_at: string;
|
|
19056
|
-
workspace_token: string;
|
|
19057
|
-
}>;
|
|
18936
|
+
delete(dashboardToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
19058
18937
|
}
|
|
19059
18938
|
declare class DataExportsApi<NeverThrow extends boolean> {
|
|
19060
18939
|
private client;
|
|
@@ -19208,35 +19087,7 @@ declare class FinancialCommitmentReportsApi<NeverThrow extends boolean> {
|
|
|
19208
19087
|
/**
|
|
19209
19088
|
* Delete a FinancialCommitmentReport.
|
|
19210
19089
|
*/
|
|
19211
|
-
delete(financialCommitmentReportToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
19212
|
-
token: string;
|
|
19213
|
-
title: string;
|
|
19214
|
-
default: boolean;
|
|
19215
|
-
created_at: string;
|
|
19216
|
-
workspace_token: string;
|
|
19217
|
-
user_token?: string | null;
|
|
19218
|
-
start_date: string | null;
|
|
19219
|
-
end_date: string | null;
|
|
19220
|
-
date_interval: string | null;
|
|
19221
|
-
date_bucket: string;
|
|
19222
|
-
groupings: string | null;
|
|
19223
|
-
on_demand_costs_scope: string;
|
|
19224
|
-
filter: string | null;
|
|
19225
|
-
}, null] : {
|
|
19226
|
-
token: string;
|
|
19227
|
-
title: string;
|
|
19228
|
-
default: boolean;
|
|
19229
|
-
created_at: string;
|
|
19230
|
-
workspace_token: string;
|
|
19231
|
-
user_token?: string | null;
|
|
19232
|
-
start_date: string | null;
|
|
19233
|
-
end_date: string | null;
|
|
19234
|
-
date_interval: string | null;
|
|
19235
|
-
date_bucket: string;
|
|
19236
|
-
groupings: string | null;
|
|
19237
|
-
on_demand_costs_scope: string;
|
|
19238
|
-
filter: string | null;
|
|
19239
|
-
}>;
|
|
19090
|
+
delete(financialCommitmentReportToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
19240
19091
|
}
|
|
19241
19092
|
declare class FinancialCommitmentsApi<NeverThrow extends boolean> {
|
|
19242
19093
|
private client;
|
|
@@ -19328,23 +19179,7 @@ declare class FoldersApi<NeverThrow extends boolean> {
|
|
|
19328
19179
|
/**
|
|
19329
19180
|
* Delete a Folder for CostReports.
|
|
19330
19181
|
*/
|
|
19331
|
-
delete(folderToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
19332
|
-
token: string;
|
|
19333
|
-
title: string | null;
|
|
19334
|
-
parent_folder_token?: string | null;
|
|
19335
|
-
saved_filter_tokens: string[];
|
|
19336
|
-
created_at: string;
|
|
19337
|
-
updated_at: string;
|
|
19338
|
-
workspace_token: string;
|
|
19339
|
-
}, null] : {
|
|
19340
|
-
token: string;
|
|
19341
|
-
title: string | null;
|
|
19342
|
-
parent_folder_token?: string | null;
|
|
19343
|
-
saved_filter_tokens: string[];
|
|
19344
|
-
created_at: string;
|
|
19345
|
-
updated_at: string;
|
|
19346
|
-
workspace_token: string;
|
|
19347
|
-
}>;
|
|
19182
|
+
delete(folderToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
19348
19183
|
}
|
|
19349
19184
|
declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
19350
19185
|
private client;
|
|
@@ -19370,6 +19205,7 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19370
19205
|
last_updated?: string | null;
|
|
19371
19206
|
workspace_tokens: string[];
|
|
19372
19207
|
created_at: string;
|
|
19208
|
+
managed_account_tokens: string[];
|
|
19373
19209
|
}, null] : {
|
|
19374
19210
|
token: string;
|
|
19375
19211
|
provider: string;
|
|
@@ -19378,6 +19214,7 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19378
19214
|
last_updated?: string | null;
|
|
19379
19215
|
workspace_tokens: string[];
|
|
19380
19216
|
created_at: string;
|
|
19217
|
+
managed_account_tokens: string[];
|
|
19381
19218
|
}>;
|
|
19382
19219
|
/**
|
|
19383
19220
|
* Update an Integration.
|
|
@@ -19390,6 +19227,7 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19390
19227
|
last_updated?: string | null;
|
|
19391
19228
|
workspace_tokens: string[];
|
|
19392
19229
|
created_at: string;
|
|
19230
|
+
managed_account_tokens: string[];
|
|
19393
19231
|
}, null] : {
|
|
19394
19232
|
token: string;
|
|
19395
19233
|
provider: string;
|
|
@@ -19398,27 +19236,12 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19398
19236
|
last_updated?: string | null;
|
|
19399
19237
|
workspace_tokens: string[];
|
|
19400
19238
|
created_at: string;
|
|
19239
|
+
managed_account_tokens: string[];
|
|
19401
19240
|
}>;
|
|
19402
19241
|
/**
|
|
19403
19242
|
* Delete an Integration.
|
|
19404
19243
|
*/
|
|
19405
|
-
delete(integrationToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
19406
|
-
token: string;
|
|
19407
|
-
provider: string;
|
|
19408
|
-
account_identifier: string | null;
|
|
19409
|
-
status: "connected" | "error" | "pending" | "importing" | "imported" | "disconnected";
|
|
19410
|
-
last_updated?: string | null;
|
|
19411
|
-
workspace_tokens: string[];
|
|
19412
|
-
created_at: string;
|
|
19413
|
-
}, null] : {
|
|
19414
|
-
token: string;
|
|
19415
|
-
provider: string;
|
|
19416
|
-
account_identifier: string | null;
|
|
19417
|
-
status: "connected" | "error" | "pending" | "importing" | "imported" | "disconnected";
|
|
19418
|
-
last_updated?: string | null;
|
|
19419
|
-
workspace_tokens: string[];
|
|
19420
|
-
created_at: string;
|
|
19421
|
-
}>;
|
|
19244
|
+
delete(integrationToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
19422
19245
|
/**
|
|
19423
19246
|
* Create a Custom Provider Integration
|
|
19424
19247
|
*/
|
|
@@ -19430,6 +19253,7 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19430
19253
|
last_updated?: string | null;
|
|
19431
19254
|
workspace_tokens: string[];
|
|
19432
19255
|
created_at: string;
|
|
19256
|
+
managed_account_tokens: string[];
|
|
19433
19257
|
}, null] : {
|
|
19434
19258
|
token: string;
|
|
19435
19259
|
provider: string;
|
|
@@ -19438,6 +19262,7 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19438
19262
|
last_updated?: string | null;
|
|
19439
19263
|
workspace_tokens: string[];
|
|
19440
19264
|
created_at: string;
|
|
19265
|
+
managed_account_tokens: string[];
|
|
19441
19266
|
}>;
|
|
19442
19267
|
/**
|
|
19443
19268
|
* Create UserCostsUpload via CSV for a Custom Provider Integration.
|
|
@@ -19464,41 +19289,7 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19464
19289
|
/**
|
|
19465
19290
|
* Delete a UserCostsUpload.
|
|
19466
19291
|
*/
|
|
19467
|
-
deleteUserCostsUpload(integrationToken: string, userCostsUploadToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
19468
|
-
links?: components["schemas"]["Links"];
|
|
19469
|
-
accrued_at: string;
|
|
19470
|
-
amount: string;
|
|
19471
|
-
currency: string;
|
|
19472
|
-
usage?: Record<string, any> | null;
|
|
19473
|
-
provider?: "aws" | "azure" | "gcp" | "snowflake" | "databricks" | "mongo" | "datadog" | "fastly" | "new_relic" | "opencost" | "open_ai" | "oracle" | "confluent" | "planetscale" | "coralogix" | "kubernetes" | "custom_provider" | "github" | "linode" | "grafana" | "clickhouse" | "temporal" | "twilio" | "azure_csp" | "kubernetes_agent" | "anthropic" | "anyscale" | "cursor" | "elastic" | "vercel" | null;
|
|
19474
|
-
billing_account_id?: string | null;
|
|
19475
|
-
account_id?: string | null;
|
|
19476
|
-
service?: string | null;
|
|
19477
|
-
region?: string | null;
|
|
19478
|
-
resource_id?: string | null;
|
|
19479
|
-
tag?: string | null;
|
|
19480
|
-
tags?: string[] | null;
|
|
19481
|
-
cost_category?: string | null;
|
|
19482
|
-
cost_subcategory?: string | null;
|
|
19483
|
-
segment?: string | null;
|
|
19484
|
-
}, null] : {
|
|
19485
|
-
links?: components["schemas"]["Links"];
|
|
19486
|
-
accrued_at: string;
|
|
19487
|
-
amount: string;
|
|
19488
|
-
currency: string;
|
|
19489
|
-
usage?: Record<string, any> | null;
|
|
19490
|
-
provider?: "aws" | "azure" | "gcp" | "snowflake" | "databricks" | "mongo" | "datadog" | "fastly" | "new_relic" | "opencost" | "open_ai" | "oracle" | "confluent" | "planetscale" | "coralogix" | "kubernetes" | "custom_provider" | "github" | "linode" | "grafana" | "clickhouse" | "temporal" | "twilio" | "azure_csp" | "kubernetes_agent" | "anthropic" | "anyscale" | "cursor" | "elastic" | "vercel" | null;
|
|
19491
|
-
billing_account_id?: string | null;
|
|
19492
|
-
account_id?: string | null;
|
|
19493
|
-
service?: string | null;
|
|
19494
|
-
region?: string | null;
|
|
19495
|
-
resource_id?: string | null;
|
|
19496
|
-
tag?: string | null;
|
|
19497
|
-
tags?: string[] | null;
|
|
19498
|
-
cost_category?: string | null;
|
|
19499
|
-
cost_subcategory?: string | null;
|
|
19500
|
-
segment?: string | null;
|
|
19501
|
-
}>;
|
|
19292
|
+
deleteUserCostsUpload(integrationToken: string, userCostsUploadToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
19502
19293
|
/**
|
|
19503
19294
|
* List UserCostUploads.
|
|
19504
19295
|
*/
|
|
@@ -19520,6 +19311,7 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19520
19311
|
last_updated?: string | null;
|
|
19521
19312
|
workspace_tokens: string[];
|
|
19522
19313
|
created_at: string;
|
|
19314
|
+
managed_account_tokens: string[];
|
|
19523
19315
|
}, null] : {
|
|
19524
19316
|
token: string;
|
|
19525
19317
|
provider: string;
|
|
@@ -19528,6 +19320,7 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19528
19320
|
last_updated?: string | null;
|
|
19529
19321
|
workspace_tokens: string[];
|
|
19530
19322
|
created_at: string;
|
|
19323
|
+
managed_account_tokens: string[];
|
|
19531
19324
|
}>;
|
|
19532
19325
|
/**
|
|
19533
19326
|
* Create an Azure Integration
|
|
@@ -19540,6 +19333,7 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19540
19333
|
last_updated?: string | null;
|
|
19541
19334
|
workspace_tokens: string[];
|
|
19542
19335
|
created_at: string;
|
|
19336
|
+
managed_account_tokens: string[];
|
|
19543
19337
|
}, null] : {
|
|
19544
19338
|
token: string;
|
|
19545
19339
|
provider: string;
|
|
@@ -19548,6 +19342,7 @@ declare class IntegrationsApi<NeverThrow extends boolean> {
|
|
|
19548
19342
|
last_updated?: string | null;
|
|
19549
19343
|
workspace_tokens: string[];
|
|
19550
19344
|
created_at: string;
|
|
19345
|
+
managed_account_tokens: string[];
|
|
19551
19346
|
}>;
|
|
19552
19347
|
}
|
|
19553
19348
|
declare class InvoicesApi<NeverThrow extends boolean> {
|
|
@@ -19622,7 +19417,11 @@ declare class InvoicesApi<NeverThrow extends boolean> {
|
|
|
19622
19417
|
/**
|
|
19623
19418
|
* Download invoice file (PDF or CSV).
|
|
19624
19419
|
*/
|
|
19625
|
-
downloadInvoice(invoiceToken: string, body: DownloadInvoiceRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
19420
|
+
downloadInvoice(invoiceToken: string, body: DownloadInvoiceRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [{
|
|
19421
|
+
download_url: string;
|
|
19422
|
+
}, null] : {
|
|
19423
|
+
download_url: string;
|
|
19424
|
+
}>;
|
|
19626
19425
|
/**
|
|
19627
19426
|
* Send invoice via email.
|
|
19628
19427
|
*/
|
|
@@ -19788,53 +19587,11 @@ declare class KubernetesEfficiencyReportsApi<NeverThrow extends boolean> {
|
|
|
19788
19587
|
/**
|
|
19789
19588
|
* Delete a KubernetesEfficiencyReport.
|
|
19790
19589
|
*/
|
|
19791
|
-
delete(kubernetesEfficiencyReportToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
19792
|
-
token: string;
|
|
19793
|
-
title: string;
|
|
19794
|
-
default: boolean;
|
|
19795
|
-
created_at: string;
|
|
19796
|
-
workspace_token: string;
|
|
19797
|
-
user_token?: string | null;
|
|
19798
|
-
start_date: string | null;
|
|
19799
|
-
end_date: string | null;
|
|
19800
|
-
date_interval: string | null;
|
|
19801
|
-
date_bucket: string;
|
|
19802
|
-
aggregated_by: string;
|
|
19803
|
-
groupings: string | null;
|
|
19804
|
-
filter: string | null;
|
|
19805
|
-
}, null] : {
|
|
19806
|
-
token: string;
|
|
19807
|
-
title: string;
|
|
19808
|
-
default: boolean;
|
|
19809
|
-
created_at: string;
|
|
19810
|
-
workspace_token: string;
|
|
19811
|
-
user_token?: string | null;
|
|
19812
|
-
start_date: string | null;
|
|
19813
|
-
end_date: string | null;
|
|
19814
|
-
date_interval: string | null;
|
|
19815
|
-
date_bucket: string;
|
|
19816
|
-
aggregated_by: string;
|
|
19817
|
-
groupings: string | null;
|
|
19818
|
-
filter: string | null;
|
|
19819
|
-
}>;
|
|
19590
|
+
delete(kubernetesEfficiencyReportToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
19820
19591
|
/**
|
|
19821
19592
|
* Generate a DataExport of Kubernetes efficiency data.
|
|
19822
19593
|
*/
|
|
19823
|
-
createExport(body: CreateKubernetesEfficiencyReportExportRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
19824
|
-
token: string;
|
|
19825
|
-
status: string;
|
|
19826
|
-
created_at: string;
|
|
19827
|
-
export_type: string;
|
|
19828
|
-
manifest: components["schemas"]["DataExportManifest"];
|
|
19829
|
-
attributes: Record<string, any>;
|
|
19830
|
-
}, null] : {
|
|
19831
|
-
token: string;
|
|
19832
|
-
status: string;
|
|
19833
|
-
created_at: string;
|
|
19834
|
-
export_type: string;
|
|
19835
|
-
manifest: components["schemas"]["DataExportManifest"];
|
|
19836
|
-
attributes: Record<string, any>;
|
|
19837
|
-
}>;
|
|
19594
|
+
createExport(body: CreateKubernetesEfficiencyReportExportRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [string, null] : string>;
|
|
19838
19595
|
}
|
|
19839
19596
|
declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
19840
19597
|
private client;
|
|
@@ -19861,6 +19618,8 @@ declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
|
19861
19618
|
billing_rule_tokens: string[];
|
|
19862
19619
|
email_domain?: string | null;
|
|
19863
19620
|
msp_billing_profile_token?: string | null;
|
|
19621
|
+
payment_terms_days?: number | null;
|
|
19622
|
+
include_managed_account_integrations?: boolean | null;
|
|
19864
19623
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19865
19624
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19866
19625
|
}, null] : {
|
|
@@ -19872,6 +19631,8 @@ declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
|
19872
19631
|
billing_rule_tokens: string[];
|
|
19873
19632
|
email_domain?: string | null;
|
|
19874
19633
|
msp_billing_profile_token?: string | null;
|
|
19634
|
+
payment_terms_days?: number | null;
|
|
19635
|
+
include_managed_account_integrations?: boolean | null;
|
|
19875
19636
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19876
19637
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19877
19638
|
}>;
|
|
@@ -19887,6 +19648,8 @@ declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
|
19887
19648
|
billing_rule_tokens: string[];
|
|
19888
19649
|
email_domain?: string | null;
|
|
19889
19650
|
msp_billing_profile_token?: string | null;
|
|
19651
|
+
payment_terms_days?: number | null;
|
|
19652
|
+
include_managed_account_integrations?: boolean | null;
|
|
19890
19653
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19891
19654
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19892
19655
|
}, null] : {
|
|
@@ -19898,6 +19661,8 @@ declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
|
19898
19661
|
billing_rule_tokens: string[];
|
|
19899
19662
|
email_domain?: string | null;
|
|
19900
19663
|
msp_billing_profile_token?: string | null;
|
|
19664
|
+
payment_terms_days?: number | null;
|
|
19665
|
+
include_managed_account_integrations?: boolean | null;
|
|
19901
19666
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19902
19667
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19903
19668
|
}>;
|
|
@@ -19913,6 +19678,8 @@ declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
|
19913
19678
|
billing_rule_tokens: string[];
|
|
19914
19679
|
email_domain?: string | null;
|
|
19915
19680
|
msp_billing_profile_token?: string | null;
|
|
19681
|
+
payment_terms_days?: number | null;
|
|
19682
|
+
include_managed_account_integrations?: boolean | null;
|
|
19916
19683
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19917
19684
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19918
19685
|
}, null] : {
|
|
@@ -19924,35 +19691,15 @@ declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
|
19924
19691
|
billing_rule_tokens: string[];
|
|
19925
19692
|
email_domain?: string | null;
|
|
19926
19693
|
msp_billing_profile_token?: string | null;
|
|
19694
|
+
payment_terms_days?: number | null;
|
|
19695
|
+
include_managed_account_integrations?: boolean | null;
|
|
19927
19696
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19928
19697
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19929
19698
|
}>;
|
|
19930
19699
|
/**
|
|
19931
19700
|
* Delete a Managed Account.
|
|
19932
19701
|
*/
|
|
19933
|
-
delete(managedAccountToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
19934
|
-
token: string;
|
|
19935
|
-
name: string;
|
|
19936
|
-
contact_email: string;
|
|
19937
|
-
parent_account_token: string;
|
|
19938
|
-
access_credential_tokens: string[];
|
|
19939
|
-
billing_rule_tokens: string[];
|
|
19940
|
-
email_domain?: string | null;
|
|
19941
|
-
msp_billing_profile_token?: string | null;
|
|
19942
|
-
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19943
|
-
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19944
|
-
}, null] : {
|
|
19945
|
-
token: string;
|
|
19946
|
-
name: string;
|
|
19947
|
-
contact_email: string;
|
|
19948
|
-
parent_account_token: string;
|
|
19949
|
-
access_credential_tokens: string[];
|
|
19950
|
-
billing_rule_tokens: string[];
|
|
19951
|
-
email_domain?: string | null;
|
|
19952
|
-
msp_billing_profile_token?: string | null;
|
|
19953
|
-
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19954
|
-
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19955
|
-
}>;
|
|
19702
|
+
delete(managedAccountToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
19956
19703
|
/**
|
|
19957
19704
|
* Update SSO configuration for a Managed Account.
|
|
19958
19705
|
*/
|
|
@@ -19965,6 +19712,8 @@ declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
|
19965
19712
|
billing_rule_tokens: string[];
|
|
19966
19713
|
email_domain?: string | null;
|
|
19967
19714
|
msp_billing_profile_token?: string | null;
|
|
19715
|
+
payment_terms_days?: number | null;
|
|
19716
|
+
include_managed_account_integrations?: boolean | null;
|
|
19968
19717
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19969
19718
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19970
19719
|
}, null] : {
|
|
@@ -19976,6 +19725,8 @@ declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
|
19976
19725
|
billing_rule_tokens: string[];
|
|
19977
19726
|
email_domain?: string | null;
|
|
19978
19727
|
msp_billing_profile_token?: string | null;
|
|
19728
|
+
payment_terms_days?: number | null;
|
|
19729
|
+
include_managed_account_integrations?: boolean | null;
|
|
19979
19730
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19980
19731
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19981
19732
|
}>;
|
|
@@ -19991,6 +19742,8 @@ declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
|
19991
19742
|
billing_rule_tokens: string[];
|
|
19992
19743
|
email_domain?: string | null;
|
|
19993
19744
|
msp_billing_profile_token?: string | null;
|
|
19745
|
+
payment_terms_days?: number | null;
|
|
19746
|
+
include_managed_account_integrations?: boolean | null;
|
|
19994
19747
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
19995
19748
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
19996
19749
|
}, null] : {
|
|
@@ -20002,9 +19755,15 @@ declare class ManagedAccountsApi<NeverThrow extends boolean> {
|
|
|
20002
19755
|
billing_rule_tokens: string[];
|
|
20003
19756
|
email_domain?: string | null;
|
|
20004
19757
|
msp_billing_profile_token?: string | null;
|
|
19758
|
+
payment_terms_days?: number | null;
|
|
19759
|
+
include_managed_account_integrations?: boolean | null;
|
|
20005
19760
|
billing_information_attributes?: components["schemas"]["BillingInformation"];
|
|
20006
19761
|
business_information_attributes?: components["schemas"]["BusinessInformation"];
|
|
20007
19762
|
}>;
|
|
19763
|
+
/**
|
|
19764
|
+
* Delete SSO connection for a Managed Account.
|
|
19765
|
+
*/
|
|
19766
|
+
deleteSsoConnectionForManagedAccount(managedAccountToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
20008
19767
|
}
|
|
20009
19768
|
declare class MeApi<NeverThrow extends boolean> {
|
|
20010
19769
|
private client;
|
|
@@ -20014,10 +19773,12 @@ declare class MeApi<NeverThrow extends boolean> {
|
|
|
20014
19773
|
*/
|
|
20015
19774
|
get(): Promise<NeverThrow extends true ? [null, VantageAPIError] | [{
|
|
20016
19775
|
default_workspace_token: string | null;
|
|
19776
|
+
default_dashboard_token?: string | null;
|
|
20017
19777
|
workspaces: components["schemas"]["Workspace"][];
|
|
20018
19778
|
bearer_token: components["schemas"]["BearerToken"];
|
|
20019
19779
|
}, null] : {
|
|
20020
19780
|
default_workspace_token: string | null;
|
|
19781
|
+
default_dashboard_token?: string | null;
|
|
20021
19782
|
workspaces: components["schemas"]["Workspace"][];
|
|
20022
19783
|
bearer_token: components["schemas"]["BearerToken"];
|
|
20023
19784
|
}>;
|
|
@@ -20180,35 +19941,7 @@ declare class NetworkFlowReportsApi<NeverThrow extends boolean> {
|
|
|
20180
19941
|
/**
|
|
20181
19942
|
* Delete a NetworkFlowReport.
|
|
20182
19943
|
*/
|
|
20183
|
-
delete(networkFlowReportToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
20184
|
-
token: string;
|
|
20185
|
-
title: string;
|
|
20186
|
-
default: boolean;
|
|
20187
|
-
created_at: string;
|
|
20188
|
-
workspace_token: string;
|
|
20189
|
-
created_by_token?: string | null;
|
|
20190
|
-
start_date: string | null;
|
|
20191
|
-
end_date: string | null;
|
|
20192
|
-
date_interval: string | null;
|
|
20193
|
-
groupings: string | null;
|
|
20194
|
-
flow_direction: string | null;
|
|
20195
|
-
flow_weight: string;
|
|
20196
|
-
filter: string | null;
|
|
20197
|
-
}, null] : {
|
|
20198
|
-
token: string;
|
|
20199
|
-
title: string;
|
|
20200
|
-
default: boolean;
|
|
20201
|
-
created_at: string;
|
|
20202
|
-
workspace_token: string;
|
|
20203
|
-
created_by_token?: string | null;
|
|
20204
|
-
start_date: string | null;
|
|
20205
|
-
end_date: string | null;
|
|
20206
|
-
date_interval: string | null;
|
|
20207
|
-
groupings: string | null;
|
|
20208
|
-
flow_direction: string | null;
|
|
20209
|
-
flow_weight: string;
|
|
20210
|
-
filter: string | null;
|
|
20211
|
-
}>;
|
|
19944
|
+
delete(networkFlowReportToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
20212
19945
|
}
|
|
20213
19946
|
declare class ProductsApi<NeverThrow extends boolean> {
|
|
20214
19947
|
private client;
|
|
@@ -20278,7 +20011,7 @@ declare class RecommendationsApi<NeverThrow extends boolean> {
|
|
|
20278
20011
|
private client;
|
|
20279
20012
|
constructor(client: BaseClient<NeverThrow>);
|
|
20280
20013
|
/**
|
|
20281
|
-
* Return all Recommendations.
|
|
20014
|
+
* Return all Recommendations. Use the `type` query parameter with a fuzzy fragment to filter recommendation type case-insensitively (for example: aws, aws:ec2, aws:ec2:rightsizing).
|
|
20282
20015
|
*/
|
|
20283
20016
|
list(body?: GetRecommendationsRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [{
|
|
20284
20017
|
links?: components["schemas"]["Links"];
|
|
@@ -20464,35 +20197,7 @@ declare class RecommendationViewsApi<NeverThrow extends boolean> {
|
|
|
20464
20197
|
/**
|
|
20465
20198
|
* Delete a RecommendationView.
|
|
20466
20199
|
*/
|
|
20467
|
-
delete(recommendationViewToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
20468
|
-
token?: string | null;
|
|
20469
|
-
title?: string | null;
|
|
20470
|
-
workspace_token?: string | null;
|
|
20471
|
-
start_date?: string | null;
|
|
20472
|
-
end_date?: string | null;
|
|
20473
|
-
provider_ids?: string[] | null;
|
|
20474
|
-
billing_account_ids?: string[] | null;
|
|
20475
|
-
account_ids?: string[] | null;
|
|
20476
|
-
regions?: string[] | null;
|
|
20477
|
-
tag_key?: string | null;
|
|
20478
|
-
tag_value?: string | null;
|
|
20479
|
-
created_at?: string | null;
|
|
20480
|
-
created_by?: string | null;
|
|
20481
|
-
}, null] : {
|
|
20482
|
-
token?: string | null;
|
|
20483
|
-
title?: string | null;
|
|
20484
|
-
workspace_token?: string | null;
|
|
20485
|
-
start_date?: string | null;
|
|
20486
|
-
end_date?: string | null;
|
|
20487
|
-
provider_ids?: string[] | null;
|
|
20488
|
-
billing_account_ids?: string[] | null;
|
|
20489
|
-
account_ids?: string[] | null;
|
|
20490
|
-
regions?: string[] | null;
|
|
20491
|
-
tag_key?: string | null;
|
|
20492
|
-
tag_value?: string | null;
|
|
20493
|
-
created_at?: string | null;
|
|
20494
|
-
created_by?: string | null;
|
|
20495
|
-
}>;
|
|
20200
|
+
delete(recommendationViewToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
20496
20201
|
}
|
|
20497
20202
|
declare class ReportNotificationsApi<NeverThrow extends boolean> {
|
|
20498
20203
|
private client;
|
|
@@ -20570,23 +20275,7 @@ declare class ReportNotificationsApi<NeverThrow extends boolean> {
|
|
|
20570
20275
|
/**
|
|
20571
20276
|
* Delete a ReportNotification.
|
|
20572
20277
|
*/
|
|
20573
|
-
delete(reportNotificationToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
20574
|
-
token: string;
|
|
20575
|
-
title: string;
|
|
20576
|
-
cost_report_token: string;
|
|
20577
|
-
user_tokens: string[];
|
|
20578
|
-
recipient_channels: string[];
|
|
20579
|
-
frequency: "daily" | "weekly" | "monthly";
|
|
20580
|
-
change: "percentage" | "dollars";
|
|
20581
|
-
}, null] : {
|
|
20582
|
-
token: string;
|
|
20583
|
-
title: string;
|
|
20584
|
-
cost_report_token: string;
|
|
20585
|
-
user_tokens: string[];
|
|
20586
|
-
recipient_channels: string[];
|
|
20587
|
-
frequency: "daily" | "weekly" | "monthly";
|
|
20588
|
-
change: "percentage" | "dollars";
|
|
20589
|
-
}>;
|
|
20278
|
+
delete(reportNotificationToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
20590
20279
|
}
|
|
20591
20280
|
declare class ResourceReportsApi<NeverThrow extends boolean> {
|
|
20592
20281
|
private client;
|
|
@@ -20670,25 +20359,7 @@ declare class ResourceReportsApi<NeverThrow extends boolean> {
|
|
|
20670
20359
|
/**
|
|
20671
20360
|
* Delete a ResourceReport.
|
|
20672
20361
|
*/
|
|
20673
|
-
delete(resourceReportToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
20674
|
-
token: string;
|
|
20675
|
-
title: string;
|
|
20676
|
-
filter: string | null;
|
|
20677
|
-
created_at: string;
|
|
20678
|
-
workspace_token: string;
|
|
20679
|
-
user_token: string | null;
|
|
20680
|
-
created_by_token: string | null;
|
|
20681
|
-
columns: string[];
|
|
20682
|
-
}, null] : {
|
|
20683
|
-
token: string;
|
|
20684
|
-
title: string;
|
|
20685
|
-
filter: string | null;
|
|
20686
|
-
created_at: string;
|
|
20687
|
-
workspace_token: string;
|
|
20688
|
-
user_token: string | null;
|
|
20689
|
-
created_by_token: string | null;
|
|
20690
|
-
columns: string[];
|
|
20691
|
-
}>;
|
|
20362
|
+
delete(resourceReportToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
20692
20363
|
/**
|
|
20693
20364
|
* List available columns for a resource type.
|
|
20694
20365
|
*/
|
|
@@ -20788,23 +20459,7 @@ declare class SavedFiltersApi<NeverThrow extends boolean> {
|
|
|
20788
20459
|
/**
|
|
20789
20460
|
* Delete a SavedFilter for CostReports.
|
|
20790
20461
|
*/
|
|
20791
|
-
delete(savedFilterToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
20792
|
-
token: string;
|
|
20793
|
-
title: string;
|
|
20794
|
-
cost_report_tokens: string[];
|
|
20795
|
-
filter: string | null;
|
|
20796
|
-
created_at: string;
|
|
20797
|
-
created_by: string | null;
|
|
20798
|
-
workspace_token: string;
|
|
20799
|
-
}, null] : {
|
|
20800
|
-
token: string;
|
|
20801
|
-
title: string;
|
|
20802
|
-
cost_report_tokens: string[];
|
|
20803
|
-
filter: string | null;
|
|
20804
|
-
created_at: string;
|
|
20805
|
-
created_by: string | null;
|
|
20806
|
-
workspace_token: string;
|
|
20807
|
-
}>;
|
|
20462
|
+
delete(savedFilterToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
20808
20463
|
}
|
|
20809
20464
|
declare class SegmentsApi<NeverThrow extends boolean> {
|
|
20810
20465
|
private client;
|
|
@@ -20942,43 +20597,7 @@ declare class SegmentsApi<NeverThrow extends boolean> {
|
|
|
20942
20597
|
/**
|
|
20943
20598
|
* Delete a Segment.
|
|
20944
20599
|
*/
|
|
20945
|
-
delete(segmentToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
20946
|
-
token: string;
|
|
20947
|
-
title: string;
|
|
20948
|
-
parent_segment_token: string | null;
|
|
20949
|
-
description: string;
|
|
20950
|
-
track_unallocated: boolean;
|
|
20951
|
-
report_settings?: {
|
|
20952
|
-
include_credits?: boolean | null;
|
|
20953
|
-
include_refunds?: boolean | null;
|
|
20954
|
-
include_discounts?: boolean | null;
|
|
20955
|
-
include_tax?: boolean | null;
|
|
20956
|
-
amortize?: boolean | null;
|
|
20957
|
-
};
|
|
20958
|
-
priority: number;
|
|
20959
|
-
filter: string | null;
|
|
20960
|
-
created_at: string;
|
|
20961
|
-
workspace_token: string;
|
|
20962
|
-
report_token: string | null;
|
|
20963
|
-
}, null] : {
|
|
20964
|
-
token: string;
|
|
20965
|
-
title: string;
|
|
20966
|
-
parent_segment_token: string | null;
|
|
20967
|
-
description: string;
|
|
20968
|
-
track_unallocated: boolean;
|
|
20969
|
-
report_settings?: {
|
|
20970
|
-
include_credits?: boolean | null;
|
|
20971
|
-
include_refunds?: boolean | null;
|
|
20972
|
-
include_discounts?: boolean | null;
|
|
20973
|
-
include_tax?: boolean | null;
|
|
20974
|
-
amortize?: boolean | null;
|
|
20975
|
-
};
|
|
20976
|
-
priority: number;
|
|
20977
|
-
filter: string | null;
|
|
20978
|
-
created_at: string;
|
|
20979
|
-
workspace_token: string;
|
|
20980
|
-
report_token: string | null;
|
|
20981
|
-
}>;
|
|
20600
|
+
delete(segmentToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
20982
20601
|
}
|
|
20983
20602
|
declare class TagsApi<NeverThrow extends boolean> {
|
|
20984
20603
|
private client;
|
|
@@ -21027,6 +20646,7 @@ declare class TeamsApi<NeverThrow extends boolean> {
|
|
|
21027
20646
|
workspace_tokens: string[];
|
|
21028
20647
|
user_emails: string[];
|
|
21029
20648
|
user_tokens: string[];
|
|
20649
|
+
default_dashboard_token: string | null;
|
|
21030
20650
|
}, null] : {
|
|
21031
20651
|
token: string;
|
|
21032
20652
|
name: string;
|
|
@@ -21034,6 +20654,7 @@ declare class TeamsApi<NeverThrow extends boolean> {
|
|
|
21034
20654
|
workspace_tokens: string[];
|
|
21035
20655
|
user_emails: string[];
|
|
21036
20656
|
user_tokens: string[];
|
|
20657
|
+
default_dashboard_token: string | null;
|
|
21037
20658
|
}>;
|
|
21038
20659
|
/**
|
|
21039
20660
|
* Return a specific Team.
|
|
@@ -21045,6 +20666,7 @@ declare class TeamsApi<NeverThrow extends boolean> {
|
|
|
21045
20666
|
workspace_tokens: string[];
|
|
21046
20667
|
user_emails: string[];
|
|
21047
20668
|
user_tokens: string[];
|
|
20669
|
+
default_dashboard_token: string | null;
|
|
21048
20670
|
}, null] : {
|
|
21049
20671
|
token: string;
|
|
21050
20672
|
name: string;
|
|
@@ -21052,6 +20674,7 @@ declare class TeamsApi<NeverThrow extends boolean> {
|
|
|
21052
20674
|
workspace_tokens: string[];
|
|
21053
20675
|
user_emails: string[];
|
|
21054
20676
|
user_tokens: string[];
|
|
20677
|
+
default_dashboard_token: string | null;
|
|
21055
20678
|
}>;
|
|
21056
20679
|
/**
|
|
21057
20680
|
* Update a Team.
|
|
@@ -21063,6 +20686,7 @@ declare class TeamsApi<NeverThrow extends boolean> {
|
|
|
21063
20686
|
workspace_tokens: string[];
|
|
21064
20687
|
user_emails: string[];
|
|
21065
20688
|
user_tokens: string[];
|
|
20689
|
+
default_dashboard_token: string | null;
|
|
21066
20690
|
}, null] : {
|
|
21067
20691
|
token: string;
|
|
21068
20692
|
name: string;
|
|
@@ -21070,25 +20694,12 @@ declare class TeamsApi<NeverThrow extends boolean> {
|
|
|
21070
20694
|
workspace_tokens: string[];
|
|
21071
20695
|
user_emails: string[];
|
|
21072
20696
|
user_tokens: string[];
|
|
20697
|
+
default_dashboard_token: string | null;
|
|
21073
20698
|
}>;
|
|
21074
20699
|
/**
|
|
21075
20700
|
* Delete a Team.
|
|
21076
20701
|
*/
|
|
21077
|
-
delete(teamToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
21078
|
-
token: string;
|
|
21079
|
-
name: string;
|
|
21080
|
-
description: string | null;
|
|
21081
|
-
workspace_tokens: string[];
|
|
21082
|
-
user_emails: string[];
|
|
21083
|
-
user_tokens: string[];
|
|
21084
|
-
}, null] : {
|
|
21085
|
-
token: string;
|
|
21086
|
-
name: string;
|
|
21087
|
-
description: string | null;
|
|
21088
|
-
workspace_tokens: string[];
|
|
21089
|
-
user_emails: string[];
|
|
21090
|
-
user_tokens: string[];
|
|
21091
|
-
}>;
|
|
20702
|
+
delete(teamToken: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
21092
20703
|
/**
|
|
21093
20704
|
* Return all members of a Team.
|
|
21094
20705
|
*/
|
|
@@ -21134,21 +20745,7 @@ declare class UnitCostsApi<NeverThrow extends boolean> {
|
|
|
21134
20745
|
/**
|
|
21135
20746
|
* Generate a DataExport of unit costs.
|
|
21136
20747
|
*/
|
|
21137
|
-
createExport(body: CreateUnitCostsExportRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
21138
|
-
token: string;
|
|
21139
|
-
status: string;
|
|
21140
|
-
created_at: string;
|
|
21141
|
-
export_type: string;
|
|
21142
|
-
manifest: components["schemas"]["DataExportManifest"];
|
|
21143
|
-
attributes: Record<string, any>;
|
|
21144
|
-
}, null] : {
|
|
21145
|
-
token: string;
|
|
21146
|
-
status: string;
|
|
21147
|
-
created_at: string;
|
|
21148
|
-
export_type: string;
|
|
21149
|
-
manifest: components["schemas"]["DataExportManifest"];
|
|
21150
|
-
attributes: Record<string, any>;
|
|
21151
|
-
}>;
|
|
20748
|
+
createExport(body: CreateUnitCostsExportRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [string, null] : string>;
|
|
21152
20749
|
}
|
|
21153
20750
|
declare class UsersApi<NeverThrow extends boolean> {
|
|
21154
20751
|
private client;
|
|
@@ -21171,12 +20768,32 @@ declare class UsersApi<NeverThrow extends boolean> {
|
|
|
21171
20768
|
name: string | null;
|
|
21172
20769
|
email: string;
|
|
21173
20770
|
role: string;
|
|
20771
|
+
default_dashboard_token?: string | null;
|
|
20772
|
+
last_seen_at?: string | null;
|
|
20773
|
+
}, null] : {
|
|
20774
|
+
token: string;
|
|
20775
|
+
name: string | null;
|
|
20776
|
+
email: string;
|
|
20777
|
+
role: string;
|
|
20778
|
+
default_dashboard_token?: string | null;
|
|
20779
|
+
last_seen_at?: string | null;
|
|
20780
|
+
}>;
|
|
20781
|
+
/**
|
|
20782
|
+
* Update a specific User.
|
|
20783
|
+
*/
|
|
20784
|
+
update(userToken: string, body: UpdateUserRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [{
|
|
20785
|
+
token: string;
|
|
20786
|
+
name: string | null;
|
|
20787
|
+
email: string;
|
|
20788
|
+
role: string;
|
|
20789
|
+
default_dashboard_token?: string | null;
|
|
21174
20790
|
last_seen_at?: string | null;
|
|
21175
20791
|
}, null] : {
|
|
21176
20792
|
token: string;
|
|
21177
20793
|
name: string | null;
|
|
21178
20794
|
email: string;
|
|
21179
20795
|
role: string;
|
|
20796
|
+
default_dashboard_token?: string | null;
|
|
21180
20797
|
last_seen_at?: string | null;
|
|
21181
20798
|
}>;
|
|
21182
20799
|
}
|
|
@@ -21222,6 +20839,9 @@ declare class VirtualTagConfigsApi<NeverThrow extends boolean> {
|
|
|
21222
20839
|
backfill_until: string;
|
|
21223
20840
|
collapsed_tag_keys?: components["schemas"]["VirtualTagConfigCollapsedTagKey"][];
|
|
21224
20841
|
values: components["schemas"]["VirtualTagConfigValue"][];
|
|
20842
|
+
} | {
|
|
20843
|
+
request_id: string;
|
|
20844
|
+
status_url: string;
|
|
21225
20845
|
}, null] : {
|
|
21226
20846
|
token: string;
|
|
21227
20847
|
created_by_token: string | null;
|
|
@@ -21230,27 +20850,14 @@ declare class VirtualTagConfigsApi<NeverThrow extends boolean> {
|
|
|
21230
20850
|
backfill_until: string;
|
|
21231
20851
|
collapsed_tag_keys?: components["schemas"]["VirtualTagConfigCollapsedTagKey"][];
|
|
21232
20852
|
values: components["schemas"]["VirtualTagConfigValue"][];
|
|
20853
|
+
} | {
|
|
20854
|
+
request_id: string;
|
|
20855
|
+
status_url: string;
|
|
21233
20856
|
}>;
|
|
21234
20857
|
/**
|
|
21235
20858
|
* Deletes an existing VirtualTagConfig.
|
|
21236
20859
|
*/
|
|
21237
|
-
delete(token: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
21238
|
-
token: string;
|
|
21239
|
-
created_by_token: string | null;
|
|
21240
|
-
key: string;
|
|
21241
|
-
overridable: boolean;
|
|
21242
|
-
backfill_until: string;
|
|
21243
|
-
collapsed_tag_keys?: components["schemas"]["VirtualTagConfigCollapsedTagKey"][];
|
|
21244
|
-
values: components["schemas"]["VirtualTagConfigValue"][];
|
|
21245
|
-
}, null] : {
|
|
21246
|
-
token: string;
|
|
21247
|
-
created_by_token: string | null;
|
|
21248
|
-
key: string;
|
|
21249
|
-
overridable: boolean;
|
|
21250
|
-
backfill_until: string;
|
|
21251
|
-
collapsed_tag_keys?: components["schemas"]["VirtualTagConfigCollapsedTagKey"][];
|
|
21252
|
-
values: components["schemas"]["VirtualTagConfigValue"][];
|
|
21253
|
-
}>;
|
|
20860
|
+
delete(token: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
21254
20861
|
/**
|
|
21255
20862
|
* Return the processing status of a specific VirtualTagConfig.
|
|
21256
20863
|
*/
|
|
@@ -21266,11 +20873,17 @@ declare class VirtualTagConfigsApi<NeverThrow extends boolean> {
|
|
|
21266
20873
|
/**
|
|
21267
20874
|
* Asynchronously updates an existing VirtualTagConfig.
|
|
21268
20875
|
*/
|
|
21269
|
-
updateAsyncVirtualTagConfig(token: string, body: UpdateAsyncVirtualTagConfigRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
20876
|
+
updateAsyncVirtualTagConfig(token: string, body: UpdateAsyncVirtualTagConfigRequest): Promise<NeverThrow extends true ? [null, VantageAPIError] | [{
|
|
20877
|
+
request_id: string;
|
|
20878
|
+
status_url: string;
|
|
20879
|
+
}, null] : {
|
|
20880
|
+
request_id: string;
|
|
20881
|
+
status_url: string;
|
|
20882
|
+
}>;
|
|
21270
20883
|
/**
|
|
21271
20884
|
* Check the status of an async VirtualTagConfig update.
|
|
21272
20885
|
*/
|
|
21273
|
-
getAsyncVirtualTagConfigStatus(requestId: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [
|
|
20886
|
+
getAsyncVirtualTagConfigStatus(requestId: string): Promise<NeverThrow extends true ? [null, VantageAPIError] | [boolean, null] : boolean>;
|
|
21274
20887
|
}
|
|
21275
20888
|
declare class WorkspacesApi<NeverThrow extends boolean> {
|
|
21276
20889
|
private client;
|
|
@@ -21349,4 +20962,112 @@ declare class PingApi<NeverThrow extends boolean> {
|
|
|
21349
20962
|
get(): Promise<NeverThrow extends true ? [null, VantageAPIError] | [void, null] : void>;
|
|
21350
20963
|
}
|
|
21351
20964
|
|
|
21352
|
-
|
|
20965
|
+
/** A string that is guaranteed to not contain slashes. Can be generated with {@link pathEncode} */
|
|
20966
|
+
type NoSlashString = string & {
|
|
20967
|
+
readonly __noSlash: unique symbol;
|
|
20968
|
+
};
|
|
20969
|
+
/** Encodes a path segment then returns a type that guarantees to TS it does not contain slashes. */
|
|
20970
|
+
declare function pathEncode(value: string): NoSlashString;
|
|
20971
|
+
type UnBracket<S extends string> = S extends `${infer X}{${string}}${infer Z}` ? UnBracket<`${X}${NoSlashString}${Z}`> : S;
|
|
20972
|
+
type PathsRedefined = {
|
|
20973
|
+
[K in keyof paths as `/v2${UnBracket<K>}`]: [paths[K], K];
|
|
20974
|
+
};
|
|
20975
|
+
/** Defines a union of paths supported by the client. */
|
|
20976
|
+
type Path = keyof PathsRedefined;
|
|
20977
|
+
type MethodsCased = {
|
|
20978
|
+
get: "GET";
|
|
20979
|
+
post: "POST";
|
|
20980
|
+
put: "PUT";
|
|
20981
|
+
delete: "DELETE";
|
|
20982
|
+
patch: "PATCH";
|
|
20983
|
+
head: "HEAD";
|
|
20984
|
+
options: "OPTIONS";
|
|
20985
|
+
trace: "TRACE";
|
|
20986
|
+
};
|
|
20987
|
+
type MethodsInverted = {
|
|
20988
|
+
[K in keyof MethodsCased as MethodsCased[K]]: K;
|
|
20989
|
+
};
|
|
20990
|
+
type MethodsPossiblyUndefined = {
|
|
20991
|
+
[K in keyof MethodsCased]?: any;
|
|
20992
|
+
};
|
|
20993
|
+
type Methods<P extends MethodsPossiblyUndefined> = {
|
|
20994
|
+
[K in keyof MethodsCased]: P[K] extends undefined ? never : MethodsCased[K];
|
|
20995
|
+
}[keyof MethodsCased];
|
|
20996
|
+
/** Defines the supported request methods for a given path. */
|
|
20997
|
+
type SupportedMethods<P extends Path> = Methods<PathsRedefined[P][0]>;
|
|
20998
|
+
type Query<T extends {
|
|
20999
|
+
parameters?: {
|
|
21000
|
+
query?: any;
|
|
21001
|
+
};
|
|
21002
|
+
} | undefined> = T["parameters"]["query"] extends never | undefined ? {} : T["parameters"]["query"];
|
|
21003
|
+
type ReqBody<T extends {
|
|
21004
|
+
requestBody?: {
|
|
21005
|
+
content: any;
|
|
21006
|
+
};
|
|
21007
|
+
} | undefined> = T extends {
|
|
21008
|
+
requestBody: {
|
|
21009
|
+
content: {
|
|
21010
|
+
"application/json": infer R;
|
|
21011
|
+
};
|
|
21012
|
+
};
|
|
21013
|
+
} ? R : T extends {
|
|
21014
|
+
requestBody: {
|
|
21015
|
+
content: {
|
|
21016
|
+
"multipart/form-data": infer R;
|
|
21017
|
+
};
|
|
21018
|
+
};
|
|
21019
|
+
} ? R : {};
|
|
21020
|
+
/** Defines the request body type for a given path and method. */
|
|
21021
|
+
type RequestBodyForPathAndMethod<P extends Path, M extends SupportedMethods<P>> = M extends "GET" ? Query<PathsRedefined[P][0][MethodsInverted[M]]> : ReqBody<PathsRedefined[P][0][MethodsInverted[M]]>;
|
|
21022
|
+
type ExtendsGoodResponseCode<Code extends number, Output> = {
|
|
21023
|
+
[C in Code]: {
|
|
21024
|
+
responses: {
|
|
21025
|
+
[_ in C]: {
|
|
21026
|
+
content: {
|
|
21027
|
+
"application/json": Output;
|
|
21028
|
+
};
|
|
21029
|
+
};
|
|
21030
|
+
};
|
|
21031
|
+
};
|
|
21032
|
+
}[Code];
|
|
21033
|
+
/** Patches for specific endpoints go here. This is useful for when the OpenAPI spec is not specific enough for our liking. */
|
|
21034
|
+
type PathAndMethodSpecificPatches = {
|
|
21035
|
+
"/v2/costs": {
|
|
21036
|
+
GET: {
|
|
21037
|
+
total_usage?: {
|
|
21038
|
+
[usageUnit: string]: string;
|
|
21039
|
+
};
|
|
21040
|
+
};
|
|
21041
|
+
};
|
|
21042
|
+
};
|
|
21043
|
+
type LookupTableType = {
|
|
21044
|
+
[P in Path]: Partial<{
|
|
21045
|
+
[M in SupportedMethods<P>]: any;
|
|
21046
|
+
}>;
|
|
21047
|
+
};
|
|
21048
|
+
type ExecutePatch<Patch, Response> = keyof Patch extends never ? Response : Omit<Response, keyof Patch> & Patch;
|
|
21049
|
+
type DoPathSpecificPatches<P extends Path, M extends SupportedMethods<P>, Response, LookupTable extends Partial<LookupTableType>> = LookupTable[P] extends never ? Response : ExecutePatch<LookupTable[P][M], Response>;
|
|
21050
|
+
/** Defines the response body type for a given path and method. */
|
|
21051
|
+
type ResponseBodyForPathAndMethod<P extends Path, M extends SupportedMethods<P>> = `${M} ${P}` extends keyof PathResponseEdgecases ? PathResponseEdgecases[`${M} ${P}` & keyof PathResponseEdgecases] : PathsRedefined[P][0][MethodsInverted[M]] extends ExtendsGoodResponseCode<200 | 201 | 202 | 203, infer R> ? DoPathSpecificPatches<P, M, R, PathAndMethodSpecificPatches> : void;
|
|
21052
|
+
/** Defines a vantage API failure */
|
|
21053
|
+
declare class VantageAPIError extends Error {
|
|
21054
|
+
readonly status: number | null;
|
|
21055
|
+
readonly statusText: string | null;
|
|
21056
|
+
readonly body: string;
|
|
21057
|
+
readonly errors: string[] | null;
|
|
21058
|
+
constructor(status: number | null, statusText: string | null, body: string);
|
|
21059
|
+
}
|
|
21060
|
+
type NeverThrowResult<T> = [null, VantageAPIError] | [T, null];
|
|
21061
|
+
/** Defines the base client for all API requests. */
|
|
21062
|
+
declare class BaseClient<NeverThrow extends boolean> {
|
|
21063
|
+
private readonly bearerToken;
|
|
21064
|
+
private readonly neverThrow;
|
|
21065
|
+
readonly baseUrl: string;
|
|
21066
|
+
/** Overridden by the generated client. Maps a route key prefix ("METHOD /path/prefix") to its edgecase handler name. */
|
|
21067
|
+
protected routeEdgecases: ReadonlyMap<string, string>;
|
|
21068
|
+
constructor(bearerToken: string, neverThrow: NeverThrow, baseUrl: string);
|
|
21069
|
+
/** Sends a request to the API. */
|
|
21070
|
+
request<RequestPath extends Path, RequestMethod extends SupportedMethods<RequestPath>>(path: RequestPath, method: RequestMethod, body: RequestBodyForPathAndMethod<RequestPath, RequestMethod>): Promise<NeverThrow extends true ? NeverThrowResult<ResponseBodyForPathAndMethod<RequestPath, RequestMethod>> : ResponseBodyForPathAndMethod<RequestPath, RequestMethod>>;
|
|
21071
|
+
}
|
|
21072
|
+
|
|
21073
|
+
export { APIV2Client, type AddTeamMemberRequest, type AddTeamMemberResponse, type CreateAccessGrantRequest, type CreateAccessGrantResponse, type CreateAnomalyNotificationRequest, type CreateAnomalyNotificationResponse, type CreateAzureIntegrationRequest, type CreateAzureIntegrationResponse, type CreateBillingProfileRequest, type CreateBillingProfileResponse, type CreateBillingRuleRequest, type CreateBillingRuleResponse, type CreateBudgetAlertRequest, type CreateBudgetAlertResponse, type CreateBudgetRequest, type CreateBudgetResponse, type CreateBusinessMetricRequest, type CreateBusinessMetricResponse, type CreateCostAlertRequest, type CreateCostAlertResponse, type CreateCostExportRequest, type CreateCostExportResponse, type CreateCostReportRequest, type CreateCostReportResponse, type CreateCustomProviderIntegrationRequest, type CreateCustomProviderIntegrationResponse, type CreateDashboardRequest, type CreateDashboardResponse, type CreateExchangeRatesViaCsvRequest, type CreateExchangeRatesViaCsvResponse, type CreateFinancialCommitmentReportRequest, type CreateFinancialCommitmentReportResponse, type CreateFolderRequest, type CreateFolderResponse, type CreateGCPIntegrationRequest, type CreateGCPIntegrationResponse, type CreateInvoiceRequest, type CreateInvoiceResponse, type CreateKubernetesEfficiencyReportExportRequest, type CreateKubernetesEfficiencyReportExportResponse, type CreateKubernetesEfficiencyReportRequest, type CreateKubernetesEfficiencyReportResponse, type CreateManagedAccountRequest, type CreateManagedAccountResponse, type CreateNetworkFlowReportRequest, type CreateNetworkFlowReportResponse, type CreateRecommendationViewRequest, type CreateRecommendationViewResponse, type CreateReportNotificationRequest, type CreateReportNotificationResponse, type CreateResourceReportRequest, type CreateResourceReportResponse, type CreateSavedFilterRequest, type CreateSavedFilterResponse, type CreateSegmentRequest, type CreateSegmentResponse, type CreateSsoConnectionForManagedAccountRequest, type CreateSsoConnectionForManagedAccountResponse, type CreateTeamRequest, type CreateTeamResponse, type CreateUnitCostsExportRequest, type CreateUnitCostsExportResponse, type CreateUserCostsUploadViaCsvRequest, type CreateUserCostsUploadViaCsvResponse, type CreateUserFeedbackRequest, type CreateUserFeedbackResponse, type CreateVirtualTagConfigRequest, type CreateVirtualTagConfigResponse, type CreateWorkspaceRequest, type CreateWorkspaceResponse, type DeleteAccessGrantResponse, type DeleteAnomalyNotificationResponse, type DeleteBillingProfileResponse, type DeleteBillingRuleResponse, type DeleteBudgetAlertResponse, type DeleteBudgetResponse, type DeleteBusinessMetricResponse, type DeleteCostAlertResponse, type DeleteCostReportResponse, type DeleteDashboardResponse, type DeleteFinancialCommitmentReportResponse, type DeleteFolderResponse, type DeleteIntegrationResponse, type DeleteKubernetesEfficiencyReportResponse, type DeleteManagedAccountResponse, type DeleteNetworkFlowReportResponse, type DeleteRecommendationViewResponse, type DeleteReportNotificationResponse, type DeleteResourceReportResponse, type DeleteSavedFilterResponse, type DeleteSegmentResponse, type DeleteSsoConnectionForManagedAccountResponse, type DeleteTeamResponse, type DeleteUserCostsUploadResponse, type DeleteVirtualTagConfigResponse, type DownloadInvoiceRequest, type DownloadInvoiceResponse, type GetAccessGrantResponse, type GetAccessGrantsRequest, type GetAccessGrantsResponse, type GetAnomalyAlertResponse, type GetAnomalyAlertsRequest, type GetAnomalyAlertsResponse, type GetAnomalyNotificationResponse, type GetAnomalyNotificationsRequest, type GetAnomalyNotificationsResponse, type GetAsyncVirtualTagConfigStatusResponse, type GetAuditLogResponse, type GetAuditLogsRequest, type GetAuditLogsResponse, type GetBillingProfileResponse, type GetBillingProfilesRequest, type GetBillingProfilesResponse, type GetBillingRuleResponse, type GetBillingRulesRequest, type GetBillingRulesResponse, type GetBudgetAlertResponse, type GetBudgetAlertsRequest, type GetBudgetAlertsResponse, type GetBudgetRequest, type GetBudgetResponse, type GetBudgetsRequest, type GetBudgetsResponse, type GetBusinessMetricForecastedValuesRequest, type GetBusinessMetricForecastedValuesResponse, type GetBusinessMetricResponse, type GetBusinessMetricValuesRequest, type GetBusinessMetricValuesResponse, type GetBusinessMetricsRequest, type GetBusinessMetricsResponse, type GetCostAlertEventResponse, type GetCostAlertEventsRequest, type GetCostAlertEventsResponse, type GetCostAlertResponse, type GetCostAlertsResponse, type GetCostProviderAccountsRequest, type GetCostProviderAccountsResponse, type GetCostProvidersRequest, type GetCostProvidersResponse, type GetCostReportResponse, type GetCostReportsRequest, type GetCostReportsResponse, type GetCostServicesRequest, type GetCostServicesResponse, type GetCostsRequest, type GetCostsResponse, type GetDashboardResponse, type GetDashboardsRequest, type GetDashboardsResponse, type GetDataExportResponse, type GetExchangeRatesRequest, type GetExchangeRatesResponse, type GetFinancialCommitmentReportResponse, type GetFinancialCommitmentReportsRequest, type GetFinancialCommitmentReportsResponse, type GetFinancialCommitmentsRequest, type GetFinancialCommitmentsResponse, type GetFolderResponse, type GetFoldersRequest, type GetFoldersResponse, type GetForecastedCostsRequest, type GetForecastedCostsResponse, type GetIntegrationResponse, type GetIntegrationsRequest, type GetIntegrationsResponse, type GetInvoiceCostReportResponse, type GetInvoiceResponse, type GetInvoicesRequest, type GetInvoicesResponse, type GetKubernetesEfficiencyReportResponse, type GetKubernetesEfficiencyReportsRequest, type GetKubernetesEfficiencyReportsResponse, type GetManagedAccountResponse, type GetManagedAccountsRequest, type GetManagedAccountsResponse, type GetMeResponse, type GetNetworkFlowReportResponse, type GetNetworkFlowReportsRequest, type GetNetworkFlowReportsResponse, type GetPriceResponse, type GetPricesRequest, type GetPricesResponse, type GetProductResponse, type GetProductsRequest, type GetProductsResponse, type GetRecommendationResourceResponse, type GetRecommendationResourcesRequest, type GetRecommendationResourcesResponse, type GetRecommendationResponse, type GetRecommendationTypeResourcesRequest, type GetRecommendationTypeResourcesResponse, type GetRecommendationViewResponse, type GetRecommendationViewsRequest, type GetRecommendationViewsResponse, type GetRecommendationsRequest, type GetRecommendationsResponse, type GetReportNotificationResponse, type GetReportNotificationsRequest, type GetReportNotificationsResponse, type GetReportResourcesRequest, type GetReportResourcesResponse, type GetResourceReportColumnsRequest, type GetResourceReportColumnsResponse, type GetResourceReportResponse, type GetResourceReportsRequest, type GetResourceReportsResponse, type GetResourceRequest, type GetResourceResponse, type GetSavedFilterResponse, type GetSavedFiltersRequest, type GetSavedFiltersResponse, type GetSegmentResponse, type GetSegmentsRequest, type GetSegmentsResponse, type GetTagValuesRequest, type GetTagValuesResponse, type GetTagsRequest, type GetTagsResponse, type GetTeamMembersRequest, type GetTeamMembersResponse, type GetTeamResponse, type GetTeamsRequest, type GetTeamsResponse, type GetUnitCostsRequest, type GetUnitCostsResponse, type GetUserCostsUploadsResponse, type GetUserResponse, type GetUsersRequest, type GetUsersResponse, type GetVirtualTagConfigResponse, type GetVirtualTagConfigStatusResponse, type GetVirtualTagConfigsResponse, type GetWorkspaceResponse, type GetWorkspacesRequest, type GetWorkspacesResponse, type NoSlashString, type Path, type PathResponseEdgecases, type PingResponse, type RegenerateInvoiceResponse, type RemoveTeamMemberResponse, type RequestBodyForPathAndMethod, type ResponseBodyForPathAndMethod, type SendAndApproveInvoiceResponse, type SendInvoiceResponse, type SupportedMethods, type UpdateAccessGrantRequest, type UpdateAccessGrantResponse, type UpdateAnomalyAlertRequest, type UpdateAnomalyAlertResponse, type UpdateAnomalyNotificationRequest, type UpdateAnomalyNotificationResponse, type UpdateAsyncVirtualTagConfigRequest, type UpdateAsyncVirtualTagConfigResponse, type UpdateBillingProfileRequest, type UpdateBillingProfileResponse, type UpdateBillingRuleRequest, type UpdateBillingRuleResponse, type UpdateBudgetAlertRequest, type UpdateBudgetAlertResponse, type UpdateBudgetRequest, type UpdateBudgetResponse, type UpdateBusinessMetricRequest, type UpdateBusinessMetricResponse, type UpdateBusinessMetricValuesCSVRequest, type UpdateBusinessMetricValuesCSVResponse, type UpdateCostAlertRequest, type UpdateCostAlertResponse, type UpdateCostReportRequest, type UpdateCostReportResponse, type UpdateDashboardRequest, type UpdateDashboardResponse, type UpdateFinancialCommitmentReportRequest, type UpdateFinancialCommitmentReportResponse, type UpdateFolderRequest, type UpdateFolderResponse, type UpdateIntegrationRequest, type UpdateIntegrationResponse, type UpdateKubernetesEfficiencyReportRequest, type UpdateKubernetesEfficiencyReportResponse, type UpdateManagedAccountRequest, type UpdateManagedAccountResponse, type UpdateMeRequest, type UpdateMeResponse, type UpdateNetworkFlowReportRequest, type UpdateNetworkFlowReportResponse, type UpdateRecommendationViewRequest, type UpdateRecommendationViewResponse, type UpdateReportNotificationRequest, type UpdateReportNotificationResponse, type UpdateResourceReportRequest, type UpdateResourceReportResponse, type UpdateSavedFilterRequest, type UpdateSavedFilterResponse, type UpdateSegmentRequest, type UpdateSegmentResponse, type UpdateSsoConnectionForManagedAccountRequest, type UpdateSsoConnectionForManagedAccountResponse, type UpdateTagRequest, type UpdateTagResponse, type UpdateTeamRequest, type UpdateTeamResponse, type UpdateUserRequest, type UpdateUserResponse, type UpdateVirtualTagConfigRequest, type UpdateVirtualTagConfigResponse, type UpdateWorkspaceRequest, type UpdateWorkspaceResponse, VantageAPIError, pathEncode };
|