stigg 0.1.0.pre.beta.47 → 0.1.0.pre.beta.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 020c5b0f6825bd95cd814386ed2a551d7135fa0ea2a96f53a6c4564a3a9a8923
-  data.tar.gz: 260f2d1389aa6a7567ebb8545c9cdc533dda3b4deb485d94afc3d8686670ac43
+  metadata.gz: 13642d061536056ffc58668cbd70d03b29d6e674df746bd74fba13ee1ccce7e3
+  data.tar.gz: 94c8ce8e06df686d19bddf9a1fad5c58c66f798a80abbd14e8378fdf9db47a4b
 SHA512:
-  metadata.gz: 873923e4d883e355b560758af8d17d6f8fe18acc21d6bc264b02c1dc8e3e0bf60fd359c2df478a058ac1584f92d8d07fd65b7843a49a019e59f84cd5f2b25265
-  data.tar.gz: 64a568a7b72ba6558a5179cf2a83101958ae2109b2f77e09978c0c6729dd7d1b9bc7cc08cd0f8dd92bd0e8aa55f85cb85bfad9d0c9f92db9f2c1242cd18d7d66
+  metadata.gz: 33fc18b8712deebd52c722b3cfdb4a201907e001187df23eedc830761028d3a6788b0bcae7621a05dcd6612a0b6a245ca8e72f41c7d676aae4e61bc047581a01
+  data.tar.gz: ab1203812f2cb5c673f8d7537be9b2b27b8230db3e9f1584317611fd88456854917ff903debcfea63f5d8c993f96d2f44f85c0faab8fa772498c1642d57efb63

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-beta.48 (2026-08-05)
+
+Full Changelog: [v0.1.0-beta.47...v0.1.0-beta.48](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.47...v0.1.0-beta.48)
+
+### Features
+
+* **api:** add display_name to entities, description to entity_types ([64cb63a](https://github.com/stiggio/stigg-ruby/commit/64cb63ae53c03e6abbba16b1bebcbd25c2d2ca00))
+
 ## 0.1.0-beta.47 (2026-08-05)
 
 Full Changelog: [v0.1.0-beta.46...v0.1.0-beta.47](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.46...v0.1.0-beta.47)

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

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

@@ -29,7 +29,8 @@ module Stigg
             optional :currency_ids, Stigg::Internal::Type::ArrayOf[String]
 
             # @!attribute entity_id_search
-            #   Case-insensitive substring match on the entity id (`%`/`_` matched literally).
+            #   Case-insensitive substring match on the entity id or its display name (`%`/`_`
+            #   matched literally).
             #
             #   @return [String, nil]
             optional :entity_id_search, String
@@ -104,7 +105,7 @@ module Stigg
             #
             #   @param currency_ids [Array<String>] Currency ids to include, repeated per value (e.g. `?currencyIds=credits`). Omit
             #
-            #   @param entity_id_search [String] Case-insensitive substring match on the entity id (`%`/`_` matched literally).
+            #   @param entity_id_search [String] Case-insensitive substring match on the entity id or its display name (`%`/`_` m
             #
             #   @param entity_type_ids [Array<String>] Filter to one or more entity types, repeated per value (e.g. `?entityTypeIds=tea
             #

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

@@ -41,6 +41,13 @@ module Stigg
               #   @return [Float, nil]
               required :current_usage, Float, api_name: :currentUsage, nil?: true
 
+              # @!attribute display_name
+              #   Human-readable name of the entity, or null when none is set (display the entity
+              #   id instead).
+              #
+              #   @return [String, nil]
+              required :display_name, String, api_name: :displayName, nil?: true
+
               # @!attribute entity_id
               #   External id of the entity at this node.
               #
@@ -54,8 +61,10 @@ module Stigg
               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
-              #   rebuild the tree.
+              #   External id of the parent entity in the tree. `null` means the entity is either
+              #   a root or not yet placed in the hierarchy — placement rides on an assignment, so
+              #   an entity with no limits set has no parent yet. Both render at the top level;
+              #   use it to rebuild the tree.
               #
               #   @return [String, nil]
               required :parent_id, String, api_name: :parentId, nil?: true
@@ -74,15 +83,17 @@ module Stigg
               required :usage_limit, Float, api_name: :usageLimit, nil?: true
 
               # @!attribute usage_period_end
-              #   Exclusive end of the cadence period — when usage resets; `null` once the period
-              #   has rolled over.
+              #   Exclusive end of the cadence period in progress now — when usage resets. `null`
+              #   when the node has no usage configuration, or when a stored cadence cannot be
+              #   parsed.
               #
               #   @return [Time, nil]
               required :usage_period_end, Time, api_name: :usagePeriodEnd, nil?: true
 
               # @!attribute usage_period_start
-              #   Start of the cadence period the usage snapshot belongs to; `null` once the
-              #   period has rolled over.
+              #   Start of the cadence period in progress now, derived from the cadence and the
+              #   assignment anchor — it stays correct across a rollover. `null` when the node has
+              #   no usage configuration, or when a stored cadence cannot be parsed.
               #
               #   @return [Time, nil]
               required :usage_period_start, Time, api_name: :usagePeriodStart, nil?: true
@@ -107,7 +118,7 @@ module Stigg
               #   @return [String, nil]
               optional :feature_id, String, api_name: :featureId
 
-              # @!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)
+              # @!method initialize(cadence:, current_usage:, display_name:, 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.
@@ -121,19 +132,21 @@ module Stigg
               #
               #   @param current_usage [Float, nil] Usage consumed in the current cadence period (may lag the live counter by a shor
               #
+              #   @param display_name [String, nil] Human-readable name of the entity, or null when none is set (display the entity
+              #
               #   @param entity_id [String] External id of the entity at this node.
               #
               #   @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
+              #   @param parent_id [String, nil] External id of the parent entity in the tree. `null` means the entity is either
               #
               #   @param scope_entity_ids [Array<String>] The configuration scope (entity ids). Empty is the node-wide configuration; a no
               #
               #   @param usage_limit [Float, nil] Hard usage limit for this node per cadence period.
               #
-              #   @param usage_period_end [Time, nil] Exclusive end of the cadence period — when usage resets; `null` once the period
+              #   @param usage_period_end [Time, nil] Exclusive end of the cadence period in progress now — when usage resets. `null`
               #
-              #   @param usage_period_start [Time, nil] Start of the cadence period the usage snapshot belongs to; `null` once the perio
+              #   @param usage_period_start [Time, nil] Start of the cadence period in progress now, derived from the cadence and the as
               #
               #   @param utilization [Float, nil] `currentUsage / usageLimit` (1 when usageLimit is 0 — always at limit). The cros
               #

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

@@ -24,6 +24,13 @@ module Stigg
           #   @return [Time]
           required :created_at, Time, api_name: :createdAt
 
+          # @!attribute display_name
+          #   Human-readable name for the entity, or null when none is set — in which case
+          #   clients display the entity ID
+          #
+          #   @return [String, nil]
+          required :display_name, String, api_name: :displayName, nil?: true
+
           # @!attribute entity_type_id
           #   The entity type identifier this entity instantiates
           #
@@ -42,7 +49,10 @@ module Stigg
           #   @return [Time]
           required :updated_at, Time, api_name: :updatedAt
 
-          # @!method initialize(id:, archived_at:, created_at:, entity_type_id:, metadata:, updated_at:)
+          # @!method initialize(id:, archived_at:, created_at:, display_name:, entity_type_id:, metadata:, updated_at:)
+          #   Some parameter documentations has been truncated, see
+          #   {Stigg::Models::V1Beta::Customers::EntityListResponse} for more details.
+          #
           #   A stored entity instance tracked by the governance service for a given customer
           #
           #   @param id [String] The unique identifier for the entity
@@ -51,6 +61,8 @@ module Stigg
           #
           #   @param created_at [Time] Timestamp of when the record was created
           #
+          #   @param display_name [String, nil] Human-readable name for the entity, or null when none is set — in which case cli
+          #
           #   @param entity_type_id [String] The entity type identifier this entity instantiates
           #
           #   @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity

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

@@ -37,6 +37,13 @@ module Stigg
             #   @return [Time]
             required :created_at, Time, api_name: :createdAt
 
+            # @!attribute display_name
+            #   Human-readable name for the entity, or null when none is set — in which case
+            #   clients display the entity ID
+            #
+            #   @return [String, nil]
+            required :display_name, String, api_name: :displayName, nil?: true
+
             # @!attribute entity_type_id
             #   The entity type identifier this entity instantiates
             #
@@ -55,7 +62,11 @@ module Stigg
             #   @return [Time]
             required :updated_at, Time, api_name: :updatedAt
 
-            # @!method initialize(id:, archived_at:, created_at:, entity_type_id:, metadata:, updated_at:)
+            # @!method initialize(id:, archived_at:, created_at:, display_name:, entity_type_id:, metadata:, updated_at:)
+            #   Some parameter documentations has been truncated, see
+            #   {Stigg::Models::V1Beta::Customers::EntityRetrieveResponse::Data} for more
+            #   details.
+            #
             #   A stored entity instance tracked by the governance service for a given customer
             #
             #   @param id [String] The unique identifier for the entity
@@ -64,6 +75,8 @@ module Stigg
             #
             #   @param created_at [Time] Timestamp of when the record was created
             #
+            #   @param display_name [String, nil] Human-readable name for the entity, or null when none is set — in which case cli
+            #
             #   @param entity_type_id [String] The entity type identifier this entity instantiates
             #
             #   @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity

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

@@ -49,6 +49,13 @@ module Stigg
             #   @return [String]
             required :id, String
 
+            # @!attribute display_name
+            #   Human-readable name for the entity. Omit to preserve the stored value, or send
+            #   an empty string or null to clear it.
+            #
+            #   @return [String, nil]
+            optional :display_name, String, api_name: :displayName, nil?: true
+
             # @!attribute entity_type_id
             #   The entity type ID this entity instantiates. Required when creating a new
             #   entity; on a re-upsert may be omitted to preserve the existing type. Governance
@@ -64,7 +71,7 @@ module Stigg
             #   @return [Hash{Symbol=>String}, nil]
             optional :metadata, Stigg::Internal::Type::HashOf[String]
 
-            # @!method initialize(id:, entity_type_id: nil, metadata: nil)
+            # @!method initialize(id:, display_name: nil, entity_type_id: nil, metadata: nil)
             #   Some parameter documentations has been truncated, see
             #   {Stigg::Models::V1Beta::Customers::EntityUpsertParams::Entity} for more details.
             #
@@ -72,6 +79,8 @@ module Stigg
             #
             #   @param id [String] The unique identifier for the entity
             #
+            #   @param display_name [String, nil] Human-readable name for the entity. Omit to preserve the stored value, or send a
+            #
             #   @param entity_type_id [String] The entity type ID this entity instantiates. Required when creating a new entity
             #
             #   @param metadata [Hash{Symbol=>String}] Free-form key/value metadata. Patch semantics: empty-string value removes a key,

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

@@ -36,6 +36,13 @@ module Stigg
             #   @return [Time]
             required :created_at, Time, api_name: :createdAt
 
+            # @!attribute display_name
+            #   Human-readable name for the entity, or null when none is set — in which case
+            #   clients display the entity ID
+            #
+            #   @return [String, nil]
+            required :display_name, String, api_name: :displayName, nil?: true
+
             # @!attribute entity_type_id
             #   The entity type identifier this entity instantiates
             #
@@ -54,7 +61,10 @@ module Stigg
             #   @return [Time]
             required :updated_at, Time, api_name: :updatedAt
 
-            # @!method initialize(id:, archived_at:, created_at:, entity_type_id:, metadata:, updated_at:)
+            # @!method initialize(id:, archived_at:, created_at:, display_name:, entity_type_id:, metadata:, updated_at:)
+            #   Some parameter documentations has been truncated, see
+            #   {Stigg::Models::V1Beta::Customers::EntityUpsertResponse::Data} for more details.
+            #
             #   A stored entity instance tracked by the governance service for a given customer
             #
             #   @param id [String] The unique identifier for the entity
@@ -63,6 +73,8 @@ module Stigg
             #
             #   @param created_at [Time] Timestamp of when the record was created
             #
+            #   @param display_name [String, nil] Human-readable name for the entity, or null when none is set — in which case cli
+            #
             #   @param entity_type_id [String] The entity type identifier this entity instantiates
             #
             #   @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity

data/lib/stigg/models/v1_beta/entity_type_list_response.rb

@@ -24,6 +24,13 @@ module Stigg
         #   @return [Time]
         required :created_at, Time, api_name: :createdAt
 
+        # @!attribute description
+        #   What this entity type represents and what it is for governing, or null when none
+        #   is set
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
         # @!attribute display_name
         #   The display name for the entity type
         #
@@ -36,7 +43,7 @@ module Stigg
         #   @return [Time]
         required :updated_at, Time, api_name: :updatedAt
 
-        # @!method initialize(id:, attribution_keys:, created_at:, display_name:, updated_at:)
+        # @!method initialize(id:, attribution_keys:, created_at:, description:, display_name:, updated_at:)
         #   Some parameter documentations has been truncated, see
         #   {Stigg::Models::V1Beta::EntityTypeListResponse} for more details.
         #
@@ -51,6 +58,8 @@ module Stigg
         #
         #   @param created_at [Time] Timestamp of when the record was created
         #
+        #   @param description [String, nil] What this entity type represents and what it is for governing, or null when none
+        #
         #   @param display_name [String] The display name for the entity type
         #
         #   @param updated_at [Time] Timestamp of when the record was last updated

data/lib/stigg/models/v1_beta/entity_type_upsert_params.rb

@@ -53,7 +53,14 @@ module Stigg
           #   @return [String]
           required :display_name, String, api_name: :displayName
 
-          # @!method initialize(id:, attribution_keys:, display_name:)
+          # @!attribute description
+          #   What this entity type represents and what it is for governing. Omit to preserve
+          #   the stored value, or send an empty string or null to clear it.
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!method initialize(id:, attribution_keys:, display_name:, description: nil)
           #   Some parameter documentations has been truncated, see
           #   {Stigg::Models::V1Beta::EntityTypeUpsertParams::Type} for more details.
           #
@@ -64,6 +71,8 @@ module Stigg
           #   @param attribution_keys [Array<String>] Dimension keys used to attribute usage events to instances of this type (e.g. ["
           #
           #   @param display_name [String] The display name for the entity type
+          #
+          #   @param description [String, nil] What this entity type represents and what it is for governing. Omit to preserve
         end
       end
     end

data/lib/stigg/models/v1_beta/entity_type_upsert_response.rb

@@ -36,6 +36,13 @@ module Stigg
           #   @return [Time]
           required :created_at, Time, api_name: :createdAt
 
+          # @!attribute description
+          #   What this entity type represents and what it is for governing, or null when none
+          #   is set
+          #
+          #   @return [String, nil]
+          required :description, String, nil?: true
+
           # @!attribute display_name
           #   The display name for the entity type
           #
@@ -48,7 +55,7 @@ module Stigg
           #   @return [Time]
           required :updated_at, Time, api_name: :updatedAt
 
-          # @!method initialize(id:, attribution_keys:, created_at:, display_name:, updated_at:)
+          # @!method initialize(id:, attribution_keys:, created_at:, description:, display_name:, updated_at:)
           #   Some parameter documentations has been truncated, see
           #   {Stigg::Models::V1Beta::EntityTypeUpsertResponse::Data} for more details.
           #
@@ -63,6 +70,8 @@ module Stigg
           #
           #   @param created_at [Time] Timestamp of when the record was created
           #
+          #   @param description [String, nil] What this entity type represents and what it is for governing, or null when none
+          #
           #   @param display_name [String] The display name for the entity type
           #
           #   @param updated_at [Time] Timestamp of when the record was last updated

data/lib/stigg/resources/v1/events/beta/customers.rb

@@ -24,7 +24,7 @@ module Stigg
             #
             # @param currency_ids [Array<String>] Query param: Currency ids to include, repeated per value (e.g. `?currencyIds=cre
             #
-            # @param entity_id_search [String] Query param: Case-insensitive substring match on the entity id (`%`/`_` matched
+            # @param entity_id_search [String] Query param: Case-insensitive substring match on the entity id or its display na
             #
             # @param entity_type_ids [Array<String>] Query param: Filter to one or more entity types, repeated per value (e.g. `?enti
             #

data/lib/stigg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stigg
-  VERSION = "0.1.0.pre.beta.47"
+  VERSION = "0.1.0.pre.beta.48"
 end

data/rbi/stigg/models/v1/events/beta/customer_retrieve_governance_params.rbi

@@ -35,7 +35,8 @@ module Stigg
             sig { params(currency_ids: T::Array[String]).void }
             attr_writer :currency_ids
 
-            # Case-insensitive substring match on the entity id (`%`/`_` matched literally).
+            # Case-insensitive substring match on the entity id or its display name (`%`/`_`
+            # matched literally).
             sig { returns(T.nilable(String)) }
             attr_reader :entity_id_search
 
@@ -171,7 +172,8 @@ module Stigg
               # Currency ids to include, repeated per value (e.g. `?currencyIds=credits`). Omit
               # both featureIds and currencyIds for tree mode.
               currency_ids: nil,
-              # Case-insensitive substring match on the entity id (`%`/`_` matched literally).
+              # Case-insensitive substring match on the entity id or its display name (`%`/`_`
+              # matched literally).
               entity_id_search: nil,
               # Filter to one or more entity types, repeated per value (e.g.
               # `?entityTypeIds=team&entityTypeIds=user`).

data/rbi/stigg/models/v1/events/beta/customer_retrieve_governance_response.rbi

@@ -87,6 +87,11 @@ module Stigg
               sig { returns(T.nilable(Float)) }
               attr_accessor :current_usage
 
+              # Human-readable name of the entity, or null when none is set (display the entity
+              # id instead).
+              sig { returns(T.nilable(String)) }
+              attr_accessor :display_name
+
               # External id of the entity at this node.
               sig { returns(String) }
               attr_accessor :entity_id
@@ -95,8 +100,10 @@ module Stigg
               sig { returns(String) }
               attr_accessor :entity_type_id
 
-              # External id of the parent entity in the tree; `null` for a root. Use it to
-              # rebuild the tree.
+              # External id of the parent entity in the tree. `null` means the entity is either
+              # a root or not yet placed in the hierarchy — placement rides on an assignment, so
+              # an entity with no limits set has no parent yet. Both render at the top level;
+              # use it to rebuild the tree.
               sig { returns(T.nilable(String)) }
               attr_accessor :parent_id
 
@@ -109,13 +116,15 @@ module Stigg
               sig { returns(T.nilable(Float)) }
               attr_accessor :usage_limit
 
-              # Exclusive end of the cadence period — when usage resets; `null` once the period
-              # has rolled over.
+              # Exclusive end of the cadence period in progress now — when usage resets. `null`
+              # when the node has no usage configuration, or when a stored cadence cannot be
+              # parsed.
               sig { returns(T.nilable(Time)) }
               attr_accessor :usage_period_end
 
-              # Start of the cadence period the usage snapshot belongs to; `null` once the
-              # period has rolled over.
+              # Start of the cadence period in progress now, derived from the cadence and the
+              # assignment anchor — it stays correct across a rollover. `null` when the node has
+              # no usage configuration, or when a stored cadence cannot be parsed.
               sig { returns(T.nilable(Time)) }
               attr_accessor :usage_period_start
 
@@ -147,6 +156,7 @@ module Stigg
                 params(
                   cadence: T.nilable(String),
                   current_usage: T.nilable(Float),
+                  display_name: T.nilable(String),
                   entity_id: String,
                   entity_type_id: String,
                   parent_id: T.nilable(String),
@@ -166,23 +176,30 @@ module Stigg
                 # Usage consumed in the current cadence period (may lag the live counter by a
                 # short interval).
                 current_usage:,
+                # Human-readable name of the entity, or null when none is set (display the entity
+                # id instead).
+                display_name:,
                 # External id of the entity at this node.
                 entity_id:,
                 # External id of the entity type (e.g. `team`, `user`).
                 entity_type_id:,
-                # External id of the parent entity in the tree; `null` for a root. Use it to
-                # rebuild the tree.
+                # External id of the parent entity in the tree. `null` means the entity is either
+                # a root or not yet placed in the hierarchy — placement rides on an assignment, so
+                # an entity with no limits set has no parent yet. Both render at the top level;
+                # use it to rebuild the tree.
                 parent_id:,
                 # The configuration scope (entity ids). Empty is the node-wide configuration; a
                 # non-empty set is a dimension-scoped sub-configuration.
                 scope_entity_ids:,
                 # Hard usage limit for this node per cadence period.
                 usage_limit:,
-                # Exclusive end of the cadence period — when usage resets; `null` once the period
-                # has rolled over.
+                # Exclusive end of the cadence period in progress now — when usage resets. `null`
+                # when the node has no usage configuration, or when a stored cadence cannot be
+                # parsed.
                 usage_period_end:,
-                # Start of the cadence period the usage snapshot belongs to; `null` once the
-                # period has rolled over.
+                # Start of the cadence period in progress now, derived from the cadence and the
+                # assignment anchor — it stays correct across a rollover. `null` when the node has
+                # no usage configuration, or when a stored cadence cannot be parsed.
                 usage_period_start:,
                 # `currentUsage / usageLimit` (1 when usageLimit is 0 — always at limit). The
                 # cross-capability-safe sort key.
@@ -200,6 +217,7 @@ module Stigg
                   {
                     cadence: T.nilable(String),
                     current_usage: T.nilable(Float),
+                    display_name: T.nilable(String),
                     entity_id: String,
                     entity_type_id: String,
                     parent_id: T.nilable(String),

data/rbi/stigg/models/v1_beta/customers/entity_list_response.rbi

@@ -25,6 +25,11 @@ module Stigg
           sig { returns(Time) }
           attr_accessor :created_at
 
+          # Human-readable name for the entity, or null when none is set — in which case
+          # clients display the entity ID
+          sig { returns(T.nilable(String)) }
+          attr_accessor :display_name
+
           # The entity type identifier this entity instantiates
           sig { returns(String) }
           attr_accessor :entity_type_id
@@ -43,6 +48,7 @@ module Stigg
               id: String,
               archived_at: T.nilable(Time),
               created_at: Time,
+              display_name: T.nilable(String),
               entity_type_id: String,
               metadata: T::Hash[Symbol, String],
               updated_at: Time
@@ -55,6 +61,9 @@ module Stigg
             archived_at:,
             # Timestamp of when the record was created
             created_at:,
+            # Human-readable name for the entity, or null when none is set — in which case
+            # clients display the entity ID
+            display_name:,
             # The entity type identifier this entity instantiates
             entity_type_id:,
             # Free-form key/value metadata attached to the entity
@@ -70,6 +79,7 @@ module Stigg
                 id: String,
                 archived_at: T.nilable(Time),
                 created_at: Time,
+                display_name: T.nilable(String),
                 entity_type_id: String,
                 metadata: T::Hash[Symbol, String],
                 updated_at: Time

data/rbi/stigg/models/v1_beta/customers/entity_retrieve_response.rbi

@@ -74,6 +74,11 @@ module Stigg
             sig { returns(Time) }
             attr_accessor :created_at
 
+            # Human-readable name for the entity, or null when none is set — in which case
+            # clients display the entity ID
+            sig { returns(T.nilable(String)) }
+            attr_accessor :display_name
+
             # The entity type identifier this entity instantiates
             sig { returns(String) }
             attr_accessor :entity_type_id
@@ -92,6 +97,7 @@ module Stigg
                 id: String,
                 archived_at: T.nilable(Time),
                 created_at: Time,
+                display_name: T.nilable(String),
                 entity_type_id: String,
                 metadata: T::Hash[Symbol, String],
                 updated_at: Time
@@ -104,6 +110,9 @@ module Stigg
               archived_at:,
               # Timestamp of when the record was created
               created_at:,
+              # Human-readable name for the entity, or null when none is set — in which case
+              # clients display the entity ID
+              display_name:,
               # The entity type identifier this entity instantiates
               entity_type_id:,
               # Free-form key/value metadata attached to the entity
@@ -119,6 +128,7 @@ module Stigg
                   id: String,
                   archived_at: T.nilable(Time),
                   created_at: Time,
+                  display_name: T.nilable(String),
                   entity_type_id: String,
                   metadata: T::Hash[Symbol, String],
                   updated_at: Time

data/rbi/stigg/models/v1_beta/customers/entity_upsert_params.rbi

@@ -91,6 +91,11 @@ module Stigg
             sig { returns(String) }
             attr_accessor :id
 
+            # Human-readable name for the entity. Omit to preserve the stored value, or send
+            # an empty string or null to clear it.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :display_name
+
             # The entity type ID this entity instantiates. Required when creating a new
             # entity; on a re-upsert may be omitted to preserve the existing type. Governance
             # returns 400 if missing on create.
@@ -112,6 +117,7 @@ module Stigg
             sig do
               params(
                 id: String,
+                display_name: T.nilable(String),
                 entity_type_id: String,
                 metadata: T::Hash[Symbol, String]
               ).returns(T.attached_class)
@@ -119,6 +125,9 @@ module Stigg
             def self.new(
               # The unique identifier for the entity
               id:,
+              # Human-readable name for the entity. Omit to preserve the stored value, or send
+              # an empty string or null to clear it.
+              display_name: nil,
               # The entity type ID this entity instantiates. Required when creating a new
               # entity; on a re-upsert may be omitted to preserve the existing type. Governance
               # returns 400 if missing on create.
@@ -133,6 +142,7 @@ module Stigg
               override.returns(
                 {
                   id: String,
+                  display_name: T.nilable(String),
                   entity_type_id: String,
                   metadata: T::Hash[Symbol, String]
                 }

data/rbi/stigg/models/v1_beta/customers/entity_upsert_response.rbi

@@ -68,6 +68,11 @@ module Stigg
             sig { returns(Time) }
             attr_accessor :created_at
 
+            # Human-readable name for the entity, or null when none is set — in which case
+            # clients display the entity ID
+            sig { returns(T.nilable(String)) }
+            attr_accessor :display_name
+
             # The entity type identifier this entity instantiates
             sig { returns(String) }
             attr_accessor :entity_type_id
@@ -86,6 +91,7 @@ module Stigg
                 id: String,
                 archived_at: T.nilable(Time),
                 created_at: Time,
+                display_name: T.nilable(String),
                 entity_type_id: String,
                 metadata: T::Hash[Symbol, String],
                 updated_at: Time
@@ -98,6 +104,9 @@ module Stigg
               archived_at:,
               # Timestamp of when the record was created
               created_at:,
+              # Human-readable name for the entity, or null when none is set — in which case
+              # clients display the entity ID
+              display_name:,
               # The entity type identifier this entity instantiates
               entity_type_id:,
               # Free-form key/value metadata attached to the entity
@@ -113,6 +122,7 @@ module Stigg
                   id: String,
                   archived_at: T.nilable(Time),
                   created_at: Time,
+                  display_name: T.nilable(String),
                   entity_type_id: String,
                   metadata: T::Hash[Symbol, String],
                   updated_at: Time

data/rbi/stigg/models/v1_beta/entity_type_list_response.rbi

@@ -25,6 +25,11 @@ module Stigg
         sig { returns(Time) }
         attr_accessor :created_at
 
+        # What this entity type represents and what it is for governing, or null when none
+        # is set
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
         # The display name for the entity type
         sig { returns(String) }
         attr_accessor :display_name
@@ -42,6 +47,7 @@ module Stigg
             id: String,
             attribution_keys: T::Array[String],
             created_at: Time,
+            description: T.nilable(String),
             display_name: String,
             updated_at: Time
           ).returns(T.attached_class)
@@ -54,6 +60,9 @@ module Stigg
           attribution_keys:,
           # Timestamp of when the record was created
           created_at:,
+          # What this entity type represents and what it is for governing, or null when none
+          # is set
+          description:,
           # The display name for the entity type
           display_name:,
           # Timestamp of when the record was last updated
@@ -67,6 +76,7 @@ module Stigg
               id: String,
               attribution_keys: T::Array[String],
               created_at: Time,
+              description: T.nilable(String),
               display_name: String,
               updated_at: Time
             }

data/rbi/stigg/models/v1_beta/entity_type_upsert_params.rbi

@@ -84,12 +84,18 @@ module Stigg
           sig { returns(String) }
           attr_accessor :display_name
 
+          # What this entity type represents and what it is for governing. Omit to preserve
+          # the stored value, or send an empty string or null to clear it.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
           # A single entity type definition.
           sig do
             params(
               id: String,
               attribution_keys: T::Array[String],
-              display_name: String
+              display_name: String,
+              description: T.nilable(String)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -99,7 +105,10 @@ module Stigg
             # ["orgId"]). Empty array means no attribution.
             attribution_keys:,
             # The display name for the entity type
-            display_name:
+            display_name:,
+            # What this entity type represents and what it is for governing. Omit to preserve
+            # the stored value, or send an empty string or null to clear it.
+            description: nil
           )
           end
 
@@ -108,7 +117,8 @@ module Stigg
               {
                 id: String,
                 attribution_keys: T::Array[String],
-                display_name: String
+                display_name: String,
+                description: T.nilable(String)
               }
             )
           end

data/rbi/stigg/models/v1_beta/entity_type_upsert_response.rbi

@@ -64,6 +64,11 @@ module Stigg
           sig { returns(Time) }
           attr_accessor :created_at
 
+          # What this entity type represents and what it is for governing, or null when none
+          # is set
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
           # The display name for the entity type
           sig { returns(String) }
           attr_accessor :display_name
@@ -81,6 +86,7 @@ module Stigg
               id: String,
               attribution_keys: T::Array[String],
               created_at: Time,
+              description: T.nilable(String),
               display_name: String,
               updated_at: Time
             ).returns(T.attached_class)
@@ -93,6 +99,9 @@ module Stigg
             attribution_keys:,
             # Timestamp of when the record was created
             created_at:,
+            # What this entity type represents and what it is for governing, or null when none
+            # is set
+            description:,
             # The display name for the entity type
             display_name:,
             # Timestamp of when the record was last updated
@@ -106,6 +115,7 @@ module Stigg
                 id: String,
                 attribution_keys: T::Array[String],
                 created_at: Time,
+                description: T.nilable(String),
                 display_name: String,
                 updated_at: Time
               }

data/rbi/stigg/resources/v1/events/beta/customers.rbi

@@ -42,8 +42,8 @@ module Stigg
               # Query param: Currency ids to include, repeated per value (e.g.
               # `?currencyIds=credits`). Omit both featureIds and currencyIds for tree mode.
               currency_ids: nil,
-              # Query param: Case-insensitive substring match on the entity id (`%`/`_` matched
-              # literally).
+              # Query param: Case-insensitive substring match on the entity id or its display
+              # name (`%`/`_` matched literally).
               entity_id_search: nil,
               # Query param: Filter to one or more entity types, repeated per value (e.g.
               # `?entityTypeIds=team&entityTypeIds=user`).

data/sig/stigg/models/v1/events/beta/customer_retrieve_governance_response.rbs

@@ -28,6 +28,7 @@ module Stigg
               {
                 cadence: String?,
                 current_usage: Float?,
+                display_name: String?,
                 entity_id: String,
                 entity_type_id: String,
                 parent_id: String?,
@@ -45,6 +46,8 @@ module Stigg
 
               attr_accessor current_usage: Float?
 
+              attr_accessor display_name: String?
+
               attr_accessor entity_id: String
 
               attr_accessor entity_type_id: String
@@ -72,6 +75,7 @@ module Stigg
               def initialize: (
                 cadence: String?,
                 current_usage: Float?,
+                display_name: String?,
                 entity_id: String,
                 entity_type_id: String,
                 parent_id: String?,
@@ -87,6 +91,7 @@ module Stigg
               def to_hash: -> {
                 cadence: String?,
                 current_usage: Float?,
+                display_name: String?,
                 entity_id: String,
                 entity_type_id: String,
                 parent_id: String?,

data/sig/stigg/models/v1_beta/customers/entity_list_response.rbs

@@ -7,6 +7,7 @@ module Stigg
             id: String,
             archived_at: Time?,
             created_at: Time,
+            display_name: String?,
             entity_type_id: String,
             metadata: ::Hash[Symbol, String],
             updated_at: Time
@@ -19,6 +20,8 @@ module Stigg
 
           attr_accessor created_at: Time
 
+          attr_accessor display_name: String?
+
           attr_accessor entity_type_id: String
 
           attr_accessor metadata: ::Hash[Symbol, String]
@@ -29,6 +32,7 @@ module Stigg
             id: String,
             archived_at: Time?,
             created_at: Time,
+            display_name: String?,
             entity_type_id: String,
             metadata: ::Hash[Symbol, String],
             updated_at: Time
@@ -38,6 +42,7 @@ module Stigg
             id: String,
             archived_at: Time?,
             created_at: Time,
+            display_name: String?,
             entity_type_id: String,
             metadata: ::Hash[Symbol, String],
             updated_at: Time

data/sig/stigg/models/v1_beta/customers/entity_retrieve_response.rbs

@@ -23,6 +23,7 @@ module Stigg
               id: String,
               archived_at: Time?,
               created_at: Time,
+              display_name: String?,
               entity_type_id: String,
               metadata: ::Hash[Symbol, String],
               updated_at: Time
@@ -35,6 +36,8 @@ module Stigg
 
             attr_accessor created_at: Time
 
+            attr_accessor display_name: String?
+
             attr_accessor entity_type_id: String
 
             attr_accessor metadata: ::Hash[Symbol, String]
@@ -45,6 +48,7 @@ module Stigg
               id: String,
               archived_at: Time?,
               created_at: Time,
+              display_name: String?,
               entity_type_id: String,
               metadata: ::Hash[Symbol, String],
               updated_at: Time
@@ -54,6 +58,7 @@ module Stigg
               id: String,
               archived_at: Time?,
               created_at: Time,
+              display_name: String?,
               entity_type_id: String,
               metadata: ::Hash[Symbol, String],
               updated_at: Time

data/sig/stigg/models/v1_beta/customers/entity_upsert_params.rbs

@@ -46,6 +46,7 @@ module Stigg
           type entity =
             {
               id: String,
+              display_name: String?,
               entity_type_id: String,
               metadata: ::Hash[Symbol, String]
             }
@@ -53,6 +54,8 @@ module Stigg
           class Entity < Stigg::Internal::Type::BaseModel
             attr_accessor id: String
 
+            attr_accessor display_name: String?
+
             attr_reader entity_type_id: String?
 
             def entity_type_id=: (String) -> String
@@ -63,12 +66,14 @@ module Stigg
 
             def initialize: (
               id: String,
+              ?display_name: String?,
               ?entity_type_id: String,
               ?metadata: ::Hash[Symbol, String]
             ) -> void
 
             def to_hash: -> {
               id: String,
+              display_name: String?,
               entity_type_id: String,
               metadata: ::Hash[Symbol, String]
             }

data/sig/stigg/models/v1_beta/customers/entity_upsert_response.rbs

@@ -23,6 +23,7 @@ module Stigg
               id: String,
               archived_at: Time?,
               created_at: Time,
+              display_name: String?,
               entity_type_id: String,
               metadata: ::Hash[Symbol, String],
               updated_at: Time
@@ -35,6 +36,8 @@ module Stigg
 
             attr_accessor created_at: Time
 
+            attr_accessor display_name: String?
+
             attr_accessor entity_type_id: String
 
             attr_accessor metadata: ::Hash[Symbol, String]
@@ -45,6 +48,7 @@ module Stigg
               id: String,
               archived_at: Time?,
               created_at: Time,
+              display_name: String?,
               entity_type_id: String,
               metadata: ::Hash[Symbol, String],
               updated_at: Time
@@ -54,6 +58,7 @@ module Stigg
               id: String,
               archived_at: Time?,
               created_at: Time,
+              display_name: String?,
               entity_type_id: String,
               metadata: ::Hash[Symbol, String],
               updated_at: Time

data/sig/stigg/models/v1_beta/entity_type_list_response.rbs

@@ -6,6 +6,7 @@ module Stigg
           id: String,
           attribution_keys: ::Array[String],
           created_at: Time,
+          description: String?,
           display_name: String,
           updated_at: Time
         }
@@ -17,6 +18,8 @@ module Stigg
 
         attr_accessor created_at: Time
 
+        attr_accessor description: String?
+
         attr_accessor display_name: String
 
         attr_accessor updated_at: Time
@@ -25,6 +28,7 @@ module Stigg
           id: String,
           attribution_keys: ::Array[String],
           created_at: Time,
+          description: String?,
           display_name: String,
           updated_at: Time
         ) -> void
@@ -33,6 +37,7 @@ module Stigg
           id: String,
           attribution_keys: ::Array[String],
           created_at: Time,
+          description: String?,
           display_name: String,
           updated_at: Time
         }

data/sig/stigg/models/v1_beta/entity_type_upsert_params.rbs

@@ -41,7 +41,8 @@ module Stigg
           {
             id: String,
             attribution_keys: ::Array[String],
-            display_name: String
+            display_name: String,
+            description: String?
           }
 
         class Type < Stigg::Internal::Type::BaseModel
@@ -51,16 +52,20 @@ module Stigg
 
           attr_accessor display_name: String
 
+          attr_accessor description: String?
+
           def initialize: (
             id: String,
             attribution_keys: ::Array[String],
-            display_name: String
+            display_name: String,
+            ?description: String?
           ) -> void
 
           def to_hash: -> {
             id: String,
             attribution_keys: ::Array[String],
-            display_name: String
+            display_name: String,
+            description: String?
           }
         end
       end

data/sig/stigg/models/v1_beta/entity_type_upsert_response.rbs

@@ -20,6 +20,7 @@ module Stigg
             id: String,
             attribution_keys: ::Array[String],
             created_at: Time,
+            description: String?,
             display_name: String,
             updated_at: Time
           }
@@ -31,6 +32,8 @@ module Stigg
 
           attr_accessor created_at: Time
 
+          attr_accessor description: String?
+
           attr_accessor display_name: String
 
           attr_accessor updated_at: Time
@@ -39,6 +42,7 @@ module Stigg
             id: String,
             attribution_keys: ::Array[String],
             created_at: Time,
+            description: String?,
             display_name: String,
             updated_at: Time
           ) -> void
@@ -47,6 +51,7 @@ module Stigg
             id: String,
             attribution_keys: ::Array[String],
             created_at: Time,
+            description: String?,
             display_name: String,
             updated_at: Time
           }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stigg
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.beta.47
+  version: 0.1.0.pre.beta.48
 platform: ruby
 authors:
 - Stigg