dodopayments 2.18.0 → 2.19.0

data/rbi/dodopayments/models/customer_limited_details.rbi

@@ -24,10 +24,18 @@ module Dodopayments
       attr_accessor :name
 
       # Additional metadata associated with the customer
-      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants])
+        )
+      end
       attr_reader :metadata
 
-      sig { params(metadata: T::Hash[Symbol, String]).void }
+      sig do
+        params(
+          metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants]
+        ).void
+      end
       attr_writer :metadata
 
       # Phone number of the customer
@@ -39,7 +47,7 @@ module Dodopayments
           customer_id: String,
           email: String,
           name: String,
-          metadata: T::Hash[Symbol, String],
+          metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
           phone_number: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -63,7 +71,7 @@ module Dodopayments
             customer_id: String,
             email: String,
             name: String,
-            metadata: T::Hash[Symbol, String],
+            metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
             phone_number: T.nilable(String)
           }
         )

data/rbi/dodopayments/models/customer_list_entitlement_grants_params.rbi

@@ -0,0 +1,229 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class CustomerListEntitlementGrantsParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::CustomerListEntitlementGrantsParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :customer_id
+
+      # Filter by integration type (e.g. `feature_flag`)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::OrSymbol
+          )
+        )
+      end
+      attr_reader :integration_type
+
+      sig do
+        params(
+          integration_type:
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::OrSymbol
+        ).void
+      end
+      attr_writer :integration_type
+
+      # Page number (default 0)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Page size (default 10, max 100)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Filter by grant status
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::CustomerListEntitlementGrantsParams::Status::OrSymbol
+          )
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status:
+            Dodopayments::CustomerListEntitlementGrantsParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          customer_id: String,
+          integration_type:
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::OrSymbol,
+          page_number: Integer,
+          page_size: Integer,
+          status:
+            Dodopayments::CustomerListEntitlementGrantsParams::Status::OrSymbol,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        customer_id:,
+        # Filter by integration type (e.g. `feature_flag`)
+        integration_type: nil,
+        # Page number (default 0)
+        page_number: nil,
+        # Page size (default 10, max 100)
+        page_size: nil,
+        # Filter by grant status
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            customer_id: String,
+            integration_type:
+              Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::OrSymbol,
+            page_number: Integer,
+            page_size: Integer,
+            status:
+              Dodopayments::CustomerListEntitlementGrantsParams::Status::OrSymbol,
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Filter by integration type (e.g. `feature_flag`)
+      module IntegrationType
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DISCORD =
+          T.let(
+            :discord,
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::TaggedSymbol
+          )
+        TELEGRAM =
+          T.let(
+            :telegram,
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::TaggedSymbol
+          )
+        GITHUB =
+          T.let(
+            :github,
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::TaggedSymbol
+          )
+        FIGMA =
+          T.let(
+            :figma,
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::TaggedSymbol
+          )
+        FRAMER =
+          T.let(
+            :framer,
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::TaggedSymbol
+          )
+        NOTION =
+          T.let(
+            :notion,
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::TaggedSymbol
+          )
+        DIGITAL_FILES =
+          T.let(
+            :digital_files,
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::TaggedSymbol
+          )
+        LICENSE_KEY =
+          T.let(
+            :license_key,
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::TaggedSymbol
+          )
+        FEATURE_FLAG =
+          T.let(
+            :feature_flag,
+            Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::CustomerListEntitlementGrantsParams::IntegrationType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Filter by grant status
+      module Status
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::CustomerListEntitlementGrantsParams::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :Pending,
+            Dodopayments::CustomerListEntitlementGrantsParams::Status::TaggedSymbol
+          )
+        DELIVERED =
+          T.let(
+            :Delivered,
+            Dodopayments::CustomerListEntitlementGrantsParams::Status::TaggedSymbol
+          )
+        FAILED =
+          T.let(
+            :Failed,
+            Dodopayments::CustomerListEntitlementGrantsParams::Status::TaggedSymbol
+          )
+        REVOKED =
+          T.let(
+            :Revoked,
+            Dodopayments::CustomerListEntitlementGrantsParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::CustomerListEntitlementGrantsParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customer_update_params.rbi

@@ -21,7 +21,11 @@ module Dodopayments
       attr_accessor :email
 
       # Additional metadata for the customer
-      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants])
+        )
+      end
       attr_accessor :metadata
 
       sig { returns(T.nilable(String)) }
@@ -34,7 +38,8 @@ module Dodopayments
         params(
           customer_id: String,
           email: T.nilable(String),
-          metadata: T.nilable(T::Hash[Symbol, String]),
+          metadata:
+            T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
           name: T.nilable(String),
           phone_number: T.nilable(String),
           request_options: Dodopayments::RequestOptions::OrHash
@@ -56,7 +61,8 @@ module Dodopayments
           {
             customer_id: String,
             email: T.nilable(String),
-            metadata: T.nilable(T::Hash[Symbol, String]),
+            metadata:
+              T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
             name: T.nilable(String),
             phone_number: T.nilable(String),
             request_options: Dodopayments::RequestOptions

data/rbi/dodopayments/models/discount.rbi

@@ -28,7 +28,8 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :discount_id
 
-      sig { returns(T::Hash[Symbol, String]) }
+      # Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
+      sig { returns(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]) }
       attr_accessor :metadata
 
       # Whether this discount should be preserved when a subscription changes plans.
@@ -73,7 +74,7 @@ module Dodopayments
           code: String,
           created_at: Time,
           discount_id: String,
-          metadata: T::Hash[Symbol, String],
+          metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
           preserve_on_plan_change: T::Boolean,
           restricted_to: T::Array[String],
           times_used: Integer,
@@ -95,6 +96,7 @@ module Dodopayments
         created_at:,
         # The unique discount ID
         discount_id:,
+        # Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
         metadata:,
         # Whether this discount should be preserved when a subscription changes plans.
         # Default: false (discount is removed on plan change)
@@ -126,7 +128,7 @@ module Dodopayments
             code: String,
             created_at: Time,
             discount_id: String,
-            metadata: T::Hash[Symbol, String],
+            metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
             preserve_on_plan_change: T::Boolean,
             restricted_to: T::Array[String],
             times_used: Integer,

data/rbi/dodopayments/models/discount_create_params.rbi

@@ -37,10 +37,18 @@ module Dodopayments
       attr_accessor :expires_at
 
       # Additional metadata for the discount
-      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants])
+        )
+      end
       attr_reader :metadata
 
-      sig { params(metadata: T::Hash[Symbol, String]).void }
+      sig do
+        params(
+          metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants]
+        ).void
+      end
       attr_writer :metadata
 
       sig { returns(T.nilable(String)) }
@@ -74,7 +82,7 @@ module Dodopayments
           type: Dodopayments::DiscountType::OrSymbol,
           code: T.nilable(String),
           expires_at: T.nilable(Time),
-          metadata: T::Hash[Symbol, String],
+          metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
           name: T.nilable(String),
           preserve_on_plan_change: T::Boolean,
           restricted_to: T.nilable(T::Array[String]),
@@ -123,7 +131,7 @@ module Dodopayments
             type: Dodopayments::DiscountType::OrSymbol,
             code: T.nilable(String),
             expires_at: T.nilable(Time),
-            metadata: T::Hash[Symbol, String],
+            metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
             name: T.nilable(String),
             preserve_on_plan_change: T::Boolean,
             restricted_to: T.nilable(T::Array[String]),

data/rbi/dodopayments/models/discount_detail.rbi

@@ -29,7 +29,7 @@ module Dodopayments
       attr_accessor :discount_id
 
       # Additional metadata
-      sig { returns(T::Hash[Symbol, String]) }
+      sig { returns(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]) }
       attr_accessor :metadata
 
       # Position of this discount in the stack (0-based)
@@ -82,7 +82,7 @@ module Dodopayments
           code: String,
           created_at: Time,
           discount_id: String,
-          metadata: T::Hash[Symbol, String],
+          metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
           position: Integer,
           preserve_on_plan_change: T::Boolean,
           restricted_to: T::Array[String],
@@ -140,7 +140,7 @@ module Dodopayments
             code: String,
             created_at: Time,
             discount_id: String,
-            metadata: T::Hash[Symbol, String],
+            metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
             position: Integer,
             preserve_on_plan_change: T::Boolean,
             restricted_to: T::Array[String],

data/rbi/dodopayments/models/discount_update_params.rbi

@@ -32,7 +32,11 @@ module Dodopayments
       attr_accessor :expires_at
 
       # Additional metadata for the discount
-      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants])
+        )
+      end
       attr_accessor :metadata
 
       sig { returns(T.nilable(String)) }
@@ -67,7 +71,8 @@ module Dodopayments
           amount: T.nilable(Integer),
           code: T.nilable(String),
           expires_at: T.nilable(Time),
-          metadata: T.nilable(T::Hash[Symbol, String]),
+          metadata:
+            T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
           name: T.nilable(String),
           preserve_on_plan_change: T.nilable(T::Boolean),
           restricted_to: T.nilable(T::Array[String]),
@@ -114,7 +119,8 @@ module Dodopayments
             amount: T.nilable(Integer),
             code: T.nilable(String),
             expires_at: T.nilable(Time),
-            metadata: T.nilable(T::Hash[Symbol, String]),
+            metadata:
+              T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
             name: T.nilable(String),
             preserve_on_plan_change: T.nilable(T::Boolean),
             restricted_to: T.nilable(T::Array[String]),

data/rbi/dodopayments/models/entitlement.rbi

@@ -35,7 +35,7 @@ module Dodopayments
       attr_accessor :is_active
 
       # Arbitrary key-value metadata supplied at creation or via PATCH.
-      sig { returns(T::Hash[Symbol, String]) }
+      sig { returns(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]) }
       attr_accessor :metadata
 
       # Display name supplied at creation.
@@ -59,6 +59,7 @@ module Dodopayments
           created_at: Time,
           integration_config:
             T.any(
+              Dodopayments::IntegrationConfigResponse::FeatureFlagConfig::OrHash,
               Dodopayments::IntegrationConfigResponse::GitHubConfig::OrHash,
               Dodopayments::IntegrationConfigResponse::DiscordConfig::OrHash,
               Dodopayments::IntegrationConfigResponse::TelegramConfig::OrHash,
@@ -70,7 +71,7 @@ module Dodopayments
             ),
           integration_type: Dodopayments::EntitlementIntegrationType::OrSymbol,
           is_active: T::Boolean,
-          metadata: T::Hash[Symbol, String],
+          metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
           name: String,
           updated_at: Time,
           description: T.nilable(String)
@@ -113,7 +114,7 @@ module Dodopayments
             integration_type:
               Dodopayments::EntitlementIntegrationType::TaggedSymbol,
             is_active: T::Boolean,
-            metadata: T::Hash[Symbol, String],
+            metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
             name: String,
             updated_at: Time,
             description: T.nilable(String)

data/rbi/dodopayments/models/entitlement_create_params.rbi

@@ -18,6 +18,7 @@ module Dodopayments
       sig do
         returns(
           T.any(
+            Dodopayments::IntegrationConfig::FeatureFlagConfig,
             Dodopayments::IntegrationConfig::GitHubConfig,
             Dodopayments::IntegrationConfig::DiscordConfig,
             Dodopayments::IntegrationConfig::TelegramConfig,
@@ -44,16 +45,25 @@ module Dodopayments
       attr_accessor :description
 
       # Additional metadata for the entitlement
-      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants])
+        )
+      end
       attr_reader :metadata
 
-      sig { params(metadata: T::Hash[Symbol, String]).void }
+      sig do
+        params(
+          metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants]
+        ).void
+      end
       attr_writer :metadata
 
       sig do
         params(
           integration_config:
             T.any(
+              Dodopayments::IntegrationConfig::FeatureFlagConfig::OrHash,
               Dodopayments::IntegrationConfig::GitHubConfig::OrHash,
               Dodopayments::IntegrationConfig::DiscordConfig::OrHash,
               Dodopayments::IntegrationConfig::TelegramConfig::OrHash,
@@ -66,7 +76,7 @@ module Dodopayments
           integration_type: Dodopayments::EntitlementIntegrationType::OrSymbol,
           name: String,
           description: T.nilable(String),
-          metadata: T::Hash[Symbol, String],
+          metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -90,6 +100,7 @@ module Dodopayments
           {
             integration_config:
               T.any(
+                Dodopayments::IntegrationConfig::FeatureFlagConfig,
                 Dodopayments::IntegrationConfig::GitHubConfig,
                 Dodopayments::IntegrationConfig::DiscordConfig,
                 Dodopayments::IntegrationConfig::TelegramConfig,
@@ -103,7 +114,7 @@ module Dodopayments
               Dodopayments::EntitlementIntegrationType::OrSymbol,
             name: String,
             description: T.nilable(String),
-            metadata: T::Hash[Symbol, String],
+            metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
             request_options: Dodopayments::RequestOptions
           }
         )

data/rbi/dodopayments/models/entitlement_integration_type.rbi

@@ -31,6 +31,11 @@ module Dodopayments
           :license_key,
           Dodopayments::EntitlementIntegrationType::TaggedSymbol
         )
+      FEATURE_FLAG =
+        T.let(
+          :feature_flag,
+          Dodopayments::EntitlementIntegrationType::TaggedSymbol
+        )
 
       sig do
         override.returns(

data/rbi/dodopayments/models/entitlement_list_params.rbi

@@ -130,6 +130,11 @@ module Dodopayments
             :license_key,
             Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
           )
+        FEATURE_FLAG =
+          T.let(
+            :feature_flag,
+            Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/entitlement_update_params.rbi

@@ -22,10 +22,15 @@ module Dodopayments
 
       # Integration-specific configuration supplied when creating or updating an
       # entitlement. The shape required matches the entitlement's `integration_type`.
+      #
+      # Untagged enum: variants are matched in order. `FeatureFlag` must precede
+      # `LicenseKey`, whose fields are all optional and would otherwise match a
+      # `feature_flag` config.
       sig do
         returns(
           T.nilable(
             T.any(
+              Dodopayments::IntegrationConfig::FeatureFlagConfig,
               Dodopayments::IntegrationConfig::GitHubConfig,
               Dodopayments::IntegrationConfig::DiscordConfig,
               Dodopayments::IntegrationConfig::TelegramConfig,
@@ -40,7 +45,12 @@ module Dodopayments
       end
       attr_accessor :integration_config
 
-      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      # Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants])
+        )
+      end
       attr_accessor :metadata
 
       sig { returns(T.nilable(String)) }
@@ -53,6 +63,7 @@ module Dodopayments
           integration_config:
             T.nilable(
               T.any(
+                Dodopayments::IntegrationConfig::FeatureFlagConfig::OrHash,
                 Dodopayments::IntegrationConfig::GitHubConfig::OrHash,
                 Dodopayments::IntegrationConfig::DiscordConfig::OrHash,
                 Dodopayments::IntegrationConfig::TelegramConfig::OrHash,
@@ -63,7 +74,8 @@ module Dodopayments
                 Dodopayments::IntegrationConfig::LicenseKeyConfig::OrHash
               )
             ),
-          metadata: T.nilable(T::Hash[Symbol, String]),
+          metadata:
+            T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
           name: T.nilable(String),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -73,7 +85,12 @@ module Dodopayments
         description: nil,
         # Integration-specific configuration supplied when creating or updating an
         # entitlement. The shape required matches the entitlement's `integration_type`.
+        #
+        # Untagged enum: variants are matched in order. `FeatureFlag` must precede
+        # `LicenseKey`, whose fields are all optional and would otherwise match a
+        # `feature_flag` config.
         integration_config: nil,
+        # Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
         metadata: nil,
         name: nil,
         request_options: {}
@@ -88,6 +105,7 @@ module Dodopayments
             integration_config:
               T.nilable(
                 T.any(
+                  Dodopayments::IntegrationConfig::FeatureFlagConfig,
                   Dodopayments::IntegrationConfig::GitHubConfig,
                   Dodopayments::IntegrationConfig::DiscordConfig,
                   Dodopayments::IntegrationConfig::TelegramConfig,
@@ -98,7 +116,8 @@ module Dodopayments
                   Dodopayments::IntegrationConfig::LicenseKeyConfig
                 )
               ),
-            metadata: T.nilable(T::Hash[Symbol, String]),
+            metadata:
+              T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
             name: T.nilable(String),
             request_options: Dodopayments::RequestOptions
           }