stigg 0.1.0.pre.beta.62 → 0.1.0.pre.beta.63

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46d996faf77838a7270f65e36183022bf9967e5c097e911a942261ca082cdd9d
-  data.tar.gz: bc985e5c0c934cc3ae392435311b76c0eb74bf426f2c2a75a2a09db92bf5df48
+  metadata.gz: 6c114a3a61416839ea99a2c4c5f98fa95969c19f1c5e622a393ac2e1bba8f3a4
+  data.tar.gz: 54492f3692b1f942b0a98ad32f74c341975da228177ca6d89758ff4df243a432
 SHA512:
-  metadata.gz: dc2b51e86b366ba00337400477ec5a5209e27157d041de0472ebdbe334252de062f312f3d9bfc818f87695d734271cc3a4499fe56d629e0d53a57f3c8103a782
-  data.tar.gz: dd59b1ae13e0ad4edc6cdf4503e0fc8f8e36f766ffed0dd5434bea4a7af06c66c0cdeb1a5a363ac651d285f23a70240e71ed4e8b73932313742eec858289dfa3
+  metadata.gz: 40bb0400981005162f616816e6d5d8ae1827343de4fc2023a8b26301c4b2114d91bf18da1e5f2ec7b837b5b34f8d02183c10bbbee78deda837575df8acb470d2
+  data.tar.gz: 66072f1f337fbf2b6d72dfc1b9c238560b107675750600f62d01cd2bd69703ab2dd8d467cf5654ef52e123c9b07d79e827c5a00b00ef5e4a6cbebd81b24a4d65

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [0.1.0-beta.63](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.62...v0.1.0-beta.63) (2026-10-30)
+
+
+### Features
+
+* **STIGG-9594:** add the v1 governance resources and v1-beta deprecation messages ([dca8ab0](https://github.com/stiggio/stigg-ruby/commit/dca8ab05c289863df048895cd9c3848f679b83cd))
+
+
+### Bug Fixes
+
+* sync OpenAPI spec from stigg-api ([7407bad](https://github.com/stiggio/stigg-ruby/commit/7407bade916d8ef0ff00f38e2424d5d72137b492))
+* sync OpenAPI spec from stigg-api ([dfa506f](https://github.com/stiggio/stigg-ruby/commit/dfa506f71d8be6cd7b8a0733f79a2356a2683ef7))
+* sync OpenAPI spec from stigg-api ([a43c0a9](https://github.com/stiggio/stigg-ruby/commit/a43c0a93ba3c3077db2f54a0faa9786eecddcec8))
+* sync OpenAPI spec from stigg-api ([316bf50](https://github.com/stiggio/stigg-ruby/commit/316bf50276593b429ccc7333e5cb08288b057fda))
+
+
+### Chores
+
+* normalize version.rb to gem prerelease format for stlc codegen ([dc4e82a](https://github.com/stiggio/stigg-ruby/commit/dc4e82a110db751da07d0da17048fa1e29800233))
+
 ## [0.1.0-beta.62](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.61...v0.1.0-beta.62) (2026-10-29)
 
 

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.61"
+gem "stigg", "~> 0.1.0.pre.beta.62"
 ```
 
 <!-- x-release-please-end -->

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

@@ -20,6 +20,14 @@ module Stigg
         #   @return [String, nil]
         optional :currency_id, String
 
+        # @!attribute dimensions
+        #   Attribution map of the entities the usage is attributed to (e.g.
+        #   `dimensions[userId]=u1`). When provided, their governance budgets are checked
+        #   too and the response includes `chains`.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :dimensions, Stigg::Internal::Type::HashOf[String]
+
         # @!attribute feature_id
         #   Feature ID (refId) to check. Mutually exclusive with `currencyId`.
         #
@@ -68,7 +76,8 @@ module Stigg
 
         # @!attribute reserve_amount
         #   Credits to reserve (credit entitlements only). The check is decided and the
-        #   credits held atomically; `requestedUsage` is ignored.
+        #   credits held atomically; `requestedUsage` is ignored. Not supported with
+        #   `dimensions`.
         #
         #   @return [Float, nil]
         optional :reserve_amount, Float
@@ -89,7 +98,7 @@ module Stigg
         #   @return [String, nil]
         optional :x_environment_id, String
 
-        # @!method initialize(id:, currency_id: nil, feature_id: nil, requested_usage: nil, requested_values: nil, reservation_expires_at: nil, reservation_id: nil, reservation_metadata: nil, reservation_ttl_seconds: nil, reserve_amount: nil, resource_id: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
+        # @!method initialize(id:, currency_id: nil, dimensions: nil, feature_id: nil, requested_usage: nil, requested_values: nil, reservation_expires_at: nil, reservation_id: nil, reservation_metadata: nil, reservation_ttl_seconds: nil, reserve_amount: nil, resource_id: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Stigg::Models::V1::CustomerCheckEntitlementParams} for more details.
         #
@@ -97,6 +106,8 @@ module Stigg
         #
         #   @param currency_id [String] Currency ID (refId) to check for credit entitlements. Mutually exclusive with `f
         #
+        #   @param dimensions [Hash{Symbol=>String}] Attribution map of the entities the usage is attributed to (e.g. `dimensions[use
+        #
         #   @param feature_id [String] Feature ID (refId) to check. Mutually exclusive with `currencyId`.
         #
         #   @param requested_usage [Integer] Requested usage amount to evaluate against the entitlement limit (numeric featur

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

@@ -44,6 +44,14 @@ module Stigg
             #   @return [Symbol, :FEATURE]
             required :type, const: :FEATURE
 
+            # @!attribute chains
+            #   Per-entity rollups, one chain per resolved dimension. Omitted when dimensions
+            #   was not provided.
+            #
+            #   @return [Array<Array<Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Feature::Chain>>, nil]
+            optional :chains,
+                     -> { Stigg::Internal::Type::ArrayOf[Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Feature::Chain]] }
+
             # @!attribute current_usage
             #
             #   @return [Float, nil]
@@ -105,7 +113,7 @@ module Stigg
             #   @return [Time, nil]
             optional :valid_until, Time, api_name: :validUntil
 
-            # @!method initialize(access_denied_reason:, is_granted:, current_usage: nil, entitlement_updated_at: nil, feature: nil, has_unlimited_usage: nil, reset_period: nil, usage_limit: nil, usage_period_anchor: nil, usage_period_end: nil, usage_period_start: nil, valid_until: nil, type: :FEATURE)
+            # @!method initialize(access_denied_reason:, is_granted:, chains: nil, current_usage: nil, entitlement_updated_at: nil, feature: nil, has_unlimited_usage: nil, reset_period: nil, usage_limit: nil, usage_period_anchor: nil, usage_period_end: nil, usage_period_start: nil, valid_until: nil, type: :FEATURE)
             #   Some parameter documentations has been truncated, see
             #   {Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Feature} for more
             #   details.
@@ -114,6 +122,8 @@ module Stigg
             #
             #   @param is_granted [Boolean]
             #
+            #   @param chains [Array<Array<Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Feature::Chain>>] Per-entity rollups, one chain per resolved dimension. Omitted when dimensions wa
+            #
             #   @param current_usage [Float]
             #
             #   @param entitlement_updated_at [Time] Timestamp of the last update to the entitlement grant or configuration.
@@ -159,6 +169,58 @@ module Stigg
               #   @return [Array<Symbol>]
             end
 
+            class Chain < Stigg::Internal::Type::BaseModel
+              # @!attribute current_usage
+              #   Amount consumed by this entity in the current cadence period.
+              #
+              #   @return [Float]
+              required :current_usage, Float, api_name: :currentUsage
+
+              # @!attribute entity_id
+              #   External id of the entity within the customer.
+              #
+              #   @return [String]
+              required :entity_id, String, api_name: :entityId
+
+              # @!attribute is_granted
+              #   Whether this node alone permits the requested usage.
+              #
+              #   @return [Boolean]
+              required :is_granted, Stigg::Internal::Type::Boolean, api_name: :isGranted
+
+              # @!attribute scope_entity_ids
+              #   External ids of the entities this budget is scoped to. Empty (`[]`) is the
+              #   node-wide budget; a non-empty set is the dimension-scoped budget that matched
+              #   this request — use it to tell apart multiple budgets on the same entity.
+              #
+              #   @return [Array<String>]
+              required :scope_entity_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :scopeEntityIds
+
+              # @!attribute usage_limit
+              #   Hard usage limit for this node; null when the entity has no entity entitlement.
+              #
+              #   @return [Float, nil]
+              required :usage_limit, Float, api_name: :usageLimit, nil?: true
+
+              # @!method initialize(current_usage:, entity_id:, is_granted:, scope_entity_ids:, usage_limit:)
+              #   Some parameter documentations has been truncated, see
+              #   {Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Feature::Chain} for
+              #   more details.
+              #
+              #   Per-entity governance node — limit and current usage for a single resolved
+              #   entity.
+              #
+              #   @param current_usage [Float] Amount consumed by this entity in the current cadence period.
+              #
+              #   @param entity_id [String] External id of the entity within the customer.
+              #
+              #   @param is_granted [Boolean] Whether this node alone permits the requested usage.
+              #
+              #   @param scope_entity_ids [Array<String>] External ids of the entities this budget is scoped to. Empty (`[]`) is the node-
+              #
+              #   @param usage_limit [Float, nil] Hard usage limit for this node; null when the entity has no entity entitlement.
+            end
+
             # @see Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Feature#feature
             class Feature < Stigg::Internal::Type::BaseModel
               # @!attribute id
@@ -283,6 +345,14 @@ module Stigg
             #   @return [Time]
             required :usage_updated_at, Time, api_name: :usageUpdatedAt
 
+            # @!attribute chains
+            #   Per-entity rollups, one chain per resolved dimension. Omitted when dimensions
+            #   was not provided.
+            #
+            #   @return [Array<Array<Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Chain>>, nil]
+            optional :chains,
+                     -> { Stigg::Internal::Type::ArrayOf[Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Chain]] }
+
             # @!attribute entitlement_updated_at
             #   Timestamp of the last update to the entitlement grant or configuration.
             #
@@ -325,7 +395,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:, entitlement_updated_at: nil, reservation: nil, reserved: nil, reserved_on_expired_grants: 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::V1::CustomerCheckEntitlementResponse::Data::Credit} for more
             #   details.
@@ -342,6 +412,8 @@ module Stigg
             #
             #   @param usage_updated_at [Time] Timestamp of the last update to the credit usage.
             #
+            #   @param chains [Array<Array<Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Chain>>] Per-entity rollups, one chain per resolved dimension. Omitted when dimensions wa
+            #
             #   @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
@@ -433,6 +505,58 @@ module Stigg
               #   @param unit_singular [String, nil] The singular form of the currency unit.
             end
 
+            class Chain < Stigg::Internal::Type::BaseModel
+              # @!attribute current_usage
+              #   Amount consumed by this entity in the current cadence period.
+              #
+              #   @return [Float]
+              required :current_usage, Float, api_name: :currentUsage
+
+              # @!attribute entity_id
+              #   External id of the entity within the customer.
+              #
+              #   @return [String]
+              required :entity_id, String, api_name: :entityId
+
+              # @!attribute is_granted
+              #   Whether this node alone permits the requested usage.
+              #
+              #   @return [Boolean]
+              required :is_granted, Stigg::Internal::Type::Boolean, api_name: :isGranted
+
+              # @!attribute scope_entity_ids
+              #   External ids of the entities this budget is scoped to. Empty (`[]`) is the
+              #   node-wide budget; a non-empty set is the dimension-scoped budget that matched
+              #   this request — use it to tell apart multiple budgets on the same entity.
+              #
+              #   @return [Array<String>]
+              required :scope_entity_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :scopeEntityIds
+
+              # @!attribute usage_limit
+              #   Hard usage limit for this node; null when the entity has no entity entitlement.
+              #
+              #   @return [Float, nil]
+              required :usage_limit, Float, api_name: :usageLimit, nil?: true
+
+              # @!method initialize(current_usage:, entity_id:, is_granted:, scope_entity_ids:, usage_limit:)
+              #   Some parameter documentations has been truncated, see
+              #   {Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit::Chain} for
+              #   more details.
+              #
+              #   Per-entity governance node — limit and current usage for a single resolved
+              #   entity.
+              #
+              #   @param current_usage [Float] Amount consumed by this entity in the current cadence period.
+              #
+              #   @param entity_id [String] External id of the entity within the customer.
+              #
+              #   @param is_granted [Boolean] Whether this node alone permits the requested usage.
+              #
+              #   @param scope_entity_ids [Array<String>] External ids of the entities this budget is scoped to. Empty (`[]`) is the node-
+              #
+              #   @param usage_limit [Float, nil] Hard usage limit for this node; null when the entity has no entity entitlement.
+            end
+
             # @see Stigg::Models::V1::CustomerCheckEntitlementResponse::Data::Credit#reservation
             class Reservation < Stigg::Internal::Type::BaseModel
               # @!attribute id

data/lib/stigg/models/v1/customers/entities/entitlement_list_params.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Customers
+        module Entities
+          # @see Stigg::Resources::V1::Customers::Entities::Entitlements#list
+          class EntitlementListParams < Stigg::Internal::Type::BaseModel
+            extend Stigg::Internal::Type::RequestParameters::Converter
+            include Stigg::Internal::Type::RequestParameters
+
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute after
+            #   Return items that come after this cursor
+            #
+            #   @return [String, nil]
+            optional :after, String
+
+            # @!attribute before
+            #   Return items that come before this cursor
+            #
+            #   @return [String, nil]
+            optional :before, String
+
+            # @!attribute currency_id
+            #   Filter entity entitlements to a specific currency, by its ID. Mutually exclusive
+            #   with `featureId`.
+            #
+            #   @return [String, nil]
+            optional :currency_id, String
+
+            # @!attribute entity_id
+            #   Filter entity entitlements to a specific entity ID
+            #
+            #   @return [String, nil]
+            optional :entity_id, String
+
+            # @!attribute feature_id
+            #   Filter entity entitlements to a specific feature, by its ID. Mutually exclusive
+            #   with `currencyId`.
+            #
+            #   @return [String, nil]
+            optional :feature_id, String
+
+            # @!attribute limit
+            #   Maximum number of items to return
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!attribute x_account_id
+            #
+            #   @return [String, nil]
+            optional :x_account_id, String
+
+            # @!attribute x_environment_id
+            #
+            #   @return [String, nil]
+            optional :x_environment_id, String
+
+            # @!method initialize(id:, after: nil, before: nil, currency_id: nil, entity_id: nil, feature_id: nil, limit: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {Stigg::Models::V1::Customers::Entities::EntitlementListParams} for more
+            #   details.
+            #
+            #   @param id [String]
+            #
+            #   @param after [String] Return items that come after this cursor
+            #
+            #   @param before [String] Return items that come before this cursor
+            #
+            #   @param currency_id [String] Filter entity entitlements to a specific currency, by its ID. Mutually exclusive
+            #
+            #   @param entity_id [String] Filter entity entitlements to a specific entity ID
+            #
+            #   @param feature_id [String] Filter entity entitlements to a specific feature, by its ID. Mutually exclusive
+            #
+            #   @param limit [Integer] Maximum number of items to return
+            #
+            #   @param x_account_id [String]
+            #
+            #   @param x_environment_id [String]
+            #
+            #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/customers/entities/entitlement_list_response.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Customers
+        module Entities
+          # @see Stigg::Resources::V1::Customers::Entities::Entitlements#list
+          class EntitlementListResponse < Stigg::Internal::Type::BaseModel
+            # @!attribute id
+            #   Synthetic UUID identifier — also the cursor anchor for paginated lists
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute cadence
+            #   Usage-reset cadence as an ISO-8601 single-unit duration, e.g. `P1M`, `P30D`,
+            #   `PT1M`.
+            #
+            #   @return [String]
+            required :cadence, String
+
+            # @!attribute created_at
+            #   Timestamp of when the record was created
+            #
+            #   @return [Time]
+            required :created_at, Time, api_name: :createdAt
+
+            # @!attribute entity_id
+            #   The entity ID this entity entitlement is attached to
+            #
+            #   @return [String]
+            required :entity_id, String, api_name: :entityId
+
+            # @!attribute parent_id
+            #   Parent entity ID in the hierarchy, or `null` for a root.
+            #
+            #   @return [String, nil]
+            required :parent_id, String, api_name: :parentId, nil?: true
+
+            # @!attribute scope_entity_ids
+            #   Dimension-scoped sub-limit key: the set of entity IDs this limit applies to.
+            #   Empty is the node-wide limit that always matches; a non-empty set only applies
+            #   when every listed entity is present in the resolved set (order-insensitive).
+            #
+            #   @return [Array<String>]
+            required :scope_entity_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :scopeEntityIds
+
+            # @!attribute updated_at
+            #   Timestamp of when the record was last updated
+            #
+            #   @return [Time]
+            required :updated_at, Time, api_name: :updatedAt
+
+            # @!attribute usage_limit
+            #   Maximum usage allowed within one cadence window
+            #
+            #   @return [Float, nil]
+            required :usage_limit, Float, api_name: :usageLimit, nil?: true
+
+            # @!attribute currency_id
+            #   Currency ID this entity entitlement grants (present when it grants a credit
+            #   currency).
+            #
+            #   @return [String, nil]
+            optional :currency_id, String, api_name: :currencyId
+
+            # @!attribute feature_id
+            #   Feature ID this entity entitlement grants (present when it grants a feature).
+            #
+            #   @return [String, nil]
+            optional :feature_id, String, api_name: :featureId
+
+            # @!method initialize(id:, cadence:, created_at:, entity_id:, parent_id:, scope_entity_ids:, updated_at:, usage_limit:, currency_id: nil, feature_id: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Stigg::Models::V1::Customers::Entities::EntitlementListResponse} for more
+            #   details.
+            #
+            #   An entity entitlement for an entity belonging to a customer. Defines how much of
+            #   the feature or currency the entity may consume (`usageLimit`) and how often the
+            #   counter resets (`cadence`).
+            #
+            #   @param id [String] Synthetic UUID identifier — also the cursor anchor for paginated lists
+            #
+            #   @param cadence [String] Usage-reset cadence as an ISO-8601 single-unit duration, e.g. `P1M`, `P30D`, `PT
+            #
+            #   @param created_at [Time] Timestamp of when the record was created
+            #
+            #   @param entity_id [String] The entity ID this entity entitlement is attached to
+            #
+            #   @param parent_id [String, nil] Parent entity ID in the hierarchy, or `null` for a root.
+            #
+            #   @param scope_entity_ids [Array<String>] Dimension-scoped sub-limit key: the set of entity IDs this limit applies to. Emp
+            #
+            #   @param updated_at [Time] Timestamp of when the record was last updated
+            #
+            #   @param usage_limit [Float, nil] Maximum usage allowed within one cadence window
+            #
+            #   @param currency_id [String] Currency ID this entity entitlement grants (present when it grants a credit curr
+            #
+            #   @param feature_id [String] Feature ID this entity entitlement grants (present when it grants a feature).
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/customers/entities/entitlement_upsert_params.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Customers
+        module Entities
+          # @see Stigg::Resources::V1::Customers::Entities::Entitlements#upsert
+          class EntitlementUpsertParams < Stigg::Internal::Type::BaseModel
+            extend Stigg::Internal::Type::RequestParameters::Converter
+            include Stigg::Internal::Type::RequestParameters
+
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute entity_entitlements
+            #   Entity entitlements to upsert (1–100 per request)
+            #
+            #   @return [Array<Stigg::Models::V1::Customers::Entities::EntitlementUpsertParams::EntityEntitlement>]
+            required :entity_entitlements,
+                     -> {
+                       Stigg::Internal::Type::ArrayOf[Stigg::V1::Customers::Entities::EntitlementUpsertParams::EntityEntitlement]
+                     },
+                     api_name: :entityEntitlements
+
+            # @!attribute x_account_id
+            #
+            #   @return [String, nil]
+            optional :x_account_id, String
+
+            # @!attribute x_environment_id
+            #
+            #   @return [String, nil]
+            optional :x_environment_id, String
+
+            # @!method initialize(id:, entity_entitlements:, x_account_id: nil, x_environment_id: nil, request_options: {})
+            #   @param id [String]
+            #
+            #   @param entity_entitlements [Array<Stigg::Models::V1::Customers::Entities::EntitlementUpsertParams::EntityEntitlement>] Entity entitlements to upsert (1–100 per request)
+            #
+            #   @param x_account_id [String]
+            #
+            #   @param x_environment_id [String]
+            #
+            #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+            class EntityEntitlement < Stigg::Internal::Type::BaseModel
+              # @!attribute entity_id
+              #   The entity ID this entity entitlement is attached to
+              #
+              #   @return [String]
+              required :entity_id, String, api_name: :entityId
+
+              # @!attribute cadence
+              #   Usage-reset cadence (required on create) as an ISO-8601 single-unit duration,
+              #   e.g. `P1M`, `P30D`, `PT1M`.
+              #
+              #   @return [String, nil]
+              optional :cadence, String
+
+              # @!attribute currency_id
+              #   Currency ID this entity entitlement grants (credit limits). Mutually exclusive
+              #   with `featureId`.
+              #
+              #   @return [String, nil]
+              optional :currency_id, String, api_name: :currencyId
+
+              # @!attribute feature_id
+              #   Feature ID this entity entitlement grants. Mutually exclusive with `currencyId`.
+              #
+              #   @return [String, nil]
+              optional :feature_id, String, api_name: :featureId
+
+              # @!attribute parent_id
+              #   Parent entity ID in the hierarchy. Omit to leave the current parent untouched (a
+              #   new node defaults to a root); `null` detaches to a root; an ID sets or changes
+              #   the parent. Reparenting or detaching an existing node is leaf-only; place a
+              #   parent before its children, or in the same batch.
+              #
+              #   @return [String, nil]
+              optional :parent_id, String, api_name: :parentId, nil?: true
+
+              # @!attribute scope_entity_ids
+              #   Dimension-scoped sub-limit: the set of entity IDs this limit applies to
+              #   (order-insensitive, unique, at most 5). Omit or leave empty for the node-wide
+              #   limit.
+              #
+              #   @return [Array<String>, nil]
+              optional :scope_entity_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :scopeEntityIds
+
+              # @!attribute usage_limit
+              #   Maximum usage allowed within one cadence window (required on create)
+              #
+              #   @return [Float, nil]
+              optional :usage_limit, Float, api_name: :usageLimit, nil?: true
+
+              # @!method initialize(entity_id:, cadence: nil, currency_id: nil, feature_id: nil, parent_id: nil, scope_entity_ids: nil, usage_limit: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Stigg::Models::V1::Customers::Entities::EntitlementUpsertParams::EntityEntitlement}
+              #   for more details.
+              #
+              #   A single entity entitlement to create or update. Identify the feature or
+              #   currency with exactly one of `featureId` or `currencyId`. The natural key is the
+              #   `(entityId, featureId or currencyId, scopeEntityIds)` triple. On create both
+              #   `usageLimit` and `cadence` are required; on update they may be omitted
+              #   individually to preserve the existing value.
+              #
+              #   @param entity_id [String] The entity ID this entity entitlement is attached to
+              #
+              #   @param cadence [String] Usage-reset cadence (required on create) as an ISO-8601 single-unit duration, e.
+              #
+              #   @param currency_id [String] Currency ID this entity entitlement grants (credit limits). Mutually exclusive w
+              #
+              #   @param feature_id [String] Feature ID this entity entitlement grants. Mutually exclusive with `currencyId`.
+              #
+              #   @param parent_id [String, nil] Parent entity ID in the hierarchy. Omit to leave the current parent untouched (a
+              #
+              #   @param scope_entity_ids [Array<String>] Dimension-scoped sub-limit: the set of entity IDs this limit applies to (order-i
+              #
+              #   @param usage_limit [Float, nil] Maximum usage allowed within one cadence window (required on create)
+            end
+          end
+        end
+      end
+    end
+  end
+end