stigg 0.1.0.pre.beta.56 → 0.1.0.pre.beta.58

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caf643c069a9c7e31944a70d419954c49acc1c9b975c9644ffb42eb5033865b1
-  data.tar.gz: 31bb0804bd4955a50ee0426ed0260cbdb01785ecc65fca0917f46068de579c1f
+  metadata.gz: 2dc0923e2fd65116349c3be875f22072437436165685c0188fd19dde1e0b98b3
+  data.tar.gz: 4f24a971b86538a9093c71c1373288cba41fd16e62472985f901563bdd22b315
 SHA512:
-  metadata.gz: 24517b931fec1b909bb1305c51cc6d5a9e09f5a44643fbfc0c6a09fe1b5e35b5412e8106ca599813247adcdf0bc96c38b241f2945377f1883b26b7bf5cfe2ea4
-  data.tar.gz: 157d74d62eebdb8b920da87544c1ed2f09d5b1fb1762ad4a8622a06026776f029eee0de6d69333b38ed489f8306e33724bfe391bb93b3ab21ef2493390895d08
+  metadata.gz: 0cb01d2f91b0406d264d4328b74ace1c5e8b415ef6d7f646d1bca2f402c2676d3143dd8580b001fa5348dc050e0c210b1c6edf1afe9cb86c7afcaf7ccffe3212
+  data.tar.gz: 31e6de49e92edf8b611908785bdd5f008854d8088e535ee8cf0c4f8b78df08330d6b4fc38c617a0772dab1becc520cfd321f3120c7c047a43dd985d0112e247f

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [0.1.0-beta.58](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.57...v0.1.0-beta.58) (2026-10-20)
+
+
+### Bug Fixes
+
+* sync OpenAPI spec from stigg-api ([d5d10f1](https://github.com/stiggio/stigg-ruby/commit/d5d10f164c3e066f9f77fb0e2fbac391e671eaeb))
+* sync OpenAPI spec from stigg-api ([84889fd](https://github.com/stiggio/stigg-ruby/commit/84889fd36858b92f1e5ee94530af6f788e03c9c2))
+
+
+### Chores
+
+* normalize version.rb to gem prerelease format for stlc codegen ([f535762](https://github.com/stiggio/stigg-ruby/commit/f53576294a3e52bbdae9035bdf3ffdd16907a7a5))
+
+## [0.1.0-beta.57](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.56...v0.1.0-beta.57) (2026-10-15)
+
+
+### Bug Fixes
+
+* sync OpenAPI spec from stigg-api ([0eaa97f](https://github.com/stiggio/stigg-ruby/commit/0eaa97f8b2b65260e5da0e1a2c5d4f37f7dc7aef))
+
+
+### Chores
+
+* normalize version.rb to gem prerelease format for stlc codegen ([28cab9a](https://github.com/stiggio/stigg-ruby/commit/28cab9a539b181421d39c03252513203d8f4968c))
+
 ## [0.1.0-beta.56](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.55...v0.1.0-beta.56) (2026-10-15)
 
 

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "stigg", "~> 0.1.0.pre.beta.55"
+gem "stigg", "~> 0.1.0.pre.beta.57"
 ```
 
 <!-- x-release-please-end -->

data/lib/stigg/models/v1/credit_get_usage_params.rb

@@ -40,8 +40,10 @@ module Stigg
         optional :end_date, Time
 
         # @!attribute group_by
-        #   Comma-separated list of feature dimension keys to group usage series by (up to
-        #   3). Each key matches /^[a-zA-Z0-9_$-]+$/
+        #   Comma-separated list of keys to group usage series by: up to 3 custom dimension
+        #   keys, optionally combined with the reserved key `featureId` to also split each
+        #   series by feature (e.g. `featureId,userId`). Each key matches
+        #   /^[a-zA-Z0-9_$-]+$/
         #
         #   @return [String, nil]
         optional :group_by, String
@@ -96,7 +98,7 @@ module Stigg
         #
         #   @param end_date [Time] End date for the credit usage time range (ISO 8601). Defaults to now when startD
         #
-        #   @param group_by [String] Comma-separated list of feature dimension keys to group usage series by (up to 3
+        #   @param group_by [String] Comma-separated list of keys to group usage series by: up to 3 custom dimension
         #
         #   @param limit [Integer] Maximum number of items to return
         #

data/lib/stigg/models/v1/credit_get_usage_response.rb

@@ -135,13 +135,14 @@ module Stigg
             required :event_count, Float, api_name: :eventCount
 
             # @!attribute feature_id
-            #   The feature ID; null when grouping by dimensions only
+            #   The feature ID; null when grouping by dimensions without `featureId`
             #
             #   @return [String, nil]
             required :feature_id, String, api_name: :featureId, nil?: true
 
             # @!attribute feature_name
-            #   The display name of the feature; null when grouping by dimensions only
+            #   The display name of the feature; null when grouping by dimensions without
+            #   `featureId`
             #
             #   @return [String, nil]
             required :feature_name, String, api_name: :featureName, nil?: true
@@ -160,7 +161,8 @@ module Stigg
             required :total_credits, Float, api_name: :totalCredits
 
             # @!attribute tags
-            #   Dimension key/value pairs identifying this series when groupBy is applied
+            #   Dimension key/value pairs identifying this series when groupBy includes
+            #   dimension keys (`featureId` is returned in its own field, not as a tag)
             #
             #   @return [Array<Stigg::Models::V1::CreditGetUsageResponse::Data::Series::Tag>, nil]
             optional :tags,
@@ -174,15 +176,15 @@ module Stigg
             #
             #   @param event_count [Float] Number of distinct usage events that consumed credits in this series. This count
             #
-            #   @param feature_id [String, nil] The feature ID; null when grouping by dimensions only
+            #   @param feature_id [String, nil] The feature ID; null when grouping by dimensions without `featureId`
             #
-            #   @param feature_name [String, nil] The display name of the feature; null when grouping by dimensions only
+            #   @param feature_name [String, nil] The display name of the feature; null when grouping by dimensions without `featu
             #
             #   @param points [Array<Stigg::Models::V1::CreditGetUsageResponse::Data::Series::Point>] Time-series data points for this feature
             #
             #   @param total_credits [Float] Total credits consumed by this feature in the time range
             #
-            #   @param tags [Array<Stigg::Models::V1::CreditGetUsageResponse::Data::Series::Tag>] Dimension key/value pairs identifying this series when groupBy is applied
+            #   @param tags [Array<Stigg::Models::V1::CreditGetUsageResponse::Data::Series::Tag>] Dimension key/value pairs identifying this series when groupBy includes dimensio
 
             class Point < Stigg::Internal::Type::BaseModel
               # @!attribute event_count

data/lib/stigg/models/v1/customer_check_entitlement_response.rb

@@ -289,6 +289,30 @@ module Stigg
             #   @return [Time, nil]
             optional :entitlement_updated_at, Time, api_name: :entitlementUpdatedAt
 
+            # @!attribute reservation
+            #   The reservation created by this request, when it asked to reserve credits and
+            #   was granted.
+            #
+            #   @return [Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Reservation, nil]
+            optional :reservation,
+                     -> { Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Reservation },
+                     nil?: true
+
+            # @!attribute reserved
+            #   Credits held by open reservations on active grants. Already included in
+            #   currentUsage, so usageLimit - currentUsage is the available balance.
+            #
+            #   @return [Float, nil]
+            optional :reserved, Float
+
+            # @!attribute reserved_on_expired_grants
+            #   Credits still held by open reservations on grants that expired during the hold.
+            #   They can still be released, but are not part of currentUsage or the balance and
+            #   must not be subtracted from it.
+            #
+            #   @return [Float, nil]
+            optional :reserved_on_expired_grants, Float, api_name: :reservedOnExpiredGrants
+
             # @!attribute usage_period_end
             #   The end date of the current billing period for recurring credit grants.
             #
@@ -301,7 +325,11 @@ module Stigg
             #   @return [Time, nil]
             optional :valid_until, Time, api_name: :validUntil
 
-            # @!method initialize(access_denied_reason:, currency:, current_usage:, is_granted:, usage_limit:, usage_updated_at:, entitlement_updated_at: nil, usage_period_end: nil, valid_until: nil, type: :CREDIT)
+            # @!method initialize(access_denied_reason:, currency:, current_usage:, is_granted:, usage_limit:, usage_updated_at:, entitlement_updated_at: nil, reservation: nil, reserved: nil, reserved_on_expired_grants: nil, usage_period_end: nil, valid_until: nil, type: :CREDIT)
+            #   Some parameter documentations has been truncated, see
+            #   {Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit} for more
+            #   details.
+            #
             #   @param access_denied_reason [Symbol, Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::AccessDeniedReason, nil]
             #
             #   @param currency [Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Currency] The currency associated with a credit entitlement.
@@ -316,6 +344,12 @@ module Stigg
             #
             #   @param entitlement_updated_at [Time] Timestamp of the last update to the entitlement grant or configuration.
             #
+            #   @param reservation [Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Reservation, nil] The reservation created by this request, when it asked to reserve credits and wa
+            #
+            #   @param reserved [Float] Credits held by open reservations on active grants. Already included in currentU
+            #
+            #   @param reserved_on_expired_grants [Float] Credits still held by open reservations on grants that expired during the hold.
+            #
             #   @param usage_period_end [Time] The end date of the current billing period for recurring credit grants.
             #
             #   @param valid_until [Time] The next time the entitlement should be recalculated
@@ -398,6 +432,64 @@ module Stigg
               #
               #   @param unit_singular [String, nil] The singular form of the currency unit.
             end
+
+            # @see Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit#reservation
+            class Reservation < Stigg::Internal::Type::BaseModel
+              # @!attribute id
+              #   The client-provided reservation ID.
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute amount
+              #   The amount of credits held.
+              #
+              #   @return [Float]
+              required :amount, Float
+
+              # @!attribute expires_at
+              #   When the reservation expires. Unreleased credits return to the balance at this
+              #   time.
+              #
+              #   @return [Time]
+              required :expires_at, Time, api_name: :expiresAt
+
+              # @!attribute status
+              #   The status of the reservation.
+              #
+              #   @return [Symbol, Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Reservation::Status]
+              required :status,
+                       enum: -> { Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Reservation::Status }
+
+              # @!method initialize(id:, amount:, expires_at:, status:)
+              #   Some parameter documentations has been truncated, see
+              #   {Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Reservation}
+              #   for more details.
+              #
+              #   The reservation created by this request, when it asked to reserve credits and
+              #   was granted.
+              #
+              #   @param id [String] The client-provided reservation ID.
+              #
+              #   @param amount [Float] The amount of credits held.
+              #
+              #   @param expires_at [Time] When the reservation expires. Unreleased credits return to the balance at this t
+              #
+              #   @param status [Symbol, Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Reservation::Status] The status of the reservation.
+
+              # The status of the reservation.
+              #
+              # @see Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Reservation#status
+              module Status
+                extend Stigg::Internal::Type::Enum
+
+                ACTIVE = :ACTIVE
+                RELEASED = :RELEASED
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
           end
 
           # @!method self.variants

data/lib/stigg/models/v1/customer_retrieve_entitlements_response.rb

@@ -331,6 +331,30 @@ module Stigg
               #   @return [Time, nil]
               optional :entitlement_updated_at, Time, api_name: :entitlementUpdatedAt
 
+              # @!attribute reservation
+              #   The reservation created by this request, when it asked to reserve credits and
+              #   was granted.
+              #
+              #   @return [Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::Reservation, nil]
+              optional :reservation,
+                       -> { Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::Reservation },
+                       nil?: true
+
+              # @!attribute reserved
+              #   Credits held by open reservations on active grants. Already included in
+              #   currentUsage, so usageLimit - currentUsage is the available balance.
+              #
+              #   @return [Float, nil]
+              optional :reserved, Float
+
+              # @!attribute reserved_on_expired_grants
+              #   Credits still held by open reservations on grants that expired during the hold.
+              #   They can still be released, but are not part of currentUsage or the balance and
+              #   must not be subtracted from it.
+              #
+              #   @return [Float, nil]
+              optional :reserved_on_expired_grants, Float, api_name: :reservedOnExpiredGrants
+
               # @!attribute usage_period_end
               #   The end date of the current billing period for recurring credit grants.
               #
@@ -343,7 +367,11 @@ module Stigg
               #   @return [Time, nil]
               optional :valid_until, Time, api_name: :validUntil
 
-              # @!method initialize(access_denied_reason:, currency:, current_usage:, is_granted:, usage_limit:, usage_updated_at:, entitlement_updated_at: nil, usage_period_end: nil, valid_until: nil, type: :CREDIT)
+              # @!method initialize(access_denied_reason:, currency:, current_usage:, is_granted:, usage_limit:, usage_updated_at:, entitlement_updated_at: nil, reservation: nil, reserved: nil, reserved_on_expired_grants: nil, usage_period_end: nil, valid_until: nil, type: :CREDIT)
+              #   Some parameter documentations has been truncated, see
+              #   {Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit}
+              #   for more details.
+              #
               #   @param access_denied_reason [Symbol, Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::AccessDeniedReason, nil]
               #
               #   @param currency [Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::Currency] The currency associated with a credit entitlement.
@@ -358,6 +386,12 @@ module Stigg
               #
               #   @param entitlement_updated_at [Time] Timestamp of the last update to the entitlement grant or configuration.
               #
+              #   @param reservation [Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::Reservation, nil] The reservation created by this request, when it asked to reserve credits and wa
+              #
+              #   @param reserved [Float] Credits held by open reservations on active grants. Already included in currentU
+              #
+              #   @param reserved_on_expired_grants [Float] Credits still held by open reservations on grants that expired during the hold.
+              #
               #   @param usage_period_end [Time] The end date of the current billing period for recurring credit grants.
               #
               #   @param valid_until [Time] The next time the entitlement should be recalculated
@@ -440,6 +474,64 @@ module Stigg
                 #
                 #   @param unit_singular [String, nil] The singular form of the currency unit.
               end
+
+              # @see Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit#reservation
+              class Reservation < Stigg::Internal::Type::BaseModel
+                # @!attribute id
+                #   The client-provided reservation ID.
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute amount
+                #   The amount of credits held.
+                #
+                #   @return [Float]
+                required :amount, Float
+
+                # @!attribute expires_at
+                #   When the reservation expires. Unreleased credits return to the balance at this
+                #   time.
+                #
+                #   @return [Time]
+                required :expires_at, Time, api_name: :expiresAt
+
+                # @!attribute status
+                #   The status of the reservation.
+                #
+                #   @return [Symbol, Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::Reservation::Status]
+                required :status,
+                         enum: -> { Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::Reservation::Status }
+
+                # @!method initialize(id:, amount:, expires_at:, status:)
+                #   Some parameter documentations has been truncated, see
+                #   {Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::Reservation}
+                #   for more details.
+                #
+                #   The reservation created by this request, when it asked to reserve credits and
+                #   was granted.
+                #
+                #   @param id [String] The client-provided reservation ID.
+                #
+                #   @param amount [Float] The amount of credits held.
+                #
+                #   @param expires_at [Time] When the reservation expires. Unreleased credits return to the balance at this t
+                #
+                #   @param status [Symbol, Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::Reservation::Status] The status of the reservation.
+
+                # The status of the reservation.
+                #
+                # @see Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::Reservation#status
+                module Status
+                  extend Stigg::Internal::Type::Enum
+
+                  ACTIVE = :ACTIVE
+                  RELEASED = :RELEASED
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
             end
 
             # @!method self.variants

data/lib/stigg/models/v1/subscription_provision_response.rb

@@ -365,6 +365,30 @@ module Stigg
               #   @return [Time, nil]
               optional :entitlement_updated_at, Time, api_name: :entitlementUpdatedAt
 
+              # @!attribute reservation
+              #   The reservation created by this request, when it asked to reserve credits and
+              #   was granted.
+              #
+              #   @return [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1::Reservation, nil]
+              optional :reservation,
+                       -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1::Reservation },
+                       nil?: true
+
+              # @!attribute reserved
+              #   Credits held by open reservations on active grants. Already included in
+              #   currentUsage, so usageLimit - currentUsage is the available balance.
+              #
+              #   @return [Float, nil]
+              optional :reserved, Float
+
+              # @!attribute reserved_on_expired_grants
+              #   Credits still held by open reservations on grants that expired during the hold.
+              #   They can still be released, but are not part of currentUsage or the balance and
+              #   must not be subtracted from it.
+              #
+              #   @return [Float, nil]
+              optional :reserved_on_expired_grants, Float, api_name: :reservedOnExpiredGrants
+
               # @!attribute usage_period_end
               #   The end date of the current billing period for recurring credit grants.
               #
@@ -377,7 +401,11 @@ module Stigg
               #   @return [Time, nil]
               optional :valid_until, Time, api_name: :validUntil
 
-              # @!method initialize(access_denied_reason:, currency:, current_usage:, is_granted:, type:, usage_limit:, usage_updated_at:, entitlement_updated_at: nil, usage_period_end: nil, valid_until: nil)
+              # @!method initialize(access_denied_reason:, currency:, current_usage:, is_granted:, type:, usage_limit:, usage_updated_at:, entitlement_updated_at: nil, reservation: nil, reserved: nil, reserved_on_expired_grants: nil, usage_period_end: nil, valid_until: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1}
+              #   for more details.
+              #
               #   @param access_denied_reason [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1::AccessDeniedReason, nil]
               #
               #   @param currency [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1::Currency] The currency associated with a credit entitlement.
@@ -394,6 +422,12 @@ module Stigg
               #
               #   @param entitlement_updated_at [Time] Timestamp of the last update to the entitlement grant or configuration.
               #
+              #   @param reservation [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1::Reservation, nil] The reservation created by this request, when it asked to reserve credits and wa
+              #
+              #   @param reserved [Float] Credits held by open reservations on active grants. Already included in currentU
+              #
+              #   @param reserved_on_expired_grants [Float] Credits still held by open reservations on grants that expired during the hold.
+              #
               #   @param usage_period_end [Time] The end date of the current billing period for recurring credit grants.
               #
               #   @param valid_until [Time] The next time the entitlement should be recalculated
@@ -484,6 +518,64 @@ module Stigg
                 # @!method self.values
                 #   @return [Array<Symbol>]
               end
+
+              # @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1#reservation
+              class Reservation < Stigg::Internal::Type::BaseModel
+                # @!attribute id
+                #   The client-provided reservation ID.
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute amount
+                #   The amount of credits held.
+                #
+                #   @return [Float]
+                required :amount, Float
+
+                # @!attribute expires_at
+                #   When the reservation expires. Unreleased credits return to the balance at this
+                #   time.
+                #
+                #   @return [Time]
+                required :expires_at, Time, api_name: :expiresAt
+
+                # @!attribute status
+                #   The status of the reservation.
+                #
+                #   @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1::Reservation::Status]
+                required :status,
+                         enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1::Reservation::Status }
+
+                # @!method initialize(id:, amount:, expires_at:, status:)
+                #   Some parameter documentations has been truncated, see
+                #   {Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1::Reservation}
+                #   for more details.
+                #
+                #   The reservation created by this request, when it asked to reserve credits and
+                #   was granted.
+                #
+                #   @param id [String] The client-provided reservation ID.
+                #
+                #   @param amount [Float] The amount of credits held.
+                #
+                #   @param expires_at [Time] When the reservation expires. Unreleased credits return to the balance at this t
+                #
+                #   @param status [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1::Reservation::Status] The status of the reservation.
+
+                # The status of the reservation.
+                #
+                # @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1::Reservation#status
+                module Status
+                  extend Stigg::Internal::Type::Enum
+
+                  ACTIVE = :ACTIVE
+                  RELEASED = :RELEASED
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
             end
 
             # @!method self.variants

data/lib/stigg/models/v1_beta/customers/entitlement_check_response.rb

@@ -377,6 +377,30 @@ module Stigg
               #   @return [Time, nil]
               optional :entitlement_updated_at, Time, api_name: :entitlementUpdatedAt
 
+              # @!attribute reservation
+              #   The reservation created by this request, when it asked to reserve credits and
+              #   was granted.
+              #
+              #   @return [Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit::Reservation, nil]
+              optional :reservation,
+                       -> { Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit::Reservation },
+                       nil?: true
+
+              # @!attribute reserved
+              #   Credits held by open reservations on active grants. Already included in
+              #   currentUsage, so usageLimit - currentUsage is the available balance.
+              #
+              #   @return [Float, nil]
+              optional :reserved, Float
+
+              # @!attribute reserved_on_expired_grants
+              #   Credits still held by open reservations on grants that expired during the hold.
+              #   They can still be released, but are not part of currentUsage or the balance and
+              #   must not be subtracted from it.
+              #
+              #   @return [Float, nil]
+              optional :reserved_on_expired_grants, Float, api_name: :reservedOnExpiredGrants
+
               # @!attribute usage_period_end
               #   The end date of the current billing period for recurring credit grants.
               #
@@ -389,7 +413,7 @@ module Stigg
               #   @return [Time, nil]
               optional :valid_until, Time, api_name: :validUntil
 
-              # @!method initialize(access_denied_reason:, currency:, current_usage:, is_granted:, usage_limit:, usage_updated_at:, chains: nil, entitlement_updated_at: nil, usage_period_end: nil, valid_until: nil, type: :CREDIT)
+              # @!method initialize(access_denied_reason:, currency:, current_usage:, is_granted:, usage_limit:, usage_updated_at:, chains: nil, entitlement_updated_at: nil, reservation: nil, reserved: nil, reserved_on_expired_grants: nil, usage_period_end: nil, valid_until: nil, type: :CREDIT)
               #   Some parameter documentations has been truncated, see
               #   {Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit} for
               #   more details.
@@ -412,6 +436,12 @@ module Stigg
               #
               #   @param entitlement_updated_at [Time] Timestamp of the last update to the entitlement grant or configuration.
               #
+              #   @param reservation [Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit::Reservation, nil] The reservation created by this request, when it asked to reserve credits and wa
+              #
+              #   @param reserved [Float] Credits held by open reservations on active grants. Already included in currentU
+              #
+              #   @param reserved_on_expired_grants [Float] Credits still held by open reservations on grants that expired during the hold.
+              #
               #   @param usage_period_end [Time] The end date of the current billing period for recurring credit grants.
               #
               #   @param valid_until [Time] The next time the entitlement should be recalculated
@@ -546,6 +576,64 @@ module Stigg
                 #
                 #   @param usage_limit [Float, nil] Hard usage limit for this node; null when no assignment is configured.
               end
+
+              # @see Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit#reservation
+              class Reservation < Stigg::Internal::Type::BaseModel
+                # @!attribute id
+                #   The client-provided reservation ID.
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute amount
+                #   The amount of credits held.
+                #
+                #   @return [Float]
+                required :amount, Float
+
+                # @!attribute expires_at
+                #   When the reservation expires. Unreleased credits return to the balance at this
+                #   time.
+                #
+                #   @return [Time]
+                required :expires_at, Time, api_name: :expiresAt
+
+                # @!attribute status
+                #   The status of the reservation.
+                #
+                #   @return [Symbol, Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit::Reservation::Status]
+                required :status,
+                         enum: -> { Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit::Reservation::Status }
+
+                # @!method initialize(id:, amount:, expires_at:, status:)
+                #   Some parameter documentations has been truncated, see
+                #   {Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit::Reservation}
+                #   for more details.
+                #
+                #   The reservation created by this request, when it asked to reserve credits and
+                #   was granted.
+                #
+                #   @param id [String] The client-provided reservation ID.
+                #
+                #   @param amount [Float] The amount of credits held.
+                #
+                #   @param expires_at [Time] When the reservation expires. Unreleased credits return to the balance at this t
+                #
+                #   @param status [Symbol, Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit::Reservation::Status] The status of the reservation.
+
+                # The status of the reservation.
+                #
+                # @see Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit::Reservation#status
+                module Status
+                  extend Stigg::Internal::Type::Enum
+
+                  ACTIVE = :ACTIVE
+                  RELEASED = :RELEASED
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
             end
 
             # @!method self.variants

data/lib/stigg/resources/v1/credits.rb

@@ -71,7 +71,7 @@ module Stigg
         #
         # @param end_date [Time] Query param: End date for the credit usage time range (ISO 8601). Defaults to no
         #
-        # @param group_by [String] Query param: Comma-separated list of feature dimension keys to group usage serie
+        # @param group_by [String] Query param: Comma-separated list of keys to group usage series by: up to 3 cust
         #
         # @param limit [Integer] Query param: Maximum number of items to return
         #

data/lib/stigg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stigg
-  VERSION = "0.1.0-beta.56"
+  VERSION = "0.1.0-beta.58"
 end

data/rbi/stigg/models/v1/credit_get_usage_params.rbi

@@ -45,8 +45,10 @@ module Stigg
         sig { params(end_date: Time).void }
         attr_writer :end_date
 
-        # Comma-separated list of feature dimension keys to group usage series by (up to
-        # 3). Each key matches /^[a-zA-Z0-9_$-]+$/
+        # Comma-separated list of keys to group usage series by: up to 3 custom dimension
+        # keys, optionally combined with the reserved key `featureId` to also split each
+        # series by feature (e.g. `featureId,userId`). Each key matches
+        # /^[a-zA-Z0-9_$-]+$/
         sig { returns(T.nilable(String)) }
         attr_reader :group_by
 
@@ -132,8 +134,10 @@ module Stigg
           # End date for the credit usage time range (ISO 8601). Defaults to now when
           # startDate is provided
           end_date: nil,
-          # Comma-separated list of feature dimension keys to group usage series by (up to
-          # 3). Each key matches /^[a-zA-Z0-9_$-]+$/
+          # Comma-separated list of keys to group usage series by: up to 3 custom dimension
+          # keys, optionally combined with the reserved key `featureId` to also split each
+          # series by feature (e.g. `featureId,userId`). Each key matches
+          # /^[a-zA-Z0-9_$-]+$/
           group_by: nil,
           # Maximum number of items to return
           limit: nil,