@vantage-sh/vantage-client 2.18.0 → 2.19.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/dist/index.d.mts CHANGED
@@ -4685,11 +4685,11 @@ interface components {
4685
4685
  filter?: string;
4686
4686
  /** @description The token of the Workspace to query costs from. Ignored if 'cost_report_token' is set. Required if the API token is associated with multiple Workspaces. */
4687
4687
  workspace_token?: string;
4688
- /** @description First date you would like to filter costs from. ISO 8601 formatted. */
4688
+ /** @description First date you would like to filter costs from. ISO 8601 formatted. When omitted with cost_report_token, the report's saved start date is used. */
4689
4689
  start_date?: string;
4690
- /** @description Last date you would like to filter costs to. ISO 8601 formatted. */
4690
+ /** @description Last date you would like to filter costs to. ISO 8601 formatted. When omitted with cost_report_token, the report's saved end date is used. */
4691
4691
  end_date?: string;
4692
- /** @description Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
4692
+ /** @description Group the results by specific field(s). When omitted with cost_report_token, the report's saved groupings are used; otherwise defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
4693
4693
  groupings?: string[];
4694
4694
  /**
4695
4695
  * @description The date bin of the costs. Defaults to the report's default or day.
@@ -4873,6 +4873,21 @@ interface components {
4873
4873
  * @example DataTransfer-Regional-Bytes
4874
4874
  */
4875
4875
  cost_subcategory?: string | null;
4876
+ /**
4877
+ * @description The charge type for the cost.
4878
+ * @example Usage
4879
+ */
4880
+ charge_type?: string | null;
4881
+ /**
4882
+ * @description Whether the cost has tags.
4883
+ * @example true
4884
+ */
4885
+ tagged?: boolean | null;
4886
+ /**
4887
+ * @description The unit used to measure usage.
4888
+ * @example GB
4889
+ */
4890
+ usage_unit?: string | null;
4876
4891
  /**
4877
4892
  * @description The segment name for segment report costs.
4878
4893
  * @example Engineering
@@ -11343,11 +11358,11 @@ interface operations {
11343
11358
  filter?: string;
11344
11359
  /** @description The token of the Workspace to query costs from. Ignored if 'cost_report_token' is set. Required if the API token is associated with multiple Workspaces. */
11345
11360
  workspace_token?: string;
11346
- /** @description First date you would like to filter costs from. ISO 8601 formatted. */
11361
+ /** @description First date you would like to filter costs from. ISO 8601 formatted. When omitted with cost_report_token, the report's saved start date is used. */
11347
11362
  start_date?: string;
11348
- /** @description Last date you would like to filter costs to. ISO 8601 formatted. */
11363
+ /** @description Last date you would like to filter costs to. ISO 8601 formatted. When omitted with cost_report_token, the report's saved end date is used. */
11349
11364
  end_date?: string;
11350
- /** @description Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
11365
+ /** @description Group the results by specific field(s). When omitted with cost_report_token, the report's saved groupings are used; otherwise defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
11351
11366
  groupings?: string[];
11352
11367
  /** @description Whether to order costs by date in an ascending or descending manner. */
11353
11368
  order?: "asc" | "desc";
package/dist/index.d.ts CHANGED
@@ -4685,11 +4685,11 @@ interface components {
4685
4685
  filter?: string;
4686
4686
  /** @description The token of the Workspace to query costs from. Ignored if 'cost_report_token' is set. Required if the API token is associated with multiple Workspaces. */
4687
4687
  workspace_token?: string;
4688
- /** @description First date you would like to filter costs from. ISO 8601 formatted. */
4688
+ /** @description First date you would like to filter costs from. ISO 8601 formatted. When omitted with cost_report_token, the report's saved start date is used. */
4689
4689
  start_date?: string;
4690
- /** @description Last date you would like to filter costs to. ISO 8601 formatted. */
4690
+ /** @description Last date you would like to filter costs to. ISO 8601 formatted. When omitted with cost_report_token, the report's saved end date is used. */
4691
4691
  end_date?: string;
4692
- /** @description Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
4692
+ /** @description Group the results by specific field(s). When omitted with cost_report_token, the report's saved groupings are used; otherwise defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
4693
4693
  groupings?: string[];
4694
4694
  /**
4695
4695
  * @description The date bin of the costs. Defaults to the report's default or day.
@@ -4873,6 +4873,21 @@ interface components {
4873
4873
  * @example DataTransfer-Regional-Bytes
4874
4874
  */
4875
4875
  cost_subcategory?: string | null;
4876
+ /**
4877
+ * @description The charge type for the cost.
4878
+ * @example Usage
4879
+ */
4880
+ charge_type?: string | null;
4881
+ /**
4882
+ * @description Whether the cost has tags.
4883
+ * @example true
4884
+ */
4885
+ tagged?: boolean | null;
4886
+ /**
4887
+ * @description The unit used to measure usage.
4888
+ * @example GB
4889
+ */
4890
+ usage_unit?: string | null;
4876
4891
  /**
4877
4892
  * @description The segment name for segment report costs.
4878
4893
  * @example Engineering
@@ -11343,11 +11358,11 @@ interface operations {
11343
11358
  filter?: string;
11344
11359
  /** @description The token of the Workspace to query costs from. Ignored if 'cost_report_token' is set. Required if the API token is associated with multiple Workspaces. */
11345
11360
  workspace_token?: string;
11346
- /** @description First date you would like to filter costs from. ISO 8601 formatted. */
11361
+ /** @description First date you would like to filter costs from. ISO 8601 formatted. When omitted with cost_report_token, the report's saved start date is used. */
11347
11362
  start_date?: string;
11348
- /** @description Last date you would like to filter costs to. ISO 8601 formatted. */
11363
+ /** @description Last date you would like to filter costs to. ISO 8601 formatted. When omitted with cost_report_token, the report's saved end date is used. */
11349
11364
  end_date?: string;
11350
- /** @description Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
11365
+ /** @description Group the results by specific field(s). When omitted with cost_report_token, the report's saved groupings are used; otherwise defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region */
11351
11366
  groupings?: string[];
11352
11367
  /** @description Whether to order costs by date in an ascending or descending manner. */
11353
11368
  order?: "asc" | "desc";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vantage-sh/vantage-client",
3
- "version": "2.18.0",
3
+ "version": "2.19.0",
4
4
  "description": "The Vantage Client SDK for TypeScript and JavaScript applications.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",