dodopayments 2.8.0 → 2.9.0

data/rbi/dodopayments/models/product_entitlement_summary.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductEntitlementSummary < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductEntitlementSummary,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Public-facing variant of [`IntegrationConfig`]. Mirrors every variant shape on
+      # the wire EXCEPT `DigitalFiles`, which is replaced with a hydrated
+      # `digital_files` object (resolved download URLs etc.). The persisted JSONB stays
+      # ID-only via [`IntegrationConfig`]; this enum is response-only.
+      sig { returns(Dodopayments::IntegrationConfigResponse::Variants) }
+      attr_accessor :integration_config
+
+      sig { returns(Dodopayments::EntitlementIntegrationType::TaggedSymbol) }
+      attr_accessor :integration_type
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Summary of an entitlement attached to a product.
+      #
+      # `integration_config` uses [`IntegrationConfigResponse`] (NOT the persisted
+      # [`IntegrationConfig`]) so digital_files entitlements embed the resolved
+      # `digital_files` object — matching what `GET /entitlements/{id}` returns. All
+      # other variants pass through unchanged via `#[serde(untagged)]`.
+      sig do
+        params(
+          id: String,
+          integration_config:
+            T.any(
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::DiscordConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::TelegramConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::FigmaConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::FramerConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::NotionConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::LicenseKeyConfig::OrHash
+            ),
+          integration_type: Dodopayments::EntitlementIntegrationType::OrSymbol,
+          name: String,
+          description: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Public-facing variant of [`IntegrationConfig`]. Mirrors every variant shape on
+        # the wire EXCEPT `DigitalFiles`, which is replaced with a hydrated
+        # `digital_files` object (resolved download URLs etc.). The persisted JSONB stays
+        # ID-only via [`IntegrationConfig`]; this enum is response-only.
+        integration_config:,
+        integration_type:,
+        name:,
+        description: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            integration_config:
+              Dodopayments::IntegrationConfigResponse::Variants,
+            integration_type:
+              Dodopayments::EntitlementIntegrationType::TaggedSymbol,
+            name: String,
+            description: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_list_response.rbi

@@ -20,11 +20,7 @@ module Dodopayments
       attr_accessor :created_at
 
       # Entitlements linked to this product
-      sig do
-        returns(
-          T::Array[Dodopayments::Models::ProductListResponse::Entitlement]
-        )
-      end
+      sig { returns(T::Array[Dodopayments::ProductEntitlementSummary]) }
       attr_accessor :entitlements
 
       # Indicates if the product is recurring (e.g., subscriptions).
@@ -89,9 +85,7 @@ module Dodopayments
           business_id: String,
           created_at: Time,
           entitlements:
-            T::Array[
-              Dodopayments::Models::ProductListResponse::Entitlement::OrHash
-            ],
+            T::Array[Dodopayments::ProductEntitlementSummary::OrHash],
           is_recurring: T::Boolean,
           metadata: T::Hash[Symbol, String],
           product_id: String,
@@ -161,8 +155,7 @@ module Dodopayments
           {
             business_id: String,
             created_at: Time,
-            entitlements:
-              T::Array[Dodopayments::Models::ProductListResponse::Entitlement],
+            entitlements: T::Array[Dodopayments::ProductEntitlementSummary],
             is_recurring: T::Boolean,
             metadata: T::Hash[Symbol, String],
             product_id: String,
@@ -180,426 +173,6 @@ module Dodopayments
       end
       def to_hash
       end
-
-      class Entitlement < Dodopayments::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Dodopayments::Models::ProductListResponse::Entitlement,
-              Dodopayments::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :id
-
-        # Platform-specific configuration for an entitlement. Each variant uses unique
-        # field names so `#[serde(untagged)]` can disambiguate correctly.
-        sig do
-          returns(
-            Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::Variants
-          )
-        end
-        attr_accessor :integration_config
-
-        sig do
-          returns(
-            Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol
-          )
-        end
-        attr_accessor :integration_type
-
-        sig { returns(String) }
-        attr_accessor :name
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :description
-
-        # Summary of an entitlement attached to a product
-        sig do
-          params(
-            id: String,
-            integration_config:
-              T.any(
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::GitHubConfig::OrHash,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::DiscordConfig::OrHash,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::TelegramConfig::OrHash,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::FigmaConfig::OrHash,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::FramerConfig::OrHash,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::NotionConfig::OrHash,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::DigitalFilesConfig::OrHash,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::LicenseKeyConfig::OrHash
-              ),
-            integration_type:
-              Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::OrSymbol,
-            name: String,
-            description: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id:,
-          # Platform-specific configuration for an entitlement. Each variant uses unique
-          # field names so `#[serde(untagged)]` can disambiguate correctly.
-          integration_config:,
-          integration_type:,
-          name:,
-          description: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              integration_config:
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::Variants,
-              integration_type:
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol,
-              name: String,
-              description: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # Platform-specific configuration for an entitlement. Each variant uses unique
-        # field names so `#[serde(untagged)]` can disambiguate correctly.
-        module IntegrationConfig
-          extend Dodopayments::Internal::Type::Union
-
-          Variants =
-            T.type_alias do
-              T.any(
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::GitHubConfig,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::DiscordConfig,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::TelegramConfig,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::FigmaConfig,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::FramerConfig,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::NotionConfig,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::DigitalFilesConfig,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::LicenseKeyConfig
-              )
-            end
-
-          class GitHubConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::GitHubConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            # One of: pull, push, admin, maintain, triage
-            sig { returns(String) }
-            attr_accessor :permission
-
-            sig { returns(String) }
-            attr_accessor :target_id
-
-            sig do
-              params(permission: String, target_id: String).returns(
-                T.attached_class
-              )
-            end
-            def self.new(
-              # One of: pull, push, admin, maintain, triage
-              permission:,
-              target_id:
-            )
-            end
-
-            sig { override.returns({ permission: String, target_id: String }) }
-            def to_hash
-            end
-          end
-
-          class DiscordConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::DiscordConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :guild_id
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :role_id
-
-            sig do
-              params(guild_id: String, role_id: T.nilable(String)).returns(
-                T.attached_class
-              )
-            end
-            def self.new(guild_id:, role_id: nil)
-            end
-
-            sig do
-              override.returns({ guild_id: String, role_id: T.nilable(String) })
-            end
-            def to_hash
-            end
-          end
-
-          class TelegramConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::TelegramConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :chat_id
-
-            sig { params(chat_id: String).returns(T.attached_class) }
-            def self.new(chat_id:)
-            end
-
-            sig { override.returns({ chat_id: String }) }
-            def to_hash
-            end
-          end
-
-          class FigmaConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::FigmaConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :figma_file_id
-
-            sig { params(figma_file_id: String).returns(T.attached_class) }
-            def self.new(figma_file_id:)
-            end
-
-            sig { override.returns({ figma_file_id: String }) }
-            def to_hash
-            end
-          end
-
-          class FramerConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::FramerConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :framer_template_id
-
-            sig { params(framer_template_id: String).returns(T.attached_class) }
-            def self.new(framer_template_id:)
-            end
-
-            sig { override.returns({ framer_template_id: String }) }
-            def to_hash
-            end
-          end
-
-          class NotionConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::NotionConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :notion_template_id
-
-            sig { params(notion_template_id: String).returns(T.attached_class) }
-            def self.new(notion_template_id:)
-            end
-
-            sig { override.returns({ notion_template_id: String }) }
-            def to_hash
-            end
-          end
-
-          class DigitalFilesConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::DigitalFilesConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(T::Array[String]) }
-            attr_accessor :digital_file_ids
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :external_url
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :instructions
-
-            sig do
-              params(
-                digital_file_ids: T::Array[String],
-                external_url: T.nilable(String),
-                instructions: T.nilable(String)
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              digital_file_ids:,
-              external_url: nil,
-              instructions: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  digital_file_ids: T::Array[String],
-                  external_url: T.nilable(String),
-                  instructions: T.nilable(String)
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-
-          class LicenseKeyConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::LicenseKeyConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :activation_message
-
-            sig { returns(T.nilable(Integer)) }
-            attr_accessor :activations_limit
-
-            sig { returns(T.nilable(Integer)) }
-            attr_accessor :duration_count
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :duration_interval
-
-            sig do
-              params(
-                activation_message: T.nilable(String),
-                activations_limit: T.nilable(Integer),
-                duration_count: T.nilable(Integer),
-                duration_interval: T.nilable(String)
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              activation_message: nil,
-              activations_limit: nil,
-              duration_count: nil,
-              duration_interval: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  activation_message: T.nilable(String),
-                  activations_limit: T.nilable(Integer),
-                  duration_count: T.nilable(Integer),
-                  duration_interval: T.nilable(String)
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-
-          sig do
-            override.returns(
-              T::Array[
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationConfig::Variants
-              ]
-            )
-          end
-          def self.variants
-          end
-        end
-
-        module IntegrationType
-          extend Dodopayments::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          DISCORD =
-            T.let(
-              :discord,
-              Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol
-            )
-          TELEGRAM =
-            T.let(
-              :telegram,
-              Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol
-            )
-          GITHUB =
-            T.let(
-              :github,
-              Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol
-            )
-          FIGMA =
-            T.let(
-              :figma,
-              Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol
-            )
-          FRAMER =
-            T.let(
-              :framer,
-              Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol
-            )
-          NOTION =
-            T.let(
-              :notion,
-              Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol
-            )
-          DIGITAL_FILES =
-            T.let(
-              :digital_files,
-              Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol
-            )
-          LICENSE_KEY =
-            T.let(
-              :license_key,
-              Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Dodopayments::Models::ProductListResponse::Entitlement::IntegrationType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
     end
   end
 end

data/rbi/dodopayments/models/product_update_params.rbi

@@ -36,6 +36,8 @@ module Dodopayments
       attr_accessor :description
 
       # Choose how you would like you digital product delivered
+      #
+      # deprecated: use entitlements instead
       sig do
         returns(
           T.nilable(Dodopayments::ProductUpdateParams::DigitalProductDelivery)
@@ -53,10 +55,12 @@ module Dodopayments
       end
       attr_writer :digital_product_delivery
 
-      # Entitlement IDs to attach (replaces all existing when present) Send empty array
-      # to remove all, omit field to leave unchanged
-      sig { returns(T.nilable(T::Array[String])) }
-      attr_accessor :entitlement_ids
+      # Entitlements to attach (replaces all existing when present) Send empty array to
+      # remove all, omit field to leave unchanged
+      sig do
+        returns(T.nilable(T::Array[Dodopayments::AttachProductEntitlement]))
+      end
+      attr_accessor :entitlements
 
       # Product image id after its uploaded to S3
       sig { returns(T.nilable(String)) }
@@ -66,6 +70,8 @@ module Dodopayments
       #
       # Only applicable if `license_key_enabled` is `true`. This message contains
       # instructions for activating the license key.
+      #
+      # deprecated: use entitlements instead
       sig { returns(T.nilable(String)) }
       attr_accessor :license_key_activation_message
 
@@ -73,6 +79,8 @@ module Dodopayments
       #
       # Only applicable if `license_key_enabled` is `true`. Represents the maximum
       # number of times the license key can be activated.
+      #
+      # deprecated: use entitlements instead
       sig { returns(T.nilable(Integer)) }
       attr_accessor :license_key_activations_limit
 
@@ -80,6 +88,8 @@ module Dodopayments
       #
       # Only applicable if `license_key_enabled` is `true`. Represents the duration in
       # days for which the license key is valid.
+      #
+      # deprecated: use entitlements instead
       sig { returns(T.nilable(Dodopayments::LicenseKeyDuration)) }
       attr_reader :license_key_duration
 
@@ -95,6 +105,8 @@ module Dodopayments
       #
       # If `true`, additional fields related to license key (duration, activations
       # limit, activation message) become applicable.
+      #
+      # deprecated: use entitlements instead
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :license_key_enabled
 
@@ -136,7 +148,8 @@ module Dodopayments
             T.nilable(
               Dodopayments::ProductUpdateParams::DigitalProductDelivery::OrHash
             ),
-          entitlement_ids: T.nilable(T::Array[String]),
+          entitlements:
+            T.nilable(T::Array[Dodopayments::AttachProductEntitlement::OrHash]),
           image_id: T.nilable(String),
           license_key_activation_message: T.nilable(String),
           license_key_activations_limit: T.nilable(Integer),
@@ -168,31 +181,41 @@ module Dodopayments
         # Description of the product, optional and must be at most 1000 characters.
         description: nil,
         # Choose how you would like you digital product delivered
+        #
+        # deprecated: use entitlements instead
         digital_product_delivery: nil,
-        # Entitlement IDs to attach (replaces all existing when present) Send empty array
-        # to remove all, omit field to leave unchanged
-        entitlement_ids: nil,
+        # Entitlements to attach (replaces all existing when present) Send empty array to
+        # remove all, omit field to leave unchanged
+        entitlements: nil,
         # Product image id after its uploaded to S3
         image_id: nil,
         # Message sent to the customer upon license key activation.
         #
         # Only applicable if `license_key_enabled` is `true`. This message contains
         # instructions for activating the license key.
+        #
+        # deprecated: use entitlements instead
         license_key_activation_message: nil,
         # Limit for the number of activations for the license key.
         #
         # Only applicable if `license_key_enabled` is `true`. Represents the maximum
         # number of times the license key can be activated.
+        #
+        # deprecated: use entitlements instead
         license_key_activations_limit: nil,
         # Duration of the license key if enabled.
         #
         # Only applicable if `license_key_enabled` is `true`. Represents the duration in
         # days for which the license key is valid.
+        #
+        # deprecated: use entitlements instead
         license_key_duration: nil,
         # Whether the product requires a license key.
         #
         # If `true`, additional fields related to license key (duration, activations
         # limit, activation message) become applicable.
+        #
+        # deprecated: use entitlements instead
         license_key_enabled: nil,
         # Additional metadata for the product
         metadata: nil,
@@ -219,7 +242,8 @@ module Dodopayments
               T.nilable(
                 Dodopayments::ProductUpdateParams::DigitalProductDelivery
               ),
-            entitlement_ids: T.nilable(T::Array[String]),
+            entitlements:
+              T.nilable(T::Array[Dodopayments::AttachProductEntitlement]),
             image_id: T.nilable(String),
             license_key_activation_message: T.nilable(String),
             license_key_activations_limit: T.nilable(Integer),
@@ -265,6 +289,8 @@ module Dodopayments
         attr_accessor :instructions
 
         # Choose how you would like you digital product delivered
+        #
+        # deprecated: use entitlements instead
         sig do
           params(
             external_url: T.nilable(String),