infrawrench-sdk 1.116.0 → 1.117.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 83f85353d3ee5a3010c8d887dd44eb44ff7761c247c2c8b5c47c6d4307f018b2
4
- data.tar.gz: 6ea045d6342382d51658e7be9ef484d69889edf25e8081200a85112ad990fcfa
3
+ metadata.gz: 39691080f657f10ef6bed4339c0ce6f25d02f6f76abe68d42b9ef95adb473243
4
+ data.tar.gz: aa482c0113e8721cd37ef032fe126990cf027566484f7c2d7d190ceadb0694c6
5
5
  SHA512:
6
- metadata.gz: 678595b69c5642eb4448b66446252e245ca75fa9559b603e672a6914e6f20fa6be81cbefbe7d067da3803dfa92f67bf261f0b530e622ab6ae74f00f0327fb814
7
- data.tar.gz: e11c90d6ef83c1fe831c4c2d1084eb0e6fe4585168b752c81bc3ea2ad5cca9547e3402eacfd7ed346a6aa892cf9b044757838eb5c88e0234345d3c06008768a3
6
+ metadata.gz: 1f205fbe9a424ad84ebe204ebbd8af2c1afc8587caca9ac9255423a3e0ec35fe6a6916299a15f341bc95f6f3fb7925f533a3623405814635f5230fb9f1d6c2e1
7
+ data.tar.gz: 34c2e2e85496d18690c948aea183162126895a8f57a11ba3d4e71b1437d5d3050950758cd68c2c8f7fcda59ff3a61e300e324b3df62a4abf0e44c3069d826eb1
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # infrawrench-sdk
2
2
 
3
- Generated Ruby client for the Infrawrench API (API version `1.116.0`).
3
+ Generated Ruby client for the Infrawrench API (API version `1.117.0`).
4
4
 
5
5
  **Do not edit this gem by hand** — it is regenerated from `openapi.json` and is
6
6
  not checked into the repository. Run
@@ -41,7 +41,7 @@ Every method takes an optional trailing `request_options:` hash (`:headers`,
41
41
  Responses are the plain `Hash`/`Array` that `JSON.parse` returns, with String
42
42
  keys spelled exactly as the wire spells them. There are no model classes — see
43
43
  [`sig/infrawrench/sdk.rbs`](./sig/infrawrench/sdk.rbs) for the shape of every one of the
44
- 1342 schemas, as RBS type aliases that steep and TypeProf can read.
44
+ 1359 schemas, as RBS type aliases that steep and TypeProf can read.
45
45
 
46
46
  Non-2xx responses raise `Infrawrench::ApiError`, which carries `#status`,
47
47
  the parsed `#body`, and the machine-readable `#code` when the API sends one —
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # infrawrench-sdk v1.116.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
3
+ # infrawrench-sdk v1.117.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
4
4
  # https://github.com/Infrawrench/Infrawrench
5
5
  #
6
- # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.116.0).
6
+ # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.117.0).
7
7
  #
8
8
  # DO NOT EDIT. Regenerate with:
9
9
  # pnpm --filter @infrawrench/web generate:sdk
@@ -17,8 +17,8 @@ require_relative "lib/infrawrench/version"
17
17
  Gem::Specification.new do |spec|
18
18
  spec.name = "infrawrench-sdk"
19
19
  spec.version = Infrawrench::VERSION
20
- spec.summary = "Generated Ruby client for the Infrawrench API (v1.116.0)."
21
- spec.description = "Generated Ruby client for the Infrawrench API (v1.116.0). Covers the published API surface only — operations marked x-internal in the spec are not generated. No runtime dependencies."
20
+ spec.summary = "Generated Ruby client for the Infrawrench API (v1.117.0)."
21
+ spec.description = "Generated Ruby client for the Infrawrench API (v1.117.0). Covers the published API surface only — operations marked x-internal in the spec are not generated. No runtime dependencies."
22
22
  spec.authors = ["Infrawrench Services, Inc.", "Astrid Gealer"]
23
23
  spec.email = ["astrid@infrawrench.com"]
24
24
  spec.homepage = "https://infrawrench.com/docs/team-and-billing/client-sdks"
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # infrawrench-sdk v1.116.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
3
+ # infrawrench-sdk v1.117.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
4
4
  # https://github.com/Infrawrench/Infrawrench
5
5
  #
6
- # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.116.0).
6
+ # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.117.0).
7
7
  #
8
8
  # DO NOT EDIT. Regenerate with:
9
9
  # pnpm --filter @infrawrench/web generate:sdk
@@ -6977,12 +6977,187 @@ module Infrawrench
6977
6977
  end
6978
6978
  end
6979
6979
 
6980
+ # `client.commitments.reports`
6981
+ class CommitmentsReportsNamespace
6982
+ # @api private
6983
+ # @param transport [Transport]
6984
+ def initialize(transport)
6985
+ @transport = transport
6986
+ end
6987
+
6988
+ # Create a commitment report
6989
+ #
6990
+ # Stored exactly as sent. The creator is the report's implicit owner for
6991
+ # sharing; filing it in a folder needs editor access to the folder.
6992
+ # Audit-logged.
6993
+ #
6994
+ # _Requires permission: `costs:write`._
6995
+ #
6996
+ # POST /api/org/{orgId}/commitments/reports
6997
+ #
6998
+ # Raises on 400: Bad request
6999
+ #
7000
+ # Raises on 403: Forbidden
7001
+ #
7002
+ # @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
7003
+ # constructed with.
7004
+ # @param body [Hash] Request body, shaped as `CommitmentReportInput`.
7005
+ # @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
7006
+ # @return [Hash] Parsed JSON, shaped as `CommitmentReport` — see `sig/infrawrench/sdk.rbs`.
7007
+ # @raise [Infrawrench::ApiError] On any non-2xx response.
7008
+ def create(body:, org_id: nil, request_options: nil)
7009
+ @transport.request(
7010
+ http_method: "POST",
7011
+ path: "/api/org/{orgId}/commitments/reports",
7012
+ path_params: { "orgId" => org_id },
7013
+ body: body,
7014
+ request_options: request_options
7015
+ )
7016
+ end
7017
+
7018
+ # Delete a commitment report
7019
+ #
7020
+ # Soft delete; its sharing goes with it. Audit-logged.
7021
+ #
7022
+ # _Requires permission: `costs:write`._
7023
+ #
7024
+ # DELETE /api/org/{orgId}/commitments/reports/{id}
7025
+ #
7026
+ # Raises on 403: Forbidden
7027
+ #
7028
+ # Raises on 404: Not found
7029
+ #
7030
+ # @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
7031
+ # constructed with.
7032
+ # @param id [String]
7033
+ # @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
7034
+ # @return [Hash] Parsed JSON, shaped as `Ok` — see `sig/infrawrench/sdk.rbs`.
7035
+ # @raise [Infrawrench::ApiError] On any non-2xx response.
7036
+ def delete(id:, org_id: nil, request_options: nil)
7037
+ @transport.request(
7038
+ http_method: "DELETE",
7039
+ path: "/api/org/{orgId}/commitments/reports/{id}",
7040
+ path_params: { "orgId" => org_id, "id" => id },
7041
+ request_options: request_options
7042
+ )
7043
+ end
7044
+
7045
+ # Get a commitment report
7046
+ #
7047
+ # _Requires permission: `costs:read`._
7048
+ #
7049
+ # GET /api/org/{orgId}/commitments/reports/{id}
7050
+ #
7051
+ # Raises on 404: Not found
7052
+ #
7053
+ # @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
7054
+ # constructed with.
7055
+ # @param id [String]
7056
+ # @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
7057
+ # @return [Hash] Parsed JSON, shaped as `CommitmentReport` — see `sig/infrawrench/sdk.rbs`.
7058
+ # @raise [Infrawrench::ApiError] On any non-2xx response.
7059
+ def get(id:, org_id: nil, request_options: nil)
7060
+ @transport.request(
7061
+ http_method: "GET",
7062
+ path: "/api/org/{orgId}/commitments/reports/{id}",
7063
+ path_params: { "orgId" => org_id, "id" => id },
7064
+ request_options: request_options
7065
+ )
7066
+ end
7067
+
7068
+ # List saved commitment reports
7069
+ #
7070
+ # The saved commitment reports the caller's sharing lets them open, by name.
7071
+ #
7072
+ # _Requires permission: `costs:read`._
7073
+ #
7074
+ # GET /api/org/{orgId}/commitments/reports
7075
+ #
7076
+ # @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
7077
+ # constructed with.
7078
+ # @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
7079
+ # @return [Array<Hash>] Parsed JSON, shaped as `Array<CommitmentReport>` — see
7080
+ # `sig/infrawrench/sdk.rbs`.
7081
+ # @raise [Infrawrench::ApiError] On any non-2xx response.
7082
+ def list(org_id: nil, request_options: nil)
7083
+ @transport.request(
7084
+ http_method: "GET",
7085
+ path: "/api/org/{orgId}/commitments/reports",
7086
+ path_params: { "orgId" => org_id },
7087
+ request_options: request_options
7088
+ )
7089
+ end
7090
+
7091
+ # Run a saved commitment report
7092
+ #
7093
+ # A relative date range resolves against today on every run, and a range
7094
+ # reaching past today ends today.
7095
+ #
7096
+ # _Requires permission: `costs:read`._
7097
+ #
7098
+ # POST /api/org/{orgId}/commitments/reports/{id}/run
7099
+ #
7100
+ # Raises on 404: Not found
7101
+ #
7102
+ # @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
7103
+ # constructed with.
7104
+ # @param id [String]
7105
+ # @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
7106
+ # @return [Hash] Parsed JSON, shaped as `CommitmentReportRunResult` — see
7107
+ # `sig/infrawrench/sdk.rbs`.
7108
+ # @raise [Infrawrench::ApiError] On any non-2xx response.
7109
+ def run(id:, org_id: nil, request_options: nil)
7110
+ @transport.request(
7111
+ http_method: "POST",
7112
+ path: "/api/org/{orgId}/commitments/reports/{id}/run",
7113
+ path_params: { "orgId" => org_id, "id" => id },
7114
+ request_options: request_options
7115
+ )
7116
+ end
7117
+
7118
+ # Replace a commitment report
7119
+ #
7120
+ # Name, description, config and folder together. Needs editor. Moving it to
7121
+ # another folder needs editor access to that folder. Audit-logged.
7122
+ #
7123
+ # _Requires permission: `costs:write`._
7124
+ #
7125
+ # PUT /api/org/{orgId}/commitments/reports/{id}
7126
+ #
7127
+ # Raises on 400: Bad request
7128
+ #
7129
+ # Raises on 403: Forbidden
7130
+ #
7131
+ # Raises on 404: Not found
7132
+ #
7133
+ # @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
7134
+ # constructed with.
7135
+ # @param id [String]
7136
+ # @param body [Hash] Request body, shaped as `CommitmentReportInput`.
7137
+ # @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
7138
+ # @return [Hash] Parsed JSON, shaped as `CommitmentReport` — see `sig/infrawrench/sdk.rbs`.
7139
+ # @raise [Infrawrench::ApiError] On any non-2xx response.
7140
+ def update(id:, body:, org_id: nil, request_options: nil)
7141
+ @transport.request(
7142
+ http_method: "PUT",
7143
+ path: "/api/org/{orgId}/commitments/reports/{id}",
7144
+ path_params: { "orgId" => org_id, "id" => id },
7145
+ body: body,
7146
+ request_options: request_options
7147
+ )
7148
+ end
7149
+ end
7150
+
6980
7151
  # `client.commitments`
6981
7152
  class CommitmentsNamespace
7153
+ # @return [CommitmentsReportsNamespace] `client.commitments.reports`
7154
+ attr_reader :reports
7155
+
6982
7156
  # @api private
6983
7157
  # @param transport [Transport]
6984
7158
  def initialize(transport)
6985
7159
  @transport = transport
7160
+ @reports = CommitmentsReportsNamespace.new(@transport)
6986
7161
  end
6987
7162
 
6988
7163
  # Reservations, savings plans and committed-use discounts
@@ -7026,6 +7201,60 @@ module Infrawrench
7026
7201
  request_options: request_options
7027
7202
  )
7028
7203
  end
7204
+
7205
+ # Picker values for the commitment report editor
7206
+ #
7207
+ # Providers (with whether their cost rows can measure coverage), accounts,
7208
+ # the services and regions with usage in the last 180 days, and the
7209
+ # commitment inventory. Scoped to what the caller may see.
7210
+ #
7211
+ # _Requires permission: `costs:read`._
7212
+ #
7213
+ # GET /api/org/{orgId}/commitments/report-options
7214
+ #
7215
+ # @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
7216
+ # constructed with.
7217
+ # @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
7218
+ # @return [Hash] Parsed JSON, shaped as `CommitmentReportOptions` — see
7219
+ # `sig/infrawrench/sdk.rbs`.
7220
+ # @raise [Infrawrench::ApiError] On any non-2xx response.
7221
+ def report_options(org_id: nil, request_options: nil)
7222
+ @transport.request(
7223
+ http_method: "GET",
7224
+ path: "/api/org/{orgId}/commitments/report-options",
7225
+ path_params: { "orgId" => org_id },
7226
+ request_options: request_options
7227
+ )
7228
+ end
7229
+
7230
+ # Run an unsaved commitment report config
7231
+ #
7232
+ # Coverage, utilization, savings and commitment cost over time, on the
7233
+ # amortized basis. See `CommitmentReportMetricValues` for each metric's
7234
+ # formula. A read despite the method.
7235
+ #
7236
+ # _Requires permission: `costs:read`._
7237
+ #
7238
+ # POST /api/org/{orgId}/commitments/report-query
7239
+ #
7240
+ # Raises on 400: Bad request
7241
+ #
7242
+ # @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
7243
+ # constructed with.
7244
+ # @param body [Hash] Request body, shaped as `CommitmentReportConfig`.
7245
+ # @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
7246
+ # @return [Hash] Parsed JSON, shaped as `CommitmentReportResult` — see
7247
+ # `sig/infrawrench/sdk.rbs`.
7248
+ # @raise [Infrawrench::ApiError] On any non-2xx response.
7249
+ def report_query(body:, org_id: nil, request_options: nil)
7250
+ @transport.request(
7251
+ http_method: "POST",
7252
+ path: "/api/org/{orgId}/commitments/report-query",
7253
+ path_params: { "orgId" => org_id },
7254
+ body: body,
7255
+ request_options: request_options
7256
+ )
7257
+ end
7029
7258
  end
7030
7259
 
7031
7260
  # `client.compliance.controls`
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # infrawrench-sdk v1.116.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
3
+ # infrawrench-sdk v1.117.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
4
4
  # https://github.com/Infrawrench/Infrawrench
5
5
  #
6
- # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.116.0).
6
+ # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.117.0).
7
7
  #
8
8
  # DO NOT EDIT. Regenerate with:
9
9
  # pnpm --filter @infrawrench/web generate:sdk
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # infrawrench-sdk v1.116.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
3
+ # infrawrench-sdk v1.117.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
4
4
  # https://github.com/Infrawrench/Infrawrench
5
5
  #
6
- # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.116.0).
6
+ # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.117.0).
7
7
  #
8
8
  # DO NOT EDIT. Regenerate with:
9
9
  # pnpm --filter @infrawrench/web generate:sdk
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # infrawrench-sdk v1.116.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
3
+ # infrawrench-sdk v1.117.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
4
4
  # https://github.com/Infrawrench/Infrawrench
5
5
  #
6
- # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.116.0).
6
+ # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.117.0).
7
7
  #
8
8
  # DO NOT EDIT. Regenerate with:
9
9
  # pnpm --filter @infrawrench/web generate:sdk
@@ -15,5 +15,5 @@
15
15
  # Kept in its own file so the gemspec can read the version without loading the
16
16
  # client — a gemspec that pulls in net/http is a gemspec that can fail to parse.
17
17
  module Infrawrench
18
- VERSION = "1.116.0"
18
+ VERSION = "1.117.0"
19
19
  end
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # infrawrench-sdk v1.116.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
3
+ # infrawrench-sdk v1.117.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
4
4
  # https://github.com/Infrawrench/Infrawrench
5
5
  #
6
- # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.116.0).
6
+ # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.117.0).
7
7
  #
8
8
  # DO NOT EDIT. Regenerate with:
9
9
  # pnpm --filter @infrawrench/web generate:sdk
@@ -1,7 +1,7 @@
1
- # infrawrench-sdk v1.116.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
1
+ # infrawrench-sdk v1.117.0 | MIT | Copyright (c) 2026 Infrawrench Services, Inc.
2
2
  # https://github.com/Infrawrench/Infrawrench
3
3
  #
4
- # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.116.0).
4
+ # Generated from the Infrawrench API OpenAPI 3.1 spec (API version 1.117.0).
5
5
  #
6
6
  # DO NOT EDIT. Regenerate with:
7
7
  # pnpm --filter @infrawrench/web generate:sdk
@@ -2779,6 +2779,202 @@ module Infrawrench
2779
2779
  "gate" => "presence" | "not_in_decline" | "floor" | "materiality"
2780
2780
  }
2781
2781
 
2782
+ # Spec schema: `CommitmentReport`.
2783
+ type commitment_report = {
2784
+ "id" => String,
2785
+ "name" => String,
2786
+ "description" => String | nil,
2787
+ "config" => commitment_report_config,
2788
+ "folderId" => String | nil,
2789
+ "createdByUserId" => String | nil,
2790
+ "createdAt" => String,
2791
+ "updatedAt" => String
2792
+ }
2793
+
2794
+ # An absolute range covers at most 1096 days, and at most 367 at daily
2795
+ # granularity. Every relative preset fits every granularity.
2796
+ #
2797
+ # Spec schema: `CommitmentReportConfig`.
2798
+ type commitment_report_config = {
2799
+ "version" => Numeric,
2800
+ "dateRange" => cost_date_range,
2801
+ "granularity" => commitment_report_granularity,
2802
+ "groupBy" => commitment_report_group_by,
2803
+ "filters" => commitment_report_filters,
2804
+ "metric" => commitment_report_metric
2805
+ }
2806
+
2807
+ # Lists AND-compose; values within a list OR. An absent list does not filter.
2808
+ # `commitmentTypes` and `commitmentIds` narrow the commitment side (covered
2809
+ # usage and unused fees) only: uncovered usage stays in, because it is the
2810
+ # rest of the coverage denominator.
2811
+ #
2812
+ # Spec schema: `CommitmentReportFilters`.
2813
+ type commitment_report_filters = {
2814
+ ?"providers" => Array[String],
2815
+ ?"commitmentTypes" => Array[commitment_report_kind],
2816
+ ?"services" => Array[String],
2817
+ ?"accountIds" => Array[String],
2818
+ ?"regions" => Array[String],
2819
+ ?"commitmentIds" => Array[String]
2820
+ }
2821
+
2822
+ # Bucket size. There is no hourly: spend is collected one row per UTC day, so
2823
+ # an hourly bucket would put each day's spend at midnight. Weeks start on
2824
+ # Monday.
2825
+ #
2826
+ # Spec schema: `CommitmentReportGranularity`.
2827
+ type commitment_report_granularity = "daily" | "weekly" | "monthly" | "quarterly"
2828
+
2829
+ # `commitment_type` and `commitment` split the commitment side by holding and
2830
+ # put uncovered usage in its own `__on_demand__` group; covered usage the
2831
+ # provider did not tie to a commitment (all of AWS, whose Cost Explorer cannot
2832
+ # group by commitment) is `__unattributed__`, and a commitment the inventory
2833
+ # no longer holds is `__unknown_kind__` under `commitment_type`. Under those
2834
+ # two, each group's coverage is its share of the bucket's whole usage, so the
2835
+ # groups add up. Instance family is not offered: no collector stores it on
2836
+ # cost rows.
2837
+ #
2838
+ # Spec schema: `CommitmentReportGroupBy`.
2839
+ type commitment_report_group_by = "none" | "provider" | "commitment_type" | "commitment" | "service" | "account" | "region"
2840
+
2841
+ # Spec schema: `CommitmentReportInput`.
2842
+ type commitment_report_input = {
2843
+ "name" => String,
2844
+ ?"description" => String | nil,
2845
+ "config" => commitment_report_config,
2846
+ ?"folderId" => String | nil
2847
+ }
2848
+
2849
+ # Spec schema: `CommitmentReportKind`.
2850
+ type commitment_report_kind = "reservation" | "savings_plan" | "committed_use"
2851
+
2852
+ # The metric the chart draws. A result always carries every metric.
2853
+ #
2854
+ # Spec schema: `CommitmentReportMetric`.
2855
+ type commitment_report_metric = "coverage"
2856
+ | "eligibleCoverage"
2857
+ | "utilization"
2858
+ | "effectiveSavingsRate"
2859
+ | "netSavings"
2860
+ | "onDemandRemainder"
2861
+ | "commitmentCost"
2862
+ | "usedCommitmentCost"
2863
+ | "unusedCommitmentCost"
2864
+
2865
+ # Spec schema: `CommitmentReportMetricValues`.
2866
+ type commitment_report_metric_values = {
2867
+ "coverage" => Numeric | nil,
2868
+ "eligibleCoverage" => Numeric | nil,
2869
+ "utilization" => Numeric | nil,
2870
+ "effectiveSavingsRate" => Numeric | nil,
2871
+ "netSavings" => Numeric | nil,
2872
+ "onDemandRemainder" => Numeric,
2873
+ "commitmentCost" => Numeric,
2874
+ "usedCommitmentCost" => Numeric,
2875
+ "unusedCommitmentCost" => Numeric,
2876
+ "onDemandEquivalent" => Numeric,
2877
+ "savingsMeasuredShare" => Numeric | nil
2878
+ }
2879
+
2880
+ # `unused_lumped_monthly`: a provider in scope books a month's unused
2881
+ # commitment fee on one day of its daily data, so a daily or weekly
2882
+ # utilization dips on that day. `unattributed_commitment_usage`: some covered
2883
+ # usage could not be tied to a commitment and is grouped as
2884
+ # `__unattributed__`. `partial_savings_measurement`: some covered usage had no
2885
+ # reported on-demand equivalent and counts as saving nothing.
2886
+ # `no_measurable_accounts`: no account in scope can measure coverage.
2887
+ #
2888
+ # Spec schema: `CommitmentReportNotice`.
2889
+ type commitment_report_notice = "unused_lumped_monthly"
2890
+ | "unattributed_commitment_usage"
2891
+ | "partial_savings_measurement"
2892
+ | "no_measurable_accounts"
2893
+
2894
+ # Spec schema: `CommitmentReportOptions`.
2895
+ type commitment_report_options = {
2896
+ "providers" => Array[{
2897
+ "pluginId" => plugin_id,
2898
+ "displayName" => String,
2899
+ "status" => "measured" | "inventory_only"
2900
+ }],
2901
+ "accounts" => Array[{ "id" => String, "name" => String, "pluginId" => plugin_id }],
2902
+ "services" => Array[String],
2903
+ "regions" => Array[String],
2904
+ "commitments" => Array[{
2905
+ "commitmentId" => String,
2906
+ "accountId" => String,
2907
+ "pluginId" => plugin_id,
2908
+ "kind" => commitment_report_kind,
2909
+ "description" => String,
2910
+ "state" => String
2911
+ }]
2912
+ }
2913
+
2914
+ # Spec schema: `CommitmentReportPoint`.
2915
+ type commitment_report_point = {
2916
+ "bucket" => String,
2917
+ "totals" => commitment_report_totals,
2918
+ "metrics" => commitment_report_metric_values
2919
+ }
2920
+
2921
+ # Spec schema: `CommitmentReportProvider`.
2922
+ type commitment_report_provider = {
2923
+ "pluginId" => plugin_id,
2924
+ "displayName" => String,
2925
+ "status" => "measured" | "inventory_only",
2926
+ "accountCount" => Integer
2927
+ }
2928
+
2929
+ # Spec schema: `CommitmentReportResult`.
2930
+ type commitment_report_result = {
2931
+ "from" => String,
2932
+ "to" => String,
2933
+ "granularity" => commitment_report_granularity,
2934
+ "groupBy" => commitment_report_group_by,
2935
+ "buckets" => Array[String],
2936
+ "series" => Array[commitment_report_series],
2937
+ "overall" => Array[commitment_report_series],
2938
+ "providers" => Array[commitment_report_provider],
2939
+ "notices" => Array[commitment_report_notice]
2940
+ }
2941
+
2942
+ # Spec schema: `CommitmentReportRunResult`.
2943
+ type commitment_report_run_result = {
2944
+ "from" => String,
2945
+ "to" => String,
2946
+ "granularity" => commitment_report_granularity,
2947
+ "groupBy" => commitment_report_group_by,
2948
+ "buckets" => Array[String],
2949
+ "series" => Array[commitment_report_series],
2950
+ "overall" => Array[commitment_report_series],
2951
+ "providers" => Array[commitment_report_provider],
2952
+ "notices" => Array[commitment_report_notice],
2953
+ "reportId" => String,
2954
+ "name" => String
2955
+ }
2956
+
2957
+ # Spec schema: `CommitmentReportSeries`.
2958
+ type commitment_report_series = {
2959
+ "id" => String,
2960
+ "groupKey" => String,
2961
+ "label" => String,
2962
+ "currency" => String,
2963
+ "points" => Array[commitment_report_point],
2964
+ "total" => { "totals" => commitment_report_totals, "metrics" => commitment_report_metric_values }
2965
+ }
2966
+
2967
+ # Spec schema: `CommitmentReportTotals`.
2968
+ type commitment_report_totals = {
2969
+ "covered" => Numeric,
2970
+ "coveredAll" => Numeric,
2971
+ "unused" => Numeric,
2972
+ "uncovered" => Numeric,
2973
+ "uncoveredEligible" => Numeric,
2974
+ "coveredOnDemand" => Numeric,
2975
+ "coveredMeasured" => Numeric
2976
+ }
2977
+
2782
2978
  # Spec schema: `CommitmentUnitAmount`.
2783
2979
  type commitment_unit_amount = { "unit" => String, "amount" => Numeric }
2784
2980
 
@@ -14060,6 +14256,7 @@ module Infrawrench
14060
14256
  | "savings_view"
14061
14257
  | "resource_report"
14062
14258
  | "network_flow_report"
14259
+ | "commitment_report"
14063
14260
 
14064
14261
  # Spec schema: `SharedConsole`.
14065
14262
  type shared_console = {
@@ -16149,9 +16346,22 @@ module Infrawrench
16149
16346
  def usage: (?org_id: String?, ?month: String?, ?request_options: Hash[Symbol, untyped]?) -> ci_usage
16150
16347
  end
16151
16348
 
16349
+ class CommitmentsReportsNamespace
16350
+ def initialize: (Transport) -> void
16351
+ def create: (body: commitment_report_input, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> commitment_report
16352
+ def delete: (id: String, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> ok
16353
+ def get: (id: String, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> commitment_report
16354
+ def list: (?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> Array[commitment_report]
16355
+ def run: (id: String, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> commitment_report_run_result
16356
+ def update: (id: String, body: commitment_report_input, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> commitment_report
16357
+ end
16358
+
16152
16359
  class CommitmentsNamespace
16360
+ attr_reader reports: CommitmentsReportsNamespace
16153
16361
  def initialize: (Transport) -> void
16154
16362
  def get: (?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> commitments_feed
16363
+ def report_options: (?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> commitment_report_options
16364
+ def report_query: (body: commitment_report_config, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> commitment_report_result
16155
16365
  end
16156
16366
 
16157
16367
  class ComplianceControlsNamespace
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: infrawrench-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.116.0
4
+ version: 1.117.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Infrawrench Services, Inc.
@@ -11,7 +11,7 @@ bindir: bin
11
11
  cert_chain: []
12
12
  date: 2026-11-17 00:00:00.000000000 Z
13
13
  dependencies: []
14
- description: Generated Ruby client for the Infrawrench API (v1.116.0). Covers the
14
+ description: Generated Ruby client for the Infrawrench API (v1.117.0). Covers the
15
15
  published API surface only — operations marked x-internal in the spec are not generated.
16
16
  No runtime dependencies.
17
17
  email:
@@ -58,5 +58,5 @@ requirements: []
58
58
  rubygems_version: 3.5.22
59
59
  signing_key:
60
60
  specification_version: 4
61
- summary: Generated Ruby client for the Infrawrench API (v1.116.0).
61
+ summary: Generated Ruby client for the Infrawrench API (v1.117.0).
62
62
  test_files: []