stigg 0.1.0.pre.beta.44 → 0.1.0.pre.beta.45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/README.md +1 -1
  4. data/lib/stigg/client.rb +1 -1
  5. data/lib/stigg/models/v1/addon_update_params.rb +68 -8
  6. data/lib/stigg/models/v1/credits/credit_grant_response.rb +3 -3
  7. data/lib/stigg/models/v1/credits/grant_list_response.rb +3 -3
  8. data/lib/stigg/models/v1/{event_estimate_cost_params.rb → event_estimate_params.rb} +3 -3
  9. data/lib/stigg/models/v1/{event_estimate_cost_response.rb → event_estimate_response.rb} +19 -19
  10. data/lib/stigg/models/v1/events/beta/customer_retrieve_governance_params.rb +173 -0
  11. data/lib/stigg/models/v1/events/beta/customer_retrieve_governance_response.rb +166 -0
  12. data/lib/stigg/models/v1/events/data_export/{destination_update_params.rb → destination_update_selection_params.rb} +2 -2
  13. data/lib/stigg/models/v1/events/data_export/{destination_update_response.rb → destination_update_selection_response.rb} +13 -13
  14. data/lib/stigg/models/v1/plan_update_params.rb +68 -8
  15. data/lib/stigg/models/v1/{usage_estimate_cost_params.rb → usage_estimate_params.rb} +6 -6
  16. data/lib/stigg/models/v1/{usage_estimate_cost_response.rb → usage_estimate_response.rb} +19 -19
  17. data/lib/stigg/resources/v1/events/beta/customers.rb +99 -0
  18. data/lib/stigg/resources/v1/events/beta.rb +22 -0
  19. data/lib/stigg/resources/v1/events/data_export/destinations.rb +38 -38
  20. data/lib/stigg/resources/v1/events.rb +11 -7
  21. data/lib/stigg/resources/v1/usage.rb +8 -8
  22. data/lib/stigg/resources/v1_beta/customers.rb +0 -78
  23. data/lib/stigg/version.rb +1 -1
  24. data/lib/stigg.rb +10 -8
  25. data/rbi/stigg/models/v1/addon_update_params.rbi +134 -14
  26. data/rbi/stigg/models/v1/credits/credit_grant_response.rbi +3 -3
  27. data/rbi/stigg/models/v1/credits/grant_list_response.rbi +3 -3
  28. data/rbi/stigg/models/v1/{event_estimate_cost_params.rbi → event_estimate_params.rbi} +7 -7
  29. data/rbi/stigg/models/v1/{usage_estimate_cost_response.rbi → event_estimate_response.rbi} +29 -31
  30. data/rbi/stigg/models/v1/events/beta/customer_retrieve_governance_params.rbi +365 -0
  31. data/rbi/stigg/models/v1/events/beta/customer_retrieve_governance_response.rbi +251 -0
  32. data/rbi/stigg/models/v1/events/data_export/{destination_update_params.rbi → destination_update_selection_params.rbi} +2 -2
  33. data/rbi/stigg/models/v1/events/data_export/{destination_update_response.rbi → destination_update_selection_response.rbi} +16 -16
  34. data/rbi/stigg/models/v1/plan_update_params.rbi +134 -14
  35. data/rbi/stigg/models/v1/{usage_estimate_cost_params.rbi → usage_estimate_params.rbi} +15 -17
  36. data/rbi/stigg/models/v1/{event_estimate_cost_response.rbi → usage_estimate_response.rbi} +29 -31
  37. data/rbi/stigg/resources/v1/events/beta/customers.rbi +89 -0
  38. data/rbi/stigg/resources/v1/events/beta.rbi +19 -0
  39. data/rbi/stigg/resources/v1/events/data_export/destinations.rbi +28 -28
  40. data/rbi/stigg/resources/v1/events.rbi +6 -3
  41. data/rbi/stigg/resources/v1/usage.rbi +4 -4
  42. data/rbi/stigg/resources/v1_beta/customers.rbi +0 -69
  43. data/sig/stigg/models/v1/addon_update_params.rbs +57 -10
  44. data/sig/stigg/models/v1/{event_estimate_cost_params.rbs → event_estimate_params.rbs} +9 -9
  45. data/sig/stigg/models/v1/{event_estimate_cost_response.rbs → event_estimate_response.rbs} +24 -26
  46. data/sig/stigg/models/v1/events/beta/customer_retrieve_governance_params.rbs +166 -0
  47. data/sig/stigg/models/v1/events/beta/customer_retrieve_governance_response.rbs +117 -0
  48. data/sig/stigg/models/v1/events/data_export/{destination_update_params.rbs → destination_update_selection_params.rbs} +2 -2
  49. data/sig/stigg/models/v1/events/data_export/{destination_update_response.rbs → destination_update_selection_response.rbs} +16 -16
  50. data/sig/stigg/models/v1/plan_update_params.rbs +57 -10
  51. data/sig/stigg/models/v1/{usage_estimate_cost_params.rbs → usage_estimate_params.rbs} +16 -16
  52. data/sig/stigg/models/v1/{usage_estimate_cost_response.rbs → usage_estimate_response.rbs} +24 -26
  53. data/sig/stigg/resources/v1/events/beta/customers.rbs +30 -0
  54. data/sig/stigg/resources/v1/events/beta.rbs +13 -0
  55. data/sig/stigg/resources/v1/events/data_export/destinations.rbs +6 -6
  56. data/sig/stigg/resources/v1/events.rbs +5 -3
  57. data/sig/stigg/resources/v1/usage.rbs +4 -4
  58. data/sig/stigg/resources/v1_beta/customers.rbs +0 -17
  59. metadata +32 -26
  60. data/lib/stigg/models/v1_beta/customer_retrieve_governance_params.rb +0 -168
  61. data/lib/stigg/models/v1_beta/customer_retrieve_governance_response.rb +0 -161
  62. data/rbi/stigg/models/v1_beta/customer_retrieve_governance_params.rbi +0 -361
  63. data/rbi/stigg/models/v1_beta/customer_retrieve_governance_response.rbi +0 -247
  64. data/sig/stigg/models/v1_beta/customer_retrieve_governance_params.rbs +0 -162
  65. data/sig/stigg/models/v1_beta/customer_retrieve_governance_response.rbs +0 -113
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6db024a60e1adbdbe122e0450c04c41609a556179669277b4812c9d816490c39
4
- data.tar.gz: 07655e06beeebad975ed6c4d6634d913924d26b08ccbaf8d4226f39ec587b4cc
3
+ metadata.gz: 0da22a110fde969a0e632ce47b783952417266a438024c1dd38d5cf37e38a7e0
4
+ data.tar.gz: 6c0de78da1b5977126515d1b80cff5e2e81aa597e2003ee1be6935b8ac38b119
5
5
  SHA512:
6
- metadata.gz: 97ea9bb87dca0bcb1e991316027c0edd46c54d152c5c9b20c6cc6671b93414702599b227a9d987141bfff206c6e025feaa5db60f5604047cf1aa2472d214c1d3
7
- data.tar.gz: 7df8ede3bf17a5a0c662e48efdf4f2ae1dca7b682397db11721b9eaa09b69f6cb367e1f8ec5799cd77c58361f185f59a449134b630a0f3c0bd5d529860f5d823
6
+ metadata.gz: cbd490b1fdd8bc95eaf5064f8c6b36f7215c23e72d4988b8b644f73ec8e850e370a008eec865a0ef49430f4b062c72b4855221f959fa30a3ba98e7cdbdc91c81
7
+ data.tar.gz: 14b9fc61a2c4f90ffd2017cd14947942fd46a0a547815c77f854879d47dcd6fd093a9a3d6c37ca1df85935b841b3a75602532ed47686d9828df5ad11bfe72468
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.0-beta.45 (2026-07-26)
4
+
5
+ Full Changelog: [v0.1.0-beta.44...v0.1.0-beta.45](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.44...v0.1.0-beta.45)
6
+
7
+ ### Features
8
+
9
+ * **api:** add credit_entitlement parameter to addon/plan update params ([2ae6de4](https://github.com/stiggio/stigg-ruby/commit/2ae6de4c869d839537de19fcef36469979cccea2))
10
+
11
+
12
+ ### Chores
13
+
14
+ * **internal:** regenerate SDK with no functional changes ([0ec3e2e](https://github.com/stiggio/stigg-ruby/commit/0ec3e2e23ee5088f27abeb230a7b695daa362886))
15
+
3
16
  ## 0.1.0-beta.44 (2026-07-21)
4
17
 
5
18
  Full Changelog: [v0.1.0-beta.43...v0.1.0-beta.44](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.43...v0.1.0-beta.44)
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "stigg", "~> 0.1.0.pre.beta.44"
27
+ gem "stigg", "~> 0.1.0.pre.beta.45"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
data/lib/stigg/client.rb CHANGED
@@ -53,7 +53,7 @@ module Stigg
53
53
  initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
54
54
  max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
55
55
  )
56
- base_url ||= "https://edge.api.stigg.io"
56
+ base_url ||= "https://api.stigg.io"
57
57
 
58
58
  if api_key.nil?
59
59
  raise ArgumentError.new("api_key is required, and can be set via environ: \"STIGG_API_KEY\"")
@@ -400,6 +400,21 @@ module Stigg
400
400
  enum: -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::BillingCadence },
401
401
  api_name: :billingCadence
402
402
 
403
+ # @!attribute credit_entitlement
404
+ # Credit entitlement to grant when a credit overage targets a currency not yet
405
+ # granted on the plan
406
+ #
407
+ # @return [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::CreditEntitlement, nil]
408
+ optional :credit_entitlement,
409
+ -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::CreditEntitlement },
410
+ api_name: :creditEntitlement
411
+
412
+ # @!attribute currency_id
413
+ # The refId of the custom currency this credit overage applies to
414
+ #
415
+ # @return [String, nil]
416
+ optional :currency_id, String, api_name: :currencyId
417
+
403
418
  # @!attribute entitlement
404
419
  # Entitlement configuration for the overage feature
405
420
  #
@@ -412,13 +427,11 @@ module Stigg
412
427
  # @return [String, nil]
413
428
  optional :feature_id, String, api_name: :featureId
414
429
 
415
- # @!attribute top_up_custom_currency_id
416
- # Custom currency ID for overage top-up
430
+ # @!method initialize(billing_model:, price_periods:, billing_cadence: nil, credit_entitlement: nil, currency_id: nil, entitlement: nil, feature_id: nil)
431
+ # Some parameter documentations has been truncated, see
432
+ # {Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel} for more
433
+ # details.
417
434
  #
418
- # @return [String, nil]
419
- optional :top_up_custom_currency_id, String, api_name: :topUpCustomCurrencyId
420
-
421
- # @!method initialize(billing_model:, price_periods:, billing_cadence: nil, entitlement: nil, feature_id: nil, top_up_custom_currency_id: nil)
422
435
  # Overage pricing model configuration.
423
436
  #
424
437
  # @param billing_model [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::BillingModel] The billing model for overages
@@ -427,11 +440,13 @@ module Stigg
427
440
  #
428
441
  # @param billing_cadence [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::BillingCadence] The billing cadence for overages
429
442
  #
443
+ # @param credit_entitlement [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::CreditEntitlement] Credit entitlement to grant when a credit overage targets a currency not yet gra
444
+ #
445
+ # @param currency_id [String] The refId of the custom currency this credit overage applies to
446
+ #
430
447
  # @param entitlement [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::Entitlement] Entitlement configuration for the overage feature
431
448
  #
432
449
  # @param feature_id [String] The feature ID for overage pricing
433
- #
434
- # @param top_up_custom_currency_id [String] Custom currency ID for overage top-up
435
450
 
436
451
  # The billing model for overages
437
452
  #
@@ -1079,6 +1094,51 @@ module Stigg
1079
1094
  # @return [Array<Symbol>]
1080
1095
  end
1081
1096
 
1097
+ # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel#credit_entitlement
1098
+ class CreditEntitlement < Stigg::Internal::Type::BaseModel
1099
+ # @!attribute amount
1100
+ # The base credit balance granted per cadence
1101
+ #
1102
+ # @return [Float]
1103
+ required :amount, Float
1104
+
1105
+ # @!attribute cadence
1106
+ # The credit grant cadence (MONTH or YEAR)
1107
+ #
1108
+ # @return [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::CreditEntitlement::Cadence]
1109
+ required :cadence,
1110
+ enum: -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::CreditEntitlement::Cadence }
1111
+
1112
+ # @!attribute custom_currency_id
1113
+ # The refId of the custom currency to grant
1114
+ #
1115
+ # @return [String]
1116
+ required :custom_currency_id, String, api_name: :customCurrencyId
1117
+
1118
+ # @!method initialize(amount:, cadence:, custom_currency_id:)
1119
+ # Credit entitlement to grant when a credit overage targets a currency not yet
1120
+ # granted on the plan
1121
+ #
1122
+ # @param amount [Float] The base credit balance granted per cadence
1123
+ #
1124
+ # @param cadence [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::CreditEntitlement::Cadence] The credit grant cadence (MONTH or YEAR)
1125
+ #
1126
+ # @param custom_currency_id [String] The refId of the custom currency to grant
1127
+
1128
+ # The credit grant cadence (MONTH or YEAR)
1129
+ #
1130
+ # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::CreditEntitlement#cadence
1131
+ module Cadence
1132
+ extend Stigg::Internal::Type::Enum
1133
+
1134
+ MONTH = :MONTH
1135
+ YEAR = :YEAR
1136
+
1137
+ # @!method self.values
1138
+ # @return [Array<Symbol>]
1139
+ end
1140
+ end
1141
+
1082
1142
  # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel#entitlement
1083
1143
  class Entitlement < Stigg::Internal::Type::BaseModel
1084
1144
  # @!attribute feature_id
@@ -86,7 +86,7 @@ module Stigg
86
86
  required :expire_at, Time, api_name: :expireAt, nil?: true
87
87
 
88
88
  # @!attribute grant_type
89
- # The type of credit grant (PAID, PROMOTIONAL, RECURRING)
89
+ # The type of credit grant (PAID, PROMOTIONAL, RECURRING, OVERDRAFT)
90
90
  #
91
91
  # @return [Symbol, Stigg::Models::V1::Credits::CreditGrantResponse::Data::GrantType]
92
92
  required :grant_type,
@@ -197,7 +197,7 @@ module Stigg
197
197
  #
198
198
  # @param expire_at [Time, nil] The date when the credit grant expires
199
199
  #
200
- # @param grant_type [Symbol, Stigg::Models::V1::Credits::CreditGrantResponse::Data::GrantType] The type of credit grant (PAID, PROMOTIONAL, RECURRING)
200
+ # @param grant_type [Symbol, Stigg::Models::V1::Credits::CreditGrantResponse::Data::GrantType] The type of credit grant (PAID, PROMOTIONAL, RECURRING, OVERDRAFT)
201
201
  #
202
202
  # @param invoice_id [String, nil] The billing invoice ID associated with this grant
203
203
  #
@@ -243,7 +243,7 @@ module Stigg
243
243
  # @param currency [String] The currency code
244
244
  end
245
245
 
246
- # The type of credit grant (PAID, PROMOTIONAL, RECURRING)
246
+ # The type of credit grant (PAID, PROMOTIONAL, RECURRING, OVERDRAFT)
247
247
  #
248
248
  # @see Stigg::Models::V1::Credits::CreditGrantResponse::Data#grant_type
249
249
  module GrantType
@@ -73,7 +73,7 @@ module Stigg
73
73
  required :expire_at, Time, api_name: :expireAt, nil?: true
74
74
 
75
75
  # @!attribute grant_type
76
- # The type of credit grant (PAID, PROMOTIONAL, RECURRING)
76
+ # The type of credit grant (PAID, PROMOTIONAL, RECURRING, OVERDRAFT)
77
77
  #
78
78
  # @return [Symbol, Stigg::Models::V1::Credits::GrantListResponse::GrantType]
79
79
  required :grant_type,
@@ -182,7 +182,7 @@ module Stigg
182
182
  #
183
183
  # @param expire_at [Time, nil] The date when the credit grant expires
184
184
  #
185
- # @param grant_type [Symbol, Stigg::Models::V1::Credits::GrantListResponse::GrantType] The type of credit grant (PAID, PROMOTIONAL, RECURRING)
185
+ # @param grant_type [Symbol, Stigg::Models::V1::Credits::GrantListResponse::GrantType] The type of credit grant (PAID, PROMOTIONAL, RECURRING, OVERDRAFT)
186
186
  #
187
187
  # @param invoice_id [String, nil] The billing invoice ID associated with this grant
188
188
  #
@@ -228,7 +228,7 @@ module Stigg
228
228
  # @param currency [String] The currency code
229
229
  end
230
230
 
231
- # The type of credit grant (PAID, PROMOTIONAL, RECURRING)
231
+ # The type of credit grant (PAID, PROMOTIONAL, RECURRING, OVERDRAFT)
232
232
  #
233
233
  # @see Stigg::Models::V1::Credits::GrantListResponse#grant_type
234
234
  module GrantType
@@ -3,8 +3,8 @@
3
3
  module Stigg
4
4
  module Models
5
5
  module V1
6
- # @see Stigg::Resources::V1::Events#estimate_cost
7
- class EventEstimateCostParams < Stigg::Internal::Type::BaseModel
6
+ # @see Stigg::Resources::V1::Events#estimate
7
+ class EventEstimateParams < Stigg::Internal::Type::BaseModel
8
8
  extend Stigg::Internal::Type::RequestParameters::Converter
9
9
  include Stigg::Internal::Type::RequestParameters
10
10
 
@@ -25,7 +25,7 @@ module Stigg
25
25
  #
26
26
  # @return [Hash{Symbol=>String, Float, Boolean}, nil]
27
27
  optional :dimensions,
28
- -> { Stigg::Internal::Type::HashOf[union: Stigg::V1::EventEstimateCostParams::Dimension] }
28
+ -> { Stigg::Internal::Type::HashOf[union: Stigg::V1::EventEstimateParams::Dimension] }
29
29
 
30
30
  # @!attribute resource_id
31
31
  # Resource id
@@ -3,41 +3,41 @@
3
3
  module Stigg
4
4
  module Models
5
5
  module V1
6
- # @see Stigg::Resources::V1::Events#estimate_cost
7
- class EventEstimateCostResponse < Stigg::Internal::Type::BaseModel
6
+ # @see Stigg::Resources::V1::Events#estimate
7
+ class EventEstimateResponse < Stigg::Internal::Type::BaseModel
8
8
  # @!attribute data
9
9
  # Estimated credit cost, current balance and balance after
10
10
  #
11
- # @return [Stigg::Models::V1::EventEstimateCostResponse::Data]
12
- required :data, -> { Stigg::Models::V1::EventEstimateCostResponse::Data }
11
+ # @return [Stigg::Models::V1::EventEstimateResponse::Data]
12
+ required :data, -> { Stigg::Models::V1::EventEstimateResponse::Data }
13
13
 
14
14
  # @!method initialize(data:)
15
15
  # Response object
16
16
  #
17
- # @param data [Stigg::Models::V1::EventEstimateCostResponse::Data] Estimated credit cost, current balance and balance after
17
+ # @param data [Stigg::Models::V1::EventEstimateResponse::Data] Estimated credit cost, current balance and balance after
18
18
 
19
- # @see Stigg::Models::V1::EventEstimateCostResponse#data
19
+ # @see Stigg::Models::V1::EventEstimateResponse#data
20
20
  class Data < Stigg::Internal::Type::BaseModel
21
21
  # @!attribute estimates
22
22
  # Per-currency cost estimates
23
23
  #
24
- # @return [Array<Stigg::Models::V1::EventEstimateCostResponse::Data::Estimate>]
24
+ # @return [Array<Stigg::Models::V1::EventEstimateResponse::Data::Estimate>]
25
25
  required :estimates,
26
- -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::EventEstimateCostResponse::Data::Estimate] }
26
+ -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::EventEstimateResponse::Data::Estimate] }
27
27
 
28
28
  # @!attribute warnings
29
29
  # Request-level warnings about the estimation context
30
30
  #
31
- # @return [Array<Symbol, Stigg::Models::V1::EventEstimateCostResponse::Data::Warning>]
31
+ # @return [Array<Symbol, Stigg::Models::V1::EventEstimateResponse::Data::Warning>]
32
32
  required :warnings,
33
- -> { Stigg::Internal::Type::ArrayOf[enum: Stigg::Models::V1::EventEstimateCostResponse::Data::Warning] }
33
+ -> { Stigg::Internal::Type::ArrayOf[enum: Stigg::Models::V1::EventEstimateResponse::Data::Warning] }
34
34
 
35
35
  # @!method initialize(estimates:, warnings:)
36
36
  # Estimated credit cost, current balance and balance after
37
37
  #
38
- # @param estimates [Array<Stigg::Models::V1::EventEstimateCostResponse::Data::Estimate>] Per-currency cost estimates
38
+ # @param estimates [Array<Stigg::Models::V1::EventEstimateResponse::Data::Estimate>] Per-currency cost estimates
39
39
  #
40
- # @param warnings [Array<Symbol, Stigg::Models::V1::EventEstimateCostResponse::Data::Warning>] Request-level warnings about the estimation context
40
+ # @param warnings [Array<Symbol, Stigg::Models::V1::EventEstimateResponse::Data::Warning>] Request-level warnings about the estimation context
41
41
 
42
42
  class Estimate < Stigg::Internal::Type::BaseModel
43
43
  # @!attribute balance_after_estimate
@@ -49,9 +49,9 @@ module Stigg
49
49
  # @!attribute breakdown
50
50
  # Estimated cost contribution per feature
51
51
  #
52
- # @return [Array<Stigg::Models::V1::EventEstimateCostResponse::Data::Estimate::Breakdown>]
52
+ # @return [Array<Stigg::Models::V1::EventEstimateResponse::Data::Estimate::Breakdown>]
53
53
  required :breakdown,
54
- -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::EventEstimateCostResponse::Data::Estimate::Breakdown] }
54
+ -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::EventEstimateResponse::Data::Estimate::Breakdown] }
55
55
 
56
56
  # @!attribute currency_id
57
57
  # The credit currency identifier
@@ -80,7 +80,7 @@ module Stigg
80
80
  # @!method initialize(balance_after_estimate:, breakdown:, currency_id:, current_balance:, estimated_cost:, would_overdraft:)
81
81
  # @param balance_after_estimate [Float] The credit balance after subtracting the estimated cost
82
82
  #
83
- # @param breakdown [Array<Stigg::Models::V1::EventEstimateCostResponse::Data::Estimate::Breakdown>] Estimated cost contribution per feature
83
+ # @param breakdown [Array<Stigg::Models::V1::EventEstimateResponse::Data::Estimate::Breakdown>] Estimated cost contribution per feature
84
84
  #
85
85
  # @param currency_id [String] The credit currency identifier
86
86
  #
@@ -106,9 +106,9 @@ module Stigg
106
106
  # @!attribute warning_code
107
107
  # Warning explaining why this cost may be inaccurate, if any
108
108
  #
109
- # @return [Symbol, Stigg::Models::V1::EventEstimateCostResponse::Data::Estimate::Breakdown::WarningCode, nil]
109
+ # @return [Symbol, Stigg::Models::V1::EventEstimateResponse::Data::Estimate::Breakdown::WarningCode, nil]
110
110
  required :warning_code,
111
- enum: -> { Stigg::Models::V1::EventEstimateCostResponse::Data::Estimate::Breakdown::WarningCode },
111
+ enum: -> { Stigg::Models::V1::EventEstimateResponse::Data::Estimate::Breakdown::WarningCode },
112
112
  api_name: :warningCode,
113
113
  nil?: true
114
114
 
@@ -117,11 +117,11 @@ module Stigg
117
117
  #
118
118
  # @param feature_id [String] The feature whose meter contributed this cost
119
119
  #
120
- # @param warning_code [Symbol, Stigg::Models::V1::EventEstimateCostResponse::Data::Estimate::Breakdown::WarningCode, nil] Warning explaining why this cost may be inaccurate, if any
120
+ # @param warning_code [Symbol, Stigg::Models::V1::EventEstimateResponse::Data::Estimate::Breakdown::WarningCode, nil] Warning explaining why this cost may be inaccurate, if any
121
121
 
122
122
  # Warning explaining why this cost may be inaccurate, if any
123
123
  #
124
- # @see Stigg::Models::V1::EventEstimateCostResponse::Data::Estimate::Breakdown#warning_code
124
+ # @see Stigg::Models::V1::EventEstimateResponse::Data::Estimate::Breakdown#warning_code
125
125
  module WarningCode
126
126
  extend Stigg::Internal::Type::Enum
127
127
 
@@ -0,0 +1,173 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Stigg
4
+ module Models
5
+ module V1
6
+ module Events
7
+ module Beta
8
+ # @see Stigg::Resources::V1::Events::Beta::Customers#retrieve_governance
9
+ class CustomerRetrieveGovernanceParams < Stigg::Internal::Type::BaseModel
10
+ extend Stigg::Internal::Type::RequestParameters::Converter
11
+ include Stigg::Internal::Type::RequestParameters
12
+
13
+ # @!attribute id
14
+ #
15
+ # @return [String]
16
+ required :id, String
17
+
18
+ # @!attribute after
19
+ # Return items that come after this cursor
20
+ #
21
+ # @return [String, nil]
22
+ optional :after, String
23
+
24
+ # @!attribute currency_ids
25
+ # Currency ids to include, repeated per value (e.g. `?currencyIds=credits`). Omit
26
+ # both featureIds and currencyIds for tree mode.
27
+ #
28
+ # @return [Array<String>, nil]
29
+ optional :currency_ids, Stigg::Internal::Type::ArrayOf[String]
30
+
31
+ # @!attribute entity_id_search
32
+ # Case-insensitive substring match on the entity id (`%`/`_` matched literally).
33
+ #
34
+ # @return [String, nil]
35
+ optional :entity_id_search, String
36
+
37
+ # @!attribute entity_type_ids
38
+ # Filter to one or more entity types, repeated per value (e.g.
39
+ # `?entityTypeIds=team&entityTypeIds=user`).
40
+ #
41
+ # @return [Array<String>, nil]
42
+ optional :entity_type_ids, Stigg::Internal::Type::ArrayOf[String]
43
+
44
+ # @!attribute feature_ids
45
+ # Feature ids to include, repeated per value (e.g.
46
+ # `?featureIds=ai-tokens&featureIds=seats`). Omit both featureIds and currencyIds
47
+ # for tree mode — every node in the hierarchy with no usage configuration
48
+ # attached.
49
+ #
50
+ # @return [Array<String>, nil]
51
+ optional :feature_ids, Stigg::Internal::Type::ArrayOf[String]
52
+
53
+ # @!attribute limit
54
+ # Maximum number of items to return
55
+ #
56
+ # @return [Integer, nil]
57
+ optional :limit, Integer
58
+
59
+ # @!attribute min_utilization
60
+ # Only nodes with utilization ≥ this value (e.g. 0.8 for ≥80%, 1 for at/over
61
+ # limit).
62
+ #
63
+ # @return [Float, nil]
64
+ optional :min_utilization, Float
65
+
66
+ # @!attribute order
67
+ # Sort direction: `asc` or `desc` (default `desc`).
68
+ #
69
+ # @return [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::Order, nil]
70
+ optional :order, enum: -> { Stigg::V1::Events::Beta::CustomerRetrieveGovernanceParams::Order }
71
+
72
+ # @!attribute scope
73
+ # Filter by configuration scope: `all` (default), `nodeWide` (`[]` only), or
74
+ # `scoped` (non-empty only).
75
+ #
76
+ # @return [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::Scope, nil]
77
+ optional :scope, enum: -> { Stigg::V1::Events::Beta::CustomerRetrieveGovernanceParams::Scope }
78
+
79
+ # @!attribute sort_by
80
+ # Sort key: `utilization` (default, cross-capability-safe), `currentUsage`,
81
+ # `usageLimit`, `scopeSize`, `id`, or `createdAt`.
82
+ #
83
+ # @return [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::SortBy, nil]
84
+ optional :sort_by, enum: -> { Stigg::V1::Events::Beta::CustomerRetrieveGovernanceParams::SortBy }
85
+
86
+ # @!attribute x_account_id
87
+ #
88
+ # @return [String, nil]
89
+ optional :x_account_id, String
90
+
91
+ # @!attribute x_environment_id
92
+ #
93
+ # @return [String, nil]
94
+ optional :x_environment_id, String
95
+
96
+ # @!method initialize(id:, after: nil, currency_ids: nil, entity_id_search: nil, entity_type_ids: nil, feature_ids: nil, limit: nil, min_utilization: nil, order: nil, scope: nil, sort_by: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
97
+ # Some parameter documentations has been truncated, see
98
+ # {Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams} for more
99
+ # details.
100
+ #
101
+ # @param id [String]
102
+ #
103
+ # @param after [String] Return items that come after this cursor
104
+ #
105
+ # @param currency_ids [Array<String>] Currency ids to include, repeated per value (e.g. `?currencyIds=credits`). Omit
106
+ #
107
+ # @param entity_id_search [String] Case-insensitive substring match on the entity id (`%`/`_` matched literally).
108
+ #
109
+ # @param entity_type_ids [Array<String>] Filter to one or more entity types, repeated per value (e.g. `?entityTypeIds=tea
110
+ #
111
+ # @param feature_ids [Array<String>] Feature ids to include, repeated per value (e.g. `?featureIds=ai-tokens&featureI
112
+ #
113
+ # @param limit [Integer] Maximum number of items to return
114
+ #
115
+ # @param min_utilization [Float] Only nodes with utilization ≥ this value (e.g. 0.8 for ≥80%, 1 for at/over limit
116
+ #
117
+ # @param order [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::Order] Sort direction: `asc` or `desc` (default `desc`).
118
+ #
119
+ # @param scope [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::Scope] Filter by configuration scope: `all` (default), `nodeWide` (`[]` only), or `scop
120
+ #
121
+ # @param sort_by [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::SortBy] Sort key: `utilization` (default, cross-capability-safe), `currentUsage`, `usage
122
+ #
123
+ # @param x_account_id [String]
124
+ #
125
+ # @param x_environment_id [String]
126
+ #
127
+ # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
128
+
129
+ # Sort direction: `asc` or `desc` (default `desc`).
130
+ module Order
131
+ extend Stigg::Internal::Type::Enum
132
+
133
+ ASC = :asc
134
+ DESC = :desc
135
+
136
+ # @!method self.values
137
+ # @return [Array<Symbol>]
138
+ end
139
+
140
+ # Filter by configuration scope: `all` (default), `nodeWide` (`[]` only), or
141
+ # `scoped` (non-empty only).
142
+ module Scope
143
+ extend Stigg::Internal::Type::Enum
144
+
145
+ ALL = :all
146
+ NODE_WIDE = :nodeWide
147
+ SCOPED = :scoped
148
+
149
+ # @!method self.values
150
+ # @return [Array<Symbol>]
151
+ end
152
+
153
+ # Sort key: `utilization` (default, cross-capability-safe), `currentUsage`,
154
+ # `usageLimit`, `scopeSize`, `id`, or `createdAt`.
155
+ module SortBy
156
+ extend Stigg::Internal::Type::Enum
157
+
158
+ UTILIZATION = :utilization
159
+ CURRENT_USAGE = :currentUsage
160
+ USAGE_LIMIT = :usageLimit
161
+ SCOPE_SIZE = :scopeSize
162
+ ID = :id
163
+ CREATED_AT = :createdAt
164
+
165
+ # @!method self.values
166
+ # @return [Array<Symbol>]
167
+ end
168
+ end
169
+ end
170
+ end
171
+ end
172
+ end
173
+ end