stigg 0.1.0.pre.beta.34 → 0.1.0.pre.beta.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80d339977dd4c2a272f750387cdca3877af06c445be9f269c62bf34b3d726d2e
-  data.tar.gz: 2facee5ad32bbf4bac99ab3a42e5dcb2566ccc5d7a985d7c453a9241fd85e9ec
+  metadata.gz: e8174994e13dfa023bdcabd912079e0521b319a6bd861ae13eaab54289c39977
+  data.tar.gz: ffd0b541acbb41ef6430ce8554c766bb58d35521118f25e786f13b299ecf96d8
 SHA512:
-  metadata.gz: 9ebeb2844178122c5a3a3f8cdc23e56a18718b489f3dfab8f494aba9ff25b15d5a287fd43a250d2f9d4b037eb53eb80915e0bc0341dfde8a135a17a817896427
-  data.tar.gz: dc1048e2f992e0f085936490e6a0d7052dafe8a8cb267da25d302e57407bdca07faee084b3beb808e50e71763eec421f48335f545591ae6c8ff8aff1b6cdf654
+  metadata.gz: 9b903f04ba4092e8e7258f8b6bcc4b6b04a4f9b53115e227be333172f4c9848199b514514acceb0b4c73238c2b91324e3187b7cc53689258051709bfca062a3a
+  data.tar.gz: 8296bee9bb201f3cc47fe68f022123e1a208cbc4b9c9668984daa9dd65cd2acb5a1d0028c7d73d6b6fb9dbbe19ce77c0f0fa65f423c04f521e48b932436a2299

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.1.0-beta.36 (2026-07-05)
+
+Full Changelog: [v0.1.0-beta.35...v0.1.0-beta.36](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.35...v0.1.0-beta.36)
+
+### Bug Fixes
+
+* **api:** rename entity type fields to entity_type_id across governance/entities/assignments ([6669a6e](https://github.com/stiggio/stigg-ruby/commit/6669a6eb36df20c1cecb70697e467cf5fd62fadc))
+
+## 0.1.0-beta.35 (2026-07-01)
+
+Full Changelog: [v0.1.0-beta.34...v0.1.0-beta.35](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.34...v0.1.0-beta.35)
+
+### Features
+
+* **api:** add consumption sub-resource to credits ([91984a0](https://github.com/stiggio/stigg-ruby/commit/91984a0134e60ec1b03ed1c0ad34fdbdabea9426))
+
 ## 0.1.0-beta.34 (2026-06-30)
 
 Full Changelog: [v0.1.0-beta.33...v0.1.0-beta.34](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.33...v0.1.0-beta.34)

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

data/lib/stigg/client.rb

@@ -53,7 +53,7 @@ module Stigg
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
     )
-      base_url ||= "https://api.stigg.io"
+      base_url ||= "https://edge.api.stigg.io"
 
       if api_key.nil?
         raise ArgumentError.new("api_key is required, and can be set via environ: \"STIGG_API_KEY\"")

data/lib/stigg/models/v1/credits/consumption_consume_async_params.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Credits
+        # @see Stigg::Resources::V1::Credits::Consumption#consume_async
+        class ConsumptionConsumeAsyncParams < Stigg::Internal::Type::BaseModel
+          extend Stigg::Internal::Type::RequestParameters::Converter
+          include Stigg::Internal::Type::RequestParameters
+
+          # @!attribute consumptions
+          #   The credit consumptions to report (up to 1000)
+          #
+          #   @return [Array<Stigg::Models::V1::Credits::ConsumptionConsumeAsyncParams::Consumption>]
+          required :consumptions,
+                   -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::Credits::ConsumptionConsumeAsyncParams::Consumption] }
+
+          # @!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(consumptions:, x_account_id: nil, x_environment_id: nil, request_options: {})
+          #   @param consumptions [Array<Stigg::Models::V1::Credits::ConsumptionConsumeAsyncParams::Consumption>] The credit consumptions to report (up to 1000)
+          #
+          #   @param x_account_id [String]
+          #
+          #   @param x_environment_id [String]
+          #
+          #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+          class Consumption < Stigg::Internal::Type::BaseModel
+            # @!attribute amount
+            #   The amount of credits to consume
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute currency_id
+            #   The credit currency to consume from (required)
+            #
+            #   @return [String]
+            required :currency_id, String, api_name: :currencyId
+
+            # @!attribute customer_id
+            #   The customer to consume credits from (required)
+            #
+            #   @return [String]
+            required :customer_id, String, api_name: :customerId
+
+            # @!attribute idempotency_key
+            #   A unique key used to deduplicate the consumption (required)
+            #
+            #   @return [String]
+            required :idempotency_key, String, api_name: :idempotencyKey
+
+            # @!attribute created_at
+            #   Optional timestamp the consumption is attributed to
+            #
+            #   @return [Time, nil]
+            optional :created_at, Time, api_name: :createdAt
+
+            # @!attribute dimensions
+            #   Optional dimensions describing the consumption
+            #
+            #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+            optional :dimensions,
+                     -> { Stigg::Internal::Type::HashOf[union: Stigg::V1::Credits::ConsumptionConsumeAsyncParams::Consumption::Dimension] }
+
+            # @!attribute resource_id
+            #   Optional resource the consumption is attributed to
+            #
+            #   @return [String, nil]
+            optional :resource_id, String, api_name: :resourceId
+
+            # @!method initialize(amount:, currency_id:, customer_id:, idempotency_key:, created_at: nil, dimensions: nil, resource_id: nil)
+            #   Request body for consuming credits directly from a wallet
+            #
+            #   @param amount [Float] The amount of credits to consume
+            #
+            #   @param currency_id [String] The credit currency to consume from (required)
+            #
+            #   @param customer_id [String] The customer to consume credits from (required)
+            #
+            #   @param idempotency_key [String] A unique key used to deduplicate the consumption (required)
+            #
+            #   @param created_at [Time] Optional timestamp the consumption is attributed to
+            #
+            #   @param dimensions [Hash{Symbol=>String, Float, Boolean}] Optional dimensions describing the consumption
+            #
+            #   @param resource_id [String] Optional resource the consumption is attributed to
+
+            module Dimension
+              extend Stigg::Internal::Type::Union
+
+              variant String
+
+              variant Float
+
+              variant Stigg::Internal::Type::Boolean
+
+              # @!method self.variants
+              #   @return [Array(String, Float, Boolean)]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/credits/consumption_consume_async_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Credits
+        # @see Stigg::Resources::V1::Credits::Consumption#consume_async
+        class ConsumptionConsumeAsyncResponse < Stigg::Internal::Type::BaseModel
+          # @!attribute data
+          #   Confirmation that the credit consumptions were accepted for processing
+          #
+          #   @return [Object]
+          required :data, Stigg::Internal::Type::Unknown
+
+          # @!method initialize(data:)
+          #   Response object
+          #
+          #   @param data [Object] Confirmation that the credit consumptions were accepted for processing
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/credits/consumption_consume_params.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Credits
+        # @see Stigg::Resources::V1::Credits::Consumption#consume
+        class ConsumptionConsumeParams < Stigg::Internal::Type::BaseModel
+          extend Stigg::Internal::Type::RequestParameters::Converter
+          include Stigg::Internal::Type::RequestParameters
+
+          # @!attribute amount
+          #   The amount of credits to consume
+          #
+          #   @return [Float]
+          required :amount, Float
+
+          # @!attribute currency_id
+          #   The credit currency to consume from (required)
+          #
+          #   @return [String]
+          required :currency_id, String, api_name: :currencyId
+
+          # @!attribute customer_id
+          #   The customer to consume credits from (required)
+          #
+          #   @return [String]
+          required :customer_id, String, api_name: :customerId
+
+          # @!attribute idempotency_key
+          #   A unique key used to deduplicate the consumption (required)
+          #
+          #   @return [String]
+          required :idempotency_key, String, api_name: :idempotencyKey
+
+          # @!attribute created_at
+          #   Optional timestamp the consumption is attributed to
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time, api_name: :createdAt
+
+          # @!attribute dimensions
+          #   Optional dimensions describing the consumption
+          #
+          #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+          optional :dimensions,
+                   -> { Stigg::Internal::Type::HashOf[union: Stigg::V1::Credits::ConsumptionConsumeParams::Dimension] }
+
+          # @!attribute resource_id
+          #   Optional resource the consumption is attributed to
+          #
+          #   @return [String, nil]
+          optional :resource_id, String, api_name: :resourceId
+
+          # @!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(amount:, currency_id:, customer_id:, idempotency_key:, created_at: nil, dimensions: nil, resource_id: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
+          #   @param amount [Float] The amount of credits to consume
+          #
+          #   @param currency_id [String] The credit currency to consume from (required)
+          #
+          #   @param customer_id [String] The customer to consume credits from (required)
+          #
+          #   @param idempotency_key [String] A unique key used to deduplicate the consumption (required)
+          #
+          #   @param created_at [Time] Optional timestamp the consumption is attributed to
+          #
+          #   @param dimensions [Hash{Symbol=>String, Float, Boolean}] Optional dimensions describing the consumption
+          #
+          #   @param resource_id [String] Optional resource the consumption is attributed to
+          #
+          #   @param x_account_id [String]
+          #
+          #   @param x_environment_id [String]
+          #
+          #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+          module Dimension
+            extend Stigg::Internal::Type::Union
+
+            variant String
+
+            variant Float
+
+            variant Stigg::Internal::Type::Boolean
+
+            # @!method self.variants
+            #   @return [Array(String, Float, Boolean)]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/credits/consumption_consume_response.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Credits
+        # @see Stigg::Resources::V1::Credits::Consumption#consume
+        class ConsumptionConsumeResponse < Stigg::Internal::Type::BaseModel
+          # @!attribute data
+          #   Result of a synchronous direct credit consumption
+          #
+          #   @return [Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data]
+          required :data, -> { Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data }
+
+          # @!method initialize(data:)
+          #   Response object
+          #
+          #   @param data [Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data] Result of a synchronous direct credit consumption
+
+          # @see Stigg::Models::V1::Credits::ConsumptionConsumeResponse#data
+          class Data < Stigg::Internal::Type::BaseModel
+            # @!attribute amount
+            #   The amount of credits consumed
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute currency_id
+            #   The credit currency the credits were consumed from
+            #
+            #   @return [String]
+            required :currency_id, String, api_name: :currencyId
+
+            # @!attribute customer_id
+            #   The customer the credits were consumed from
+            #
+            #   @return [String]
+            required :customer_id, String, api_name: :customerId
+
+            # @!attribute timestamp
+            #   The timestamp the consumption was attributed to
+            #
+            #   @return [Time]
+            required :timestamp, Time
+
+            # @!attribute credit
+            #   The optimistic credit balance after consumption (when sync credit consumption is
+            #   enabled)
+            #
+            #   @return [Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data::Credit, nil]
+            optional :credit, -> { Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data::Credit }, nil?: true
+
+            # @!attribute resource_id
+            #   The resource the consumption was attributed to
+            #
+            #   @return [String, nil]
+            optional :resource_id, String, api_name: :resourceId, nil?: true
+
+            # @!method initialize(amount:, currency_id:, customer_id:, timestamp:, credit: nil, resource_id: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data} for more details.
+            #
+            #   Result of a synchronous direct credit consumption
+            #
+            #   @param amount [Float] The amount of credits consumed
+            #
+            #   @param currency_id [String] The credit currency the credits were consumed from
+            #
+            #   @param customer_id [String] The customer the credits were consumed from
+            #
+            #   @param timestamp [Time] The timestamp the consumption was attributed to
+            #
+            #   @param credit [Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data::Credit, nil] The optimistic credit balance after consumption (when sync credit consumption is
+            #
+            #   @param resource_id [String, nil] The resource the consumption was attributed to
+
+            # @see Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data#credit
+            class Credit < Stigg::Internal::Type::BaseModel
+              # @!attribute currency_id
+              #   The credit currency identifier
+              #
+              #   @return [String]
+              required :currency_id, String, api_name: :currencyId
+
+              # @!attribute current_usage
+              #   The credits consumed (optimistic — includes not-yet-reconciled usage)
+              #
+              #   @return [Float]
+              required :current_usage, Float, api_name: :currentUsage
+
+              # @!attribute timestamp
+              #   The grant-version timestamp of this balance, used by the SDK for last-write-wins
+              #   reconciliation
+              #
+              #   @return [Time]
+              required :timestamp, Time
+
+              # @!attribute usage_limit
+              #   The total credits granted
+              #
+              #   @return [Float]
+              required :usage_limit, Float, api_name: :usageLimit
+
+              # @!attribute usage_period_end
+              #   End of the current credit grant period (when recurring credits reset), if
+              #   applicable
+              #
+              #   @return [Time, nil]
+              optional :usage_period_end, Time, api_name: :usagePeriodEnd, nil?: true
+
+              # @!method initialize(currency_id:, current_usage:, timestamp:, usage_limit:, usage_period_end: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data::Credit} for more
+              #   details.
+              #
+              #   The optimistic credit balance after consumption (when sync credit consumption is
+              #   enabled)
+              #
+              #   @param currency_id [String] The credit currency identifier
+              #
+              #   @param current_usage [Float] The credits consumed (optimistic — includes not-yet-reconciled usage)
+              #
+              #   @param timestamp [Time] The grant-version timestamp of this balance, used by the SDK for last-write-wins
+              #
+              #   @param usage_limit [Float] The total credits granted
+              #
+              #   @param usage_period_end [Time, nil] End of the current credit grant period (when recurring credits reset), if applic
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/events/beta/customer_retrieve_governance_response.rb

@@ -47,11 +47,11 @@ module Stigg
               #   @return [String]
               required :entity_id, String, api_name: :entityId
 
-              # @!attribute entity_type
+              # @!attribute entity_type_id
               #   External id of the entity type (e.g. `team`, `user`).
               #
               #   @return [String]
-              required :entity_type, String, api_name: :entityType
+              required :entity_type_id, String, api_name: :entityTypeId
 
               # @!attribute parent_id
               #   External id of the parent entity in the tree; `null` for a root. Use it to
@@ -95,19 +95,19 @@ module Stigg
               required :utilization, Float, nil?: true
 
               # @!attribute currency_id
-              #   The metered currency refId (present when the configured capability is a credit
+              #   The metered currency ID (present when the configured capability is a credit
               #   currency).
               #
               #   @return [String, nil]
               optional :currency_id, String, api_name: :currencyId
 
               # @!attribute feature_id
-              #   The metered feature refId (present when the configured capability is a feature).
+              #   The metered feature ID (present when the configured capability is a feature).
               #
               #   @return [String, nil]
               optional :feature_id, String, api_name: :featureId
 
-              # @!method initialize(cadence:, current_usage:, entity_id:, entity_type:, parent_id:, scope_entity_ids:, usage_limit:, usage_period_end:, usage_period_start:, utilization:, currency_id: nil, feature_id: nil)
+              # @!method initialize(cadence:, current_usage:, entity_id:, entity_type_id:, parent_id:, scope_entity_ids:, usage_limit:, usage_period_end:, usage_period_start:, utilization:, currency_id: nil, feature_id: nil)
               #   Some parameter documentations has been truncated, see
               #   {Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data} for
               #   more details.
@@ -123,7 +123,7 @@ module Stigg
               #
               #   @param entity_id [String] External id of the entity at this node.
               #
-              #   @param entity_type [String] External id of the entity type (e.g. `team`, `user`).
+              #   @param entity_type_id [String] External id of the entity type (e.g. `team`, `user`).
               #
               #   @param parent_id [String, nil] External id of the parent entity in the tree; `null` for a root. Use it to rebui
               #
@@ -137,9 +137,9 @@ module Stigg
               #
               #   @param utilization [Float, nil] `currentUsage / usageLimit` (1 when usageLimit is 0 — always at limit). The cros
               #
-              #   @param currency_id [String] The metered currency refId (present when the configured capability is a credit c
+              #   @param currency_id [String] The metered currency ID (present when the configured capability is a credit curr
               #
-              #   @param feature_id [String] The metered feature refId (present when the configured capability is a feature).
+              #   @param feature_id [String] The metered feature ID (present when the configured capability is a feature).
             end
 
             # @see Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse#pagination

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

@@ -27,13 +27,13 @@ module Stigg
           optional :before, String
 
           # @!attribute capability_id
-          #   Filter assignments to a specific capability refId
+          #   Filter assignments to a specific capability ID
           #
           #   @return [String, nil]
           optional :capability_id, String
 
           # @!attribute entity_id
-          #   Filter assignments to a specific entity refId
+          #   Filter assignments to a specific entity ID
           #
           #   @return [String, nil]
           optional :entity_id, String
@@ -61,9 +61,9 @@ module Stigg
           #
           #   @param before [String] Return items that come before this cursor
           #
-          #   @param capability_id [String] Filter assignments to a specific capability refId
+          #   @param capability_id [String] Filter assignments to a specific capability ID
           #
-          #   @param entity_id [String] Filter assignments to a specific entity refId
+          #   @param entity_id [String] Filter assignments to a specific entity ID
           #
           #   @param limit [Integer] Maximum number of items to return
           #

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

@@ -26,22 +26,21 @@ module Stigg
           required :created_at, Time, api_name: :createdAt
 
           # @!attribute entity_id
-          #   The entity refId this assignment is attached to
+          #   The entity ID this assignment is attached to
           #
           #   @return [String]
           required :entity_id, String, api_name: :entityId
 
           # @!attribute parent_id
-          #   Parent entity refId in the hierarchy, or `null` for a root.
+          #   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-budget key: the set of entity refIds this budget applies
-          #   to. Empty is the node-wide budget that always matches; a non-empty set only
-          #   applies when every listed entity is present in the resolved set
-          #   (order-insensitive).
+          #   Dimension-scoped sub-budget key: the set of entity IDs this budget applies to.
+          #   Empty is the node-wide budget 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
@@ -59,13 +58,13 @@ module Stigg
           required :usage_limit, Float, api_name: :usageLimit, nil?: true
 
           # @!attribute currency_id
-          #   Currency refId this assignment grants (present for credit capabilities).
+          #   Currency ID this assignment grants (present for credit capabilities).
           #
           #   @return [String, nil]
           optional :currency_id, String, api_name: :currencyId
 
           # @!attribute feature_id
-          #   Feature refId this assignment grants (present for feature capabilities).
+          #   Feature ID this assignment grants (present for feature capabilities).
           #
           #   @return [String, nil]
           optional :feature_id, String, api_name: :featureId
@@ -84,19 +83,19 @@ module Stigg
           #
           #   @param created_at [Time] Timestamp of when the record was created
           #
-          #   @param entity_id [String] The entity refId this assignment is attached to
+          #   @param entity_id [String] The entity ID this assignment is attached to
           #
-          #   @param parent_id [String, nil] Parent entity refId in the hierarchy, or `null` for a root.
+          #   @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-budget key: the set of entity refIds this budget applies to
+          #   @param scope_entity_ids [Array<String>] Dimension-scoped sub-budget key: the set of entity IDs this budget applies to. E
           #
           #   @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 refId this assignment grants (present for credit capabilities).
+          #   @param currency_id [String] Currency ID this assignment grants (present for credit capabilities).
           #
-          #   @param feature_id [String] Feature refId this assignment grants (present for feature capabilities).
+          #   @param feature_id [String] Feature ID this assignment grants (present for feature capabilities).
         end
       end
     end

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

@@ -44,7 +44,7 @@ module Stigg
 
           class Assignment < Stigg::Internal::Type::BaseModel
             # @!attribute entity_id
-            #   The entity refId this assignment is attached to
+            #   The entity ID this assignment is attached to
             #
             #   @return [String]
             required :entity_id, String, api_name: :entityId
@@ -57,22 +57,22 @@ module Stigg
             optional :cadence, String
 
             # @!attribute currency_id
-            #   Currency refId this assignment grants (credit budgets). Mutually exclusive with
+            #   Currency ID this assignment grants (credit budgets). Mutually exclusive with
             #   `featureId`.
             #
             #   @return [String, nil]
             optional :currency_id, String, api_name: :currencyId
 
             # @!attribute feature_id
-            #   Feature refId this assignment grants. Mutually exclusive with `currencyId`.
+            #   Feature ID this assignment grants. Mutually exclusive with `currencyId`.
             #
             #   @return [String, nil]
             optional :feature_id, String, api_name: :featureId
 
             # @!attribute parent_id
-            #   Parent entity refId in the hierarchy. Omit to leave the current parent untouched
-            #   (a new node defaults to a root); `null` detaches to a root; a refId sets or
-            #   changes the parent. Reparenting an existing node is leaf-only.
+            #   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 an existing node is leaf-only.
             #
             #   @return [String, nil]
             optional :parent_id, String, api_name: :parentId, nil?: true
@@ -99,15 +99,15 @@ module Stigg
             #   `cadence` are required; on update they may be omitted individually to preserve
             #   the existing value.
             #
-            #   @param entity_id [String] The entity refId this assignment is attached to
+            #   @param entity_id [String] The entity ID this assignment 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 refId this assignment grants (credit budgets). Mutually exclusive with
+            #   @param currency_id [String] Currency ID this assignment grants (credit budgets). Mutually exclusive with `fe
             #
-            #   @param feature_id [String] Feature refId this assignment grants. Mutually exclusive with `currencyId`.
+            #   @param feature_id [String] Feature ID this assignment grants. Mutually exclusive with `currencyId`.
             #
-            #   @param parent_id [String, nil] Parent entity refId in the hierarchy. Omit to leave the current parent untouched
+            #   @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>]
             #