stigg 0.1.0.pre.beta.7 → 0.1.0.pre.beta.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a5afda4b84c747345fd0affbfa58318e56e965c683bfd53e94e3bbdf8884daf
-  data.tar.gz: 0d4bb82f404f308266322d8fd7def902240b385638933465514ba38bf06cec83
+  metadata.gz: 70f15c897729ecad045000897480e8eb6737149b27d193d81043bf0fb911ce29
+  data.tar.gz: 769b53256d12fb857e847ddbec044e1e8ffb0f6516309091949105f7470617c8
 SHA512:
-  metadata.gz: b6e8104b0d1e7248e4d3149c918cd0928cb9c14fa25ad1240afe06c8e98b2e60d85a4bad2614775c500190fab64808f09749f1f8bb911b129c7d6ecefb72bc27
-  data.tar.gz: fc2a4d76b2e6be6025851e6df11d3194e87ce195f71831498cdb49a93ddfe5bc3a0f172c89f537ff79a428a802a9f66bb604480b5d486745fc2bde1852f98a4f
+  metadata.gz: fd0793b0bac6d6fb76e48c484a91d1b987665aac31a4ce5782e02acf94f044ebc50275df08406a33d3c98ab68bda1fd4704fe1c988b36e1f396ee94574dd423f
+  data.tar.gz: 21763c72383e15868a6919d4b4734e623ff1194a7095ab3b12ecd08ac9bd2781cb01c2464d3ed0164ba6f2abd140b239ffd3d86318a8dbd586ec2b0e8cf66678

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-beta.8 (2026-05-25)
+
+Full Changelog: [v0.1.0-beta.7...v0.1.0-beta.8](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.7...v0.1.0-beta.8)
+
+### Features
+
+* **api:** add entities resource with retrieve/list/archive/unarchive/upsert methods ([7ed5106](https://github.com/stiggio/stigg-ruby/commit/7ed5106db56d60583655a9750cf2a3e58c9fb3c7))
+
 ## 0.1.0-beta.7 (2026-05-24)
 
 Full Changelog: [v0.1.0-beta.6...v0.1.0-beta.7](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.6...v0.1.0-beta.7)

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

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1Beta
+      # @see Stigg::Resources::V1Beta::Entities#archive
+      class EntityArchiveParams < Stigg::Internal::Type::BaseModel
+        extend Stigg::Internal::Type::RequestParameters::Converter
+        include Stigg::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute ids
+        #   Entity identifiers to act on
+        #
+        #   @return [Array<String>]
+        required :ids, Stigg::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, ids:, request_options: {})
+        #   @param id [String]
+        #
+        #   @param ids [Array<String>] Entity identifiers to act on
+        #
+        #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1Beta
+      # @see Stigg::Resources::V1Beta::Entities#archive
+      class EntityArchiveResponse < Stigg::Internal::Type::BaseModel
+        # @!attribute data
+        #   List of entity identifiers that were acted on
+        #
+        #   @return [Stigg::Models::V1Beta::EntityArchiveResponse::Data]
+        required :data, -> { Stigg::Models::V1Beta::EntityArchiveResponse::Data }
+
+        # @!method initialize(data:)
+        #   Wrapped response echoing the ids that were acted on by an archive/unarchive call
+        #
+        #   @param data [Stigg::Models::V1Beta::EntityArchiveResponse::Data] List of entity identifiers that were acted on
+
+        # @see Stigg::Models::V1Beta::EntityArchiveResponse#data
+        class Data < Stigg::Internal::Type::BaseModel
+          # @!attribute ids
+          #   Entity identifiers to act on
+          #
+          #   @return [Array<String>]
+          required :ids, Stigg::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(ids:)
+          #   List of entity identifiers that were acted on
+          #
+          #   @param ids [Array<String>] Entity identifiers to act on
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1Beta
+      # @see Stigg::Resources::V1Beta::Entities#list
+      class EntityListParams < 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 include_archived
+        #   Whether to include archived entities. One of: true, false
+        #
+        #   @return [Symbol, Stigg::Models::V1Beta::EntityListParams::IncludeArchived, nil]
+        optional :include_archived, enum: -> { Stigg::V1Beta::EntityListParams::IncludeArchived }
+
+        # @!attribute limit
+        #   Maximum number of items to return
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute type_ref_id
+        #   Filter results to entities of a specific entity type, by the type's refId
+        #
+        #   @return [String, nil]
+        optional :type_ref_id, String
+
+        # @!method initialize(id:, after: nil, before: nil, include_archived: nil, limit: nil, type_ref_id: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param after [String] Return items that come after this cursor
+        #
+        #   @param before [String] Return items that come before this cursor
+        #
+        #   @param include_archived [Symbol, Stigg::Models::V1Beta::EntityListParams::IncludeArchived] Whether to include archived entities. One of: true, false
+        #
+        #   @param limit [Integer] Maximum number of items to return
+        #
+        #   @param type_ref_id [String] Filter results to entities of a specific entity type, by the type's refId
+        #
+        #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+        # Whether to include archived entities. One of: true, false
+        module IncludeArchived
+          extend Stigg::Internal::Type::Enum
+
+          TRUE = :true
+          FALSE = :false
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1Beta
+      # @see Stigg::Resources::V1Beta::Entities#list
+      class EntityListResponse < Stigg::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the entity
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute archived_at
+        #   Timestamp of when the record was deleted
+        #
+        #   @return [Time, nil]
+        required :archived_at, Time, api_name: :archivedAt, nil?: true
+
+        # @!attribute created_at
+        #   Timestamp of when the record was created
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute metadata
+        #   Free-form key/value metadata attached to the entity
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :metadata, Stigg::Internal::Type::HashOf[String]
+
+        # @!attribute type_id
+        #   The entity type identifier this entity instantiates
+        #
+        #   @return [String]
+        required :type_id, String, api_name: :typeId
+
+        # @!attribute updated_at
+        #   Timestamp of when the record was last updated
+        #
+        #   @return [Time]
+        required :updated_at, Time, api_name: :updatedAt
+
+        # @!method initialize(id:, archived_at:, created_at:, metadata:, type_id:, updated_at:)
+        #   A stored entity instance tracked by the governance service for a given customer
+        #
+        #   @param id [String] The unique identifier for the entity
+        #
+        #   @param archived_at [Time, nil] Timestamp of when the record was deleted
+        #
+        #   @param created_at [Time] Timestamp of when the record was created
+        #
+        #   @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity
+        #
+        #   @param type_id [String] The entity type identifier this entity instantiates
+        #
+        #   @param updated_at [Time] Timestamp of when the record was last updated
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1Beta
+      # @see Stigg::Resources::V1Beta::Entities#retrieve
+      class EntityRetrieveParams < Stigg::Internal::Type::BaseModel
+        extend Stigg::Internal::Type::RequestParameters::Converter
+        include Stigg::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute entity_id
+        #
+        #   @return [String]
+        required :entity_id, String
+
+        # @!method initialize(id:, entity_id:, request_options: {})
+        #   @param id [String]
+        #   @param entity_id [String]
+        #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1Beta
+      # @see Stigg::Resources::V1Beta::Entities#retrieve
+      class EntityRetrieveResponse < Stigg::Internal::Type::BaseModel
+        # @!attribute data
+        #   A stored entity instance tracked by the governance service for a given customer
+        #
+        #   @return [Stigg::Models::V1Beta::EntityRetrieveResponse::Data]
+        required :data, -> { Stigg::Models::V1Beta::EntityRetrieveResponse::Data }
+
+        # @!method initialize(data:)
+        #   Response object
+        #
+        #   @param data [Stigg::Models::V1Beta::EntityRetrieveResponse::Data] A stored entity instance tracked by the governance service for a given customer
+
+        # @see Stigg::Models::V1Beta::EntityRetrieveResponse#data
+        class Data < Stigg::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the entity
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute archived_at
+          #   Timestamp of when the record was deleted
+          #
+          #   @return [Time, nil]
+          required :archived_at, Time, api_name: :archivedAt, nil?: true
+
+          # @!attribute created_at
+          #   Timestamp of when the record was created
+          #
+          #   @return [Time]
+          required :created_at, Time, api_name: :createdAt
+
+          # @!attribute metadata
+          #   Free-form key/value metadata attached to the entity
+          #
+          #   @return [Hash{Symbol=>String}]
+          required :metadata, Stigg::Internal::Type::HashOf[String]
+
+          # @!attribute type_id
+          #   The entity type identifier this entity instantiates
+          #
+          #   @return [String]
+          required :type_id, String, api_name: :typeId
+
+          # @!attribute updated_at
+          #   Timestamp of when the record was last updated
+          #
+          #   @return [Time]
+          required :updated_at, Time, api_name: :updatedAt
+
+          # @!method initialize(id:, archived_at:, created_at:, metadata:, type_id:, updated_at:)
+          #   A stored entity instance tracked by the governance service for a given customer
+          #
+          #   @param id [String] The unique identifier for the entity
+          #
+          #   @param archived_at [Time, nil] Timestamp of when the record was deleted
+          #
+          #   @param created_at [Time] Timestamp of when the record was created
+          #
+          #   @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity
+          #
+          #   @param type_id [String] The entity type identifier this entity instantiates
+          #
+          #   @param updated_at [Time] Timestamp of when the record was last updated
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1Beta
+      # @see Stigg::Resources::V1Beta::Entities#unarchive
+      class EntityUnarchiveParams < Stigg::Internal::Type::BaseModel
+        extend Stigg::Internal::Type::RequestParameters::Converter
+        include Stigg::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute ids
+        #   Entity identifiers to act on
+        #
+        #   @return [Array<String>]
+        required :ids, Stigg::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, ids:, request_options: {})
+        #   @param id [String]
+        #
+        #   @param ids [Array<String>] Entity identifiers to act on
+        #
+        #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1Beta
+      # @see Stigg::Resources::V1Beta::Entities#unarchive
+      class EntityUnarchiveResponse < Stigg::Internal::Type::BaseModel
+        # @!attribute data
+        #   List of entity identifiers that were acted on
+        #
+        #   @return [Stigg::Models::V1Beta::EntityUnarchiveResponse::Data]
+        required :data, -> { Stigg::Models::V1Beta::EntityUnarchiveResponse::Data }
+
+        # @!method initialize(data:)
+        #   Wrapped response echoing the ids that were acted on by an archive/unarchive call
+        #
+        #   @param data [Stigg::Models::V1Beta::EntityUnarchiveResponse::Data] List of entity identifiers that were acted on
+
+        # @see Stigg::Models::V1Beta::EntityUnarchiveResponse#data
+        class Data < Stigg::Internal::Type::BaseModel
+          # @!attribute ids
+          #   Entity identifiers to act on
+          #
+          #   @return [Array<String>]
+          required :ids, Stigg::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(ids:)
+          #   List of entity identifiers that were acted on
+          #
+          #   @param ids [Array<String>] Entity identifiers to act on
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1Beta
+      # @see Stigg::Resources::V1Beta::Entities#upsert
+      class EntityUpsertParams < Stigg::Internal::Type::BaseModel
+        extend Stigg::Internal::Type::RequestParameters::Converter
+        include Stigg::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute entities
+        #   List of entities to create or update (1-100 entries)
+        #
+        #   @return [Array<Stigg::Models::V1Beta::EntityUpsertParams::Entity>]
+        required :entities, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1Beta::EntityUpsertParams::Entity] }
+
+        # @!method initialize(id:, entities:, request_options: {})
+        #   @param id [String]
+        #
+        #   @param entities [Array<Stigg::Models::V1Beta::EntityUpsertParams::Entity>] List of entities to create or update (1-100 entries)
+        #
+        #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+        class Entity < Stigg::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the entity
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute metadata
+          #   Free-form key/value metadata. Patch semantics: empty-string value removes a key,
+          #   omitted keys are preserved.
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :metadata, Stigg::Internal::Type::HashOf[String]
+
+          # @!attribute type_ref_id
+          #   The entity type refId 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.
+          #
+          #   @return [String, nil]
+          optional :type_ref_id, String, api_name: :typeRefId
+
+          # @!method initialize(id:, metadata: nil, type_ref_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Stigg::Models::V1Beta::EntityUpsertParams::Entity} for more details.
+          #
+          #   A single entity to create or update.
+          #
+          #   @param id [String] The unique identifier for the entity
+          #
+          #   @param metadata [Hash{Symbol=>String}] Free-form key/value metadata. Patch semantics: empty-string value removes a key,
+          #
+          #   @param type_ref_id [String] The entity type refId this entity instantiates. Required when creating a new ent
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1Beta
+      # @see Stigg::Resources::V1Beta::Entities#upsert
+      class EntityUpsertResponse < Stigg::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Stigg::Models::V1Beta::EntityUpsertResponse::Data>]
+        required :data, -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1Beta::EntityUpsertResponse::Data] }
+
+        # @!method initialize(data:)
+        #   List of entities created or updated by an upsert request
+        #
+        #   @param data [Array<Stigg::Models::V1Beta::EntityUpsertResponse::Data>]
+
+        class Data < Stigg::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the entity
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute archived_at
+          #   Timestamp of when the record was deleted
+          #
+          #   @return [Time, nil]
+          required :archived_at, Time, api_name: :archivedAt, nil?: true
+
+          # @!attribute created_at
+          #   Timestamp of when the record was created
+          #
+          #   @return [Time]
+          required :created_at, Time, api_name: :createdAt
+
+          # @!attribute metadata
+          #   Free-form key/value metadata attached to the entity
+          #
+          #   @return [Hash{Symbol=>String}]
+          required :metadata, Stigg::Internal::Type::HashOf[String]
+
+          # @!attribute type_id
+          #   The entity type identifier this entity instantiates
+          #
+          #   @return [String]
+          required :type_id, String, api_name: :typeId
+
+          # @!attribute updated_at
+          #   Timestamp of when the record was last updated
+          #
+          #   @return [Time]
+          required :updated_at, Time, api_name: :updatedAt
+
+          # @!method initialize(id:, archived_at:, created_at:, metadata:, type_id:, updated_at:)
+          #   A stored entity instance tracked by the governance service for a given customer
+          #
+          #   @param id [String] The unique identifier for the entity
+          #
+          #   @param archived_at [Time, nil] Timestamp of when the record was deleted
+          #
+          #   @param created_at [Time] Timestamp of when the record was created
+          #
+          #   @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity
+          #
+          #   @param type_id [String] The entity type identifier this entity instantiates
+          #
+          #   @param updated_at [Time] Timestamp of when the record was last updated
+        end
+      end
+    end
+  end
+end