stigg 0.1.0.pre.alpha.34 → 0.1.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 396050cde3ffe9c15a9acdebe0d5d2d524262f13a843a639d86d8d44c6e95b83
-  data.tar.gz: f0dd38b57f86f2043a72169ba93e40b64a429c378d8c61c47883cd7e0a2241ec
+  metadata.gz: c90ef360bd74c5409fabb376a4cee67876dde159497942b7464353adfd591ff2
+  data.tar.gz: 8080663595e284f048d9624092e687f9c8cbfb75fb1faf6c8c50354377692049
 SHA512:
-  metadata.gz: 8533daa2298fa08fe01c5268e31a5158f51cb06ed36bd51975f9b6d93dce9ec6221e13169f9d48911ff723a0df0cd789dca1b22ee2303c5edd1cd8f857f8e945
-  data.tar.gz: b1bd1ad3dcbf2a6a35d7b38f3d9318e6ea34244f9701ddee79c414598c8ca1228c8eb5d6e4f5cbe6794a3a44267dee9527b0af1bac7ab03b0060e34b7651a961
+  metadata.gz: f087d074fac5431724e397974750eba2a4e0dbca2865c77549c14a726a71484c6bbae696e0c8142f2a1b86d8827279ec9ef94ff4016e14604ce7d07877e9290e
+  data.tar.gz: 0cff15ec7536714419a418bb84ec2d53a5dd79e0e6cbf02bb09e264125e652273d7d78ea9bc057fbcdab8707434d983cf84107f6c56265c35ec3bae39ad221df

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.1.0-beta.1 (2026-05-12)
+
+Full Changelog: [v0.1.0-alpha.34...v0.1.0-beta.1](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-alpha.34...v0.1.0-beta.1)
+
+### Features
+
+* **api:** add custom_currencies resource to events/credits ([6999605](https://github.com/stiggio/stigg-ruby/commit/699960512734576197f4000f0dd069506bf47448))
+
+
+### Chores
+
+* **internal:** regenerate SDK with no functional changes ([e07191b](https://github.com/stiggio/stigg-ruby/commit/e07191b4ead698186c7d2b8c665d3eca17debe7e))
+
 ## 0.1.0-alpha.34 (2026-05-11)
 
 Full Changelog: [v0.1.0-alpha.33...v0.1.0-alpha.34](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-alpha.33...v0.1.0-alpha.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.alpha.34"
+gem "stigg", "~> 0.1.0.pre.beta.1"
 ```
 
 <!-- x-release-please-end -->

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

@@ -41,8 +41,8 @@ module Stigg
         # @!attribute status
         #   Filter by status. Supports comma-separated values for multiple statuses
         #
-        #   @return [String, nil]
-        optional :status, String
+        #   @return [Array<Symbol, Stigg::Models::V1::AddonListParams::Status>, nil]
+        optional :status, -> { Stigg::Internal::Type::ArrayOf[enum: Stigg::V1::AddonListParams::Status] }
 
         # @!method initialize(after: nil, before: nil, created_at: nil, limit: nil, product_id: nil, status: nil, request_options: {})
         #   @param after [String] Return items that come after this cursor
@@ -55,7 +55,7 @@ module Stigg
         #
         #   @param product_id [String] Filter by product ID
         #
-        #   @param status [String] Filter by status. Supports comma-separated values for multiple statuses
+        #   @param status [Array<Symbol, Stigg::Models::V1::AddonListParams::Status>] Filter by status. Supports comma-separated values for multiple statuses
         #
         #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
 
@@ -95,6 +95,17 @@ module Stigg
           #
           #   @param lte [Time] Less than or equal to the specified createdAt value
         end
+
+        module Status
+          extend Stigg::Internal::Type::Enum
+
+          DRAFT = :DRAFT
+          PUBLISHED = :PUBLISHED
+          ARCHIVED = :ARCHIVED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

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

@@ -41,8 +41,8 @@ module Stigg
         # @!attribute status
         #   Filter by coupon status. Supports comma-separated values for multiple statuses
         #
-        #   @return [String, nil]
-        optional :status, String
+        #   @return [Array<Symbol, Stigg::Models::V1::CouponListParams::Status>, nil]
+        optional :status, -> { Stigg::Internal::Type::ArrayOf[enum: Stigg::V1::CouponListParams::Status] }
 
         # @!attribute type
         #   Filter by coupon type (FIXED or PERCENTAGE)
@@ -61,7 +61,7 @@ module Stigg
         #
         #   @param limit [Integer] Maximum number of items to return
         #
-        #   @param status [String] Filter by coupon status. Supports comma-separated values for multiple statuses
+        #   @param status [Array<Symbol, Stigg::Models::V1::CouponListParams::Status>] Filter by coupon status. Supports comma-separated values for multiple statuses
         #
         #   @param type [Symbol, Stigg::Models::V1::CouponListParams::Type] Filter by coupon type (FIXED or PERCENTAGE)
         #
@@ -104,6 +104,16 @@ module Stigg
           #   @param lte [Time] Less than or equal to the specified createdAt value
         end
 
+        module Status
+          extend Stigg::Internal::Type::Enum
+
+          ACTIVE = :ACTIVE
+          ARCHIVED = :ARCHIVED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # Filter by coupon type (FIXED or PERCENTAGE)
         module Type
           extend Stigg::Internal::Type::Enum

data/lib/stigg/models/v1/customers/integration_list_params.rb

@@ -36,8 +36,9 @@ module Stigg
           #   Filter by vendor identifier. Supports comma-separated values for multiple
           #   vendors (e.g., STRIPE,HUBSPOT)
           #
-          #   @return [String, nil]
-          optional :vendor_identifier, String
+          #   @return [Array<Symbol, Stigg::Models::V1::Customers::IntegrationListParams::VendorIdentifier>, nil]
+          optional :vendor_identifier,
+                   -> { Stigg::Internal::Type::ArrayOf[enum: Stigg::V1::Customers::IntegrationListParams::VendorIdentifier] }
 
           # @!method initialize(id:, after: nil, before: nil, limit: nil, vendor_identifier: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
@@ -51,9 +52,27 @@ module Stigg
           #
           #   @param limit [Integer] Maximum number of items to return
           #
-          #   @param vendor_identifier [String] Filter by vendor identifier. Supports comma-separated values for multiple vendor
+          #   @param vendor_identifier [Array<Symbol, Stigg::Models::V1::Customers::IntegrationListParams::VendorIdentifier>] Filter by vendor identifier. Supports comma-separated values for multiple vendor
           #
           #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+          module VendorIdentifier
+            extend Stigg::Internal::Type::Enum
+
+            AUTH0 = :AUTH0
+            ZUORA = :ZUORA
+            STRIPE = :STRIPE
+            HUBSPOT = :HUBSPOT
+            AWS_MARKETPLACE = :AWS_MARKETPLACE
+            SNOWFLAKE = :SNOWFLAKE
+            SALESFORCE = :SALESFORCE
+            BIG_QUERY = :BIG_QUERY
+            OPEN_FGA = :OPEN_FGA
+            APP_STORE = :APP_STORE
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end
     end

data/lib/stigg/models/v1/customers/promotional_entitlement_list_params.rb

@@ -42,8 +42,9 @@ module Stigg
           #   Filter by promotional entitlement status. Supports comma-separated values for
           #   multiple statuses
           #
-          #   @return [String, nil]
-          optional :status, String
+          #   @return [Array<Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementListParams::Status>, nil]
+          optional :status,
+                   -> { Stigg::Internal::Type::ArrayOf[enum: Stigg::V1::Customers::PromotionalEntitlementListParams::Status] }
 
           # @!method initialize(id:, after: nil, before: nil, created_at: nil, limit: nil, status: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
@@ -60,7 +61,7 @@ module Stigg
           #
           #   @param limit [Integer] Maximum number of items to return
           #
-          #   @param status [String] Filter by promotional entitlement status. Supports comma-separated values for mu
+          #   @param status [Array<Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementListParams::Status>] Filter by promotional entitlement status. Supports comma-separated values for mu
           #
           #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
 
@@ -100,6 +101,17 @@ module Stigg
             #
             #   @param lte [Time] Less than or equal to the specified createdAt value
           end
+
+          module Status
+            extend Stigg::Internal::Type::Enum
+
+            ACTIVE = :Active
+            EXPIRED = :Expired
+            PAUSED = :Paused
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end
     end

data/lib/stigg/models/v1/events/credits/custom_currency_archive_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Events
+        module Credits
+          # @see Stigg::Resources::V1::Events::Credits::CustomCurrencies#archive
+          class CustomCurrencyArchiveParams < Stigg::Internal::Type::BaseModel
+            extend Stigg::Internal::Type::RequestParameters::Converter
+            include Stigg::Internal::Type::RequestParameters
+
+            # @!attribute currency_id
+            #
+            #   @return [String]
+            required :currency_id, String
+
+            # @!method initialize(currency_id:, request_options: {})
+            #   @param currency_id [String]
+            #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/events/credits/custom_currency_archive_response.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Events
+        module Credits
+          # @see Stigg::Resources::V1::Events::Credits::CustomCurrencies#archive
+          class CustomCurrencyArchiveResponse < Stigg::Internal::Type::BaseModel
+            # @!attribute data
+            #   A custom currency used to denominate credit-based entitlements and pricing
+            #
+            #   @return [Stigg::Models::V1::Events::Credits::CustomCurrencyArchiveResponse::Data]
+            required :data, -> { Stigg::Models::V1::Events::Credits::CustomCurrencyArchiveResponse::Data }
+
+            # @!method initialize(data:)
+            #   Response object
+            #
+            #   @param data [Stigg::Models::V1::Events::Credits::CustomCurrencyArchiveResponse::Data] A custom currency used to denominate credit-based entitlements and pricing
+
+            # @see Stigg::Models::V1::Events::Credits::CustomCurrencyArchiveResponse#data
+            class Data < Stigg::Internal::Type::BaseModel
+              # @!attribute id
+              #   The unique identifier for the custom currency
+              #
+              #   @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 description
+              #   Description of the currency
+              #
+              #   @return [String, nil]
+              required :description, String, nil?: true
+
+              # @!attribute display_name
+              #   The display name of the custom currency
+              #
+              #   @return [String]
+              required :display_name, String, api_name: :displayName
+
+              # @!attribute metadata
+              #   Metadata associated with the entity
+              #
+              #   @return [Hash{Symbol=>String}]
+              required :metadata, Stigg::Internal::Type::HashOf[String]
+
+              # @!attribute symbol
+              #   The symbol used to represent the custom currency
+              #
+              #   @return [String, nil]
+              required :symbol, String, nil?: true
+
+              # @!attribute units
+              #   Singular and plural unit labels for a custom currency
+              #
+              #   @return [Stigg::Models::V1::Events::Credits::CustomCurrencyArchiveResponse::Data::Units, nil]
+              required :units,
+                       -> { Stigg::Models::V1::Events::Credits::CustomCurrencyArchiveResponse::Data::Units },
+                       nil?: true
+
+              # @!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:, description:, display_name:, metadata:, symbol:, units:, updated_at:)
+              #   A custom currency used to denominate credit-based entitlements and pricing
+              #
+              #   @param id [String] The unique identifier for the custom currency
+              #
+              #   @param archived_at [Time, nil] Timestamp of when the record was deleted
+              #
+              #   @param created_at [Time] Timestamp of when the record was created
+              #
+              #   @param description [String, nil] Description of the currency
+              #
+              #   @param display_name [String] The display name of the custom currency
+              #
+              #   @param metadata [Hash{Symbol=>String}] Metadata associated with the entity
+              #
+              #   @param symbol [String, nil] The symbol used to represent the custom currency
+              #
+              #   @param units [Stigg::Models::V1::Events::Credits::CustomCurrencyArchiveResponse::Data::Units, nil] Singular and plural unit labels for a custom currency
+              #
+              #   @param updated_at [Time] Timestamp of when the record was last updated
+
+              # @see Stigg::Models::V1::Events::Credits::CustomCurrencyArchiveResponse::Data#units
+              class Units < Stigg::Internal::Type::BaseModel
+                # @!attribute plural
+                #   Plural form of the unit label
+                #
+                #   @return [String, nil]
+                required :plural, String, nil?: true
+
+                # @!attribute singular
+                #   Singular form of the unit label
+                #
+                #   @return [String, nil]
+                required :singular, String, nil?: true
+
+                # @!method initialize(plural:, singular:)
+                #   Singular and plural unit labels for a custom currency
+                #
+                #   @param plural [String, nil] Plural form of the unit label
+                #
+                #   @param singular [String, nil] Singular form of the unit label
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/events/credits/custom_currency_create_params.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Events
+        module Credits
+          # @see Stigg::Resources::V1::Events::Credits::CustomCurrencies#create
+          class CustomCurrencyCreateParams < Stigg::Internal::Type::BaseModel
+            extend Stigg::Internal::Type::RequestParameters::Converter
+            include Stigg::Internal::Type::RequestParameters
+
+            # @!attribute id
+            #   The unique identifier for the new custom currency
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute display_name
+            #   The display name of the custom currency
+            #
+            #   @return [String]
+            required :display_name, String, api_name: :displayName
+
+            # @!attribute description
+            #   Description of the currency
+            #
+            #   @return [String, nil]
+            optional :description, String
+
+            # @!attribute metadata
+            #   Additional metadata to attach to the custom currency
+            #
+            #   @return [Hash{Symbol=>String}, nil]
+            optional :metadata, Stigg::Internal::Type::HashOf[String]
+
+            # @!attribute symbol
+            #   The symbol used to represent the custom currency
+            #
+            #   @return [String, nil]
+            optional :symbol, String
+
+            # @!attribute units
+            #   Singular and plural unit labels for a custom currency. Both fields are required
+            #   when supplied.
+            #
+            #   @return [Stigg::Models::V1::Events::Credits::CustomCurrencyCreateParams::Units, nil]
+            optional :units, -> { Stigg::V1::Events::Credits::CustomCurrencyCreateParams::Units }
+
+            # @!method initialize(id:, display_name:, description: nil, metadata: nil, symbol: nil, units: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {Stigg::Models::V1::Events::Credits::CustomCurrencyCreateParams} for more
+            #   details.
+            #
+            #   @param id [String] The unique identifier for the new custom currency
+            #
+            #   @param display_name [String] The display name of the custom currency
+            #
+            #   @param description [String] Description of the currency
+            #
+            #   @param metadata [Hash{Symbol=>String}] Additional metadata to attach to the custom currency
+            #
+            #   @param symbol [String] The symbol used to represent the custom currency
+            #
+            #   @param units [Stigg::Models::V1::Events::Credits::CustomCurrencyCreateParams::Units] Singular and plural unit labels for a custom currency. Both fields are required
+            #
+            #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+            class Units < Stigg::Internal::Type::BaseModel
+              # @!attribute plural
+              #   Plural form of the unit label
+              #
+              #   @return [String]
+              required :plural, String
+
+              # @!attribute singular
+              #   Singular form of the unit label
+              #
+              #   @return [String]
+              required :singular, String
+
+              # @!method initialize(plural:, singular:)
+              #   Singular and plural unit labels for a custom currency. Both fields are required
+              #   when supplied.
+              #
+              #   @param plural [String] Plural form of the unit label
+              #
+              #   @param singular [String] Singular form of the unit label
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/events/credits/custom_currency_create_response.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Events
+        module Credits
+          # @see Stigg::Resources::V1::Events::Credits::CustomCurrencies#create
+          class CustomCurrencyCreateResponse < Stigg::Internal::Type::BaseModel
+            # @!attribute data
+            #   A custom currency used to denominate credit-based entitlements and pricing
+            #
+            #   @return [Stigg::Models::V1::Events::Credits::CustomCurrencyCreateResponse::Data]
+            required :data, -> { Stigg::Models::V1::Events::Credits::CustomCurrencyCreateResponse::Data }
+
+            # @!method initialize(data:)
+            #   Response object
+            #
+            #   @param data [Stigg::Models::V1::Events::Credits::CustomCurrencyCreateResponse::Data] A custom currency used to denominate credit-based entitlements and pricing
+
+            # @see Stigg::Models::V1::Events::Credits::CustomCurrencyCreateResponse#data
+            class Data < Stigg::Internal::Type::BaseModel
+              # @!attribute id
+              #   The unique identifier for the custom currency
+              #
+              #   @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 description
+              #   Description of the currency
+              #
+              #   @return [String, nil]
+              required :description, String, nil?: true
+
+              # @!attribute display_name
+              #   The display name of the custom currency
+              #
+              #   @return [String]
+              required :display_name, String, api_name: :displayName
+
+              # @!attribute metadata
+              #   Metadata associated with the entity
+              #
+              #   @return [Hash{Symbol=>String}]
+              required :metadata, Stigg::Internal::Type::HashOf[String]
+
+              # @!attribute symbol
+              #   The symbol used to represent the custom currency
+              #
+              #   @return [String, nil]
+              required :symbol, String, nil?: true
+
+              # @!attribute units
+              #   Singular and plural unit labels for a custom currency
+              #
+              #   @return [Stigg::Models::V1::Events::Credits::CustomCurrencyCreateResponse::Data::Units, nil]
+              required :units,
+                       -> { Stigg::Models::V1::Events::Credits::CustomCurrencyCreateResponse::Data::Units },
+                       nil?: true
+
+              # @!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:, description:, display_name:, metadata:, symbol:, units:, updated_at:)
+              #   A custom currency used to denominate credit-based entitlements and pricing
+              #
+              #   @param id [String] The unique identifier for the custom currency
+              #
+              #   @param archived_at [Time, nil] Timestamp of when the record was deleted
+              #
+              #   @param created_at [Time] Timestamp of when the record was created
+              #
+              #   @param description [String, nil] Description of the currency
+              #
+              #   @param display_name [String] The display name of the custom currency
+              #
+              #   @param metadata [Hash{Symbol=>String}] Metadata associated with the entity
+              #
+              #   @param symbol [String, nil] The symbol used to represent the custom currency
+              #
+              #   @param units [Stigg::Models::V1::Events::Credits::CustomCurrencyCreateResponse::Data::Units, nil] Singular and plural unit labels for a custom currency
+              #
+              #   @param updated_at [Time] Timestamp of when the record was last updated
+
+              # @see Stigg::Models::V1::Events::Credits::CustomCurrencyCreateResponse::Data#units
+              class Units < Stigg::Internal::Type::BaseModel
+                # @!attribute plural
+                #   Plural form of the unit label
+                #
+                #   @return [String, nil]
+                required :plural, String, nil?: true
+
+                # @!attribute singular
+                #   Singular form of the unit label
+                #
+                #   @return [String, nil]
+                required :singular, String, nil?: true
+
+                # @!method initialize(plural:, singular:)
+                #   Singular and plural unit labels for a custom currency
+                #
+                #   @param plural [String, nil] Plural form of the unit label
+                #
+                #   @param singular [String, nil] Singular form of the unit label
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/events/credits/custom_currency_list_associated_entities_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Events
+        module Credits
+          # @see Stigg::Resources::V1::Events::Credits::CustomCurrencies#list_associated_entities
+          class CustomCurrencyListAssociatedEntitiesParams < Stigg::Internal::Type::BaseModel
+            extend Stigg::Internal::Type::RequestParameters::Converter
+            include Stigg::Internal::Type::RequestParameters
+
+            # @!attribute currency_id
+            #
+            #   @return [String]
+            required :currency_id, String
+
+            # @!method initialize(currency_id:, request_options: {})
+            #   @param currency_id [String]
+            #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/events/credits/custom_currency_list_associated_entities_response.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Events
+        module Credits
+          # @see Stigg::Resources::V1::Events::Credits::CustomCurrencies#list_associated_entities
+          class CustomCurrencyListAssociatedEntitiesResponse < Stigg::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Array<Stigg::Models::V1::Events::Credits::CustomCurrencyListAssociatedEntitiesResponse::Data>]
+            required :data,
+                     -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::Events::Credits::CustomCurrencyListAssociatedEntitiesResponse::Data] }
+
+            # @!method initialize(data:)
+            #   List of entities (plans or addons) that reference a custom currency
+            #
+            #   @param data [Array<Stigg::Models::V1::Events::Credits::CustomCurrencyListAssociatedEntitiesResponse::Data>]
+
+            class Data < Stigg::Internal::Type::BaseModel
+              # @!attribute id
+              #   The reference ID of the associated entity
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute display_name
+              #   The display name of the associated entity
+              #
+              #   @return [String]
+              required :display_name, String, api_name: :displayName
+
+              # @!attribute type
+              #   The kind of entity referencing the currency (e.g., Plan)
+              #
+              #   @return [String]
+              required :type, String
+
+              # @!method initialize(id:, display_name:, type:)
+              #   An entity (plan or addon) that references a custom currency
+              #
+              #   @param id [String] The reference ID of the associated entity
+              #
+              #   @param display_name [String] The display name of the associated entity
+              #
+              #   @param type [String] The kind of entity referencing the currency (e.g., Plan)
+            end
+          end
+        end
+      end
+    end
+  end
+end