dodopayments 1.22.0 → 1.47.0

data/rbi/dodopayments/models/product_create_params.rbi

@@ -6,22 +6,59 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      sig { returns(T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice)) }
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductCreateParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Price configuration for the product
+      sig do
+        returns(
+          T.any(
+            Dodopayments::Price::OneTimePrice,
+            Dodopayments::Price::RecurringPrice
+          )
+        )
+      end
       attr_accessor :price
 
-      # Represents the different categories of taxation applicable to various products
-      # and services.
-      sig { returns(Dodopayments::Models::TaxCategory::OrSymbol) }
+      # Tax category applied to this product
+      sig { returns(Dodopayments::TaxCategory::OrSymbol) }
       attr_accessor :tax_category
 
       # Addons available for subscription product
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :addons
 
+      # Brand id for the product, if not provided will default to primary brand
+      sig { returns(T.nilable(String)) }
+      attr_accessor :brand_id
+
       # Optional description of the product
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
+      # Choose how you would like you digital product delivered
+      sig do
+        returns(
+          T.nilable(Dodopayments::ProductCreateParams::DigitalProductDelivery)
+        )
+      end
+      attr_reader :digital_product_delivery
+
+      sig do
+        params(
+          digital_product_delivery:
+            T.nilable(
+              Dodopayments::ProductCreateParams::DigitalProductDelivery::OrHash
+            )
+        ).void
+      end
+      attr_writer :digital_product_delivery
+
       # Optional message displayed during license key activation
       sig { returns(T.nilable(String)) }
       attr_accessor :license_key_activation_message
@@ -30,14 +67,17 @@ module Dodopayments
       sig { returns(T.nilable(Integer)) }
       attr_accessor :license_key_activations_limit
 
-      sig { returns(T.nilable(Dodopayments::Models::LicenseKeyDuration)) }
+      # Duration configuration for the license key. Set to null if you don't want the
+      # license key to expire. For subscriptions, the lifetime of the license key is
+      # tied to the subscription period
+      sig { returns(T.nilable(Dodopayments::LicenseKeyDuration)) }
       attr_reader :license_key_duration
 
       sig do
         params(
-          license_key_duration: T.nilable(T.any(Dodopayments::Models::LicenseKeyDuration, Dodopayments::Internal::AnyHash))
-        )
-          .void
+          license_key_duration:
+            T.nilable(Dodopayments::LicenseKeyDuration::OrHash)
+        ).void
       end
       attr_writer :license_key_duration
 
@@ -45,67 +85,142 @@ module Dodopayments
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :license_key_enabled
 
+      # Additional metadata for the product
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
       # Optional name of the product
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
       sig do
         params(
-          price: T.any(
-            Dodopayments::Models::Price::OneTimePrice,
-            Dodopayments::Internal::AnyHash,
-            Dodopayments::Models::Price::RecurringPrice
-          ),
-          tax_category: Dodopayments::Models::TaxCategory::OrSymbol,
+          price:
+            T.any(
+              Dodopayments::Price::OneTimePrice::OrHash,
+              Dodopayments::Price::RecurringPrice::OrHash
+            ),
+          tax_category: Dodopayments::TaxCategory::OrSymbol,
           addons: T.nilable(T::Array[String]),
+          brand_id: T.nilable(String),
           description: T.nilable(String),
+          digital_product_delivery:
+            T.nilable(
+              Dodopayments::ProductCreateParams::DigitalProductDelivery::OrHash
+            ),
           license_key_activation_message: T.nilable(String),
           license_key_activations_limit: T.nilable(Integer),
-          license_key_duration: T.nilable(T.any(Dodopayments::Models::LicenseKeyDuration, Dodopayments::Internal::AnyHash)),
+          license_key_duration:
+            T.nilable(Dodopayments::LicenseKeyDuration::OrHash),
           license_key_enabled: T.nilable(T::Boolean),
+          metadata: T::Hash[Symbol, String],
           name: T.nilable(String),
-          request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
+        # Price configuration for the product
         price:,
-        # Represents the different categories of taxation applicable to various products
-        # and services.
+        # Tax category applied to this product
         tax_category:,
         # Addons available for subscription product
         addons: nil,
+        # Brand id for the product, if not provided will default to primary brand
+        brand_id: nil,
         # Optional description of the product
         description: nil,
+        # Choose how you would like you digital product delivered
+        digital_product_delivery: nil,
         # Optional message displayed during license key activation
         license_key_activation_message: nil,
         # The number of times the license key can be activated. Must be 0 or greater
         license_key_activations_limit: nil,
+        # Duration configuration for the license key. Set to null if you don't want the
+        # license key to expire. For subscriptions, the lifetime of the license key is
+        # tied to the subscription period
         license_key_duration: nil,
         # When true, generates and sends a license key to your customer. Defaults to false
         license_key_enabled: nil,
+        # Additional metadata for the product
+        metadata: nil,
         # Optional name of the product
         name: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              price: T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice),
-              tax_category: Dodopayments::Models::TaxCategory::OrSymbol,
-              addons: T.nilable(T::Array[String]),
-              description: T.nilable(String),
-              license_key_activation_message: T.nilable(String),
-              license_key_activations_limit: T.nilable(Integer),
-              license_key_duration: T.nilable(Dodopayments::Models::LicenseKeyDuration),
-              license_key_enabled: T.nilable(T::Boolean),
-              name: T.nilable(String),
-              request_options: Dodopayments::RequestOptions
-            }
+        override.returns(
+          {
+            price:
+              T.any(
+                Dodopayments::Price::OneTimePrice,
+                Dodopayments::Price::RecurringPrice
+              ),
+            tax_category: Dodopayments::TaxCategory::OrSymbol,
+            addons: T.nilable(T::Array[String]),
+            brand_id: T.nilable(String),
+            description: T.nilable(String),
+            digital_product_delivery:
+              T.nilable(
+                Dodopayments::ProductCreateParams::DigitalProductDelivery
+              ),
+            license_key_activation_message: T.nilable(String),
+            license_key_activations_limit: T.nilable(Integer),
+            license_key_duration: T.nilable(Dodopayments::LicenseKeyDuration),
+            license_key_enabled: T.nilable(T::Boolean),
+            metadata: T::Hash[Symbol, String],
+            name: T.nilable(String),
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class DigitalProductDelivery < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::ProductCreateParams::DigitalProductDelivery,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # External URL to digital product
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_url
+
+        # Instructions to download and use the digital product
+        sig { returns(T.nilable(String)) }
+        attr_accessor :instructions
+
+        # Choose how you would like you digital product delivered
+        sig do
+          params(
+            external_url: T.nilable(String),
+            instructions: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # External URL to digital product
+          external_url: nil,
+          # Instructions to download and use the digital product
+          instructions: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { external_url: T.nilable(String), instructions: T.nilable(String) }
           )
+        end
+        def to_hash
+        end
       end
-      def to_hash; end
     end
   end
 end

data/rbi/dodopayments/models/product_delete_params.rbi

@@ -6,14 +6,27 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductDeleteParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
       sig do
-        params(request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Dodopayments::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Dodopayments::RequestOptions}) }
-      def to_hash; end
+      sig do
+        override.returns({ request_options: Dodopayments::RequestOptions })
+      end
+      def to_hash
+      end
     end
   end
 end

data/rbi/dodopayments/models/product_list_params.rbi

@@ -6,6 +6,14 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductListParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
       # List archived products
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :archived
@@ -13,13 +21,26 @@ module Dodopayments
       sig { params(archived: T::Boolean).void }
       attr_writer :archived
 
+      # filter by Brand id
+      sig { returns(T.nilable(String)) }
+      attr_reader :brand_id
+
+      sig { params(brand_id: String).void }
+      attr_writer :brand_id
+
       # Page number default is 0
       sig { returns(T.nilable(Integer)) }
-      attr_accessor :page_number
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
 
       # Page size default is 10 max is 100
       sig { returns(T.nilable(Integer)) }
-      attr_accessor :page_size
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
 
       # Filter products by pricing type:
       #
@@ -27,21 +48,26 @@ module Dodopayments
       # - `false`: Show only one-time price products
       # - `null` or absent: Show both types of products
       sig { returns(T.nilable(T::Boolean)) }
-      attr_accessor :recurring
+      attr_reader :recurring
+
+      sig { params(recurring: T::Boolean).void }
+      attr_writer :recurring
 
       sig do
         params(
           archived: T::Boolean,
-          page_number: T.nilable(Integer),
-          page_size: T.nilable(Integer),
-          recurring: T.nilable(T::Boolean),
-          request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          brand_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          recurring: T::Boolean,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # List archived products
         archived: nil,
+        # filter by Brand id
+        brand_id: nil,
         # Page number default is 0
         page_number: nil,
         # Page size default is 10 max is 100
@@ -53,20 +79,23 @@ module Dodopayments
         # - `null` or absent: Show both types of products
         recurring: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              archived: T::Boolean,
-              page_number: T.nilable(Integer),
-              page_size: T.nilable(Integer),
-              recurring: T.nilable(T::Boolean),
-              request_options: Dodopayments::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            archived: T::Boolean,
+            brand_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            recurring: T::Boolean,
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/dodopayments/models/product_list_response.rbi

@@ -3,6 +3,14 @@
 module Dodopayments
   module Models
     class ProductListResponse < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::Models::ProductListResponse,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
       # Unique identifier for the business to which the product belongs.
       sig { returns(String) }
       attr_accessor :business_id
@@ -15,20 +23,24 @@ module Dodopayments
       sig { returns(T::Boolean) }
       attr_accessor :is_recurring
 
+      # Additional custom data associated with the product
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :metadata
+
       # Unique identifier for the product.
       sig { returns(String) }
       attr_accessor :product_id
 
-      # Represents the different categories of taxation applicable to various products
-      # and services.
-      sig { returns(Dodopayments::Models::TaxCategory::TaggedSymbol) }
+      # Tax category associated with the product.
+      sig { returns(Dodopayments::TaxCategory::TaggedSymbol) }
       attr_accessor :tax_category
 
       # Timestamp when the product was last updated.
       sig { returns(Time) }
       attr_accessor :updated_at
 
-      sig { returns(T.nilable(Dodopayments::Models::Currency::TaggedSymbol)) }
+      # Currency of the price
+      sig { returns(T.nilable(Dodopayments::Currency::TaggedSymbol)) }
       attr_accessor :currency
 
       # Description of the product, optional.
@@ -56,11 +68,8 @@ module Dodopayments
       sig { returns(T.nilable(Integer)) }
       attr_accessor :price
 
-      sig do
-        returns(
-          T.nilable(T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice))
-        )
-      end
+      # Details of the price
+      sig { returns(T.nilable(Dodopayments::Price::Variants)) }
       attr_accessor :price_detail
 
       # Indicates if the price is tax inclusive
@@ -72,24 +81,24 @@ module Dodopayments
           business_id: String,
           created_at: Time,
           is_recurring: T::Boolean,
+          metadata: T::Hash[Symbol, String],
           product_id: String,
-          tax_category: Dodopayments::Models::TaxCategory::OrSymbol,
+          tax_category: Dodopayments::TaxCategory::OrSymbol,
           updated_at: Time,
-          currency: T.nilable(Dodopayments::Models::Currency::OrSymbol),
+          currency: T.nilable(Dodopayments::Currency::OrSymbol),
           description: T.nilable(String),
           image: T.nilable(String),
           name: T.nilable(String),
           price: T.nilable(Integer),
-          price_detail: T.nilable(
-            T.any(
-              Dodopayments::Models::Price::OneTimePrice,
-              Dodopayments::Internal::AnyHash,
-              Dodopayments::Models::Price::RecurringPrice
-            )
-          ),
+          price_detail:
+            T.nilable(
+              T.any(
+                Dodopayments::Price::OneTimePrice::OrHash,
+                Dodopayments::Price::RecurringPrice::OrHash
+              )
+            ),
           tax_inclusive: T.nilable(T::Boolean)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # Unique identifier for the business to which the product belongs.
@@ -98,13 +107,15 @@ module Dodopayments
         created_at:,
         # Indicates if the product is recurring (e.g., subscriptions).
         is_recurring:,
+        # Additional custom data associated with the product
+        metadata:,
         # Unique identifier for the product.
         product_id:,
-        # Represents the different categories of taxation applicable to various products
-        # and services.
+        # Tax category associated with the product.
         tax_category:,
         # Timestamp when the product was last updated.
         updated_at:,
+        # Currency of the price
         currency: nil,
         # Description of the product, optional.
         description: nil,
@@ -123,31 +134,35 @@ module Dodopayments
         #
         # This ensures precision and avoids floating-point rounding errors.
         price: nil,
+        # Details of the price
         price_detail: nil,
         # Indicates if the price is tax inclusive
         tax_inclusive: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              business_id: String,
-              created_at: Time,
-              is_recurring: T::Boolean,
-              product_id: String,
-              tax_category: Dodopayments::Models::TaxCategory::TaggedSymbol,
-              updated_at: Time,
-              currency: T.nilable(Dodopayments::Models::Currency::TaggedSymbol),
-              description: T.nilable(String),
-              image: T.nilable(String),
-              name: T.nilable(String),
-              price: T.nilable(Integer),
-              price_detail: T.nilable(T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice)),
-              tax_inclusive: T.nilable(T::Boolean)
-            }
-          )
+        override.returns(
+          {
+            business_id: String,
+            created_at: Time,
+            is_recurring: T::Boolean,
+            metadata: T::Hash[Symbol, String],
+            product_id: String,
+            tax_category: Dodopayments::TaxCategory::TaggedSymbol,
+            updated_at: Time,
+            currency: T.nilable(Dodopayments::Currency::TaggedSymbol),
+            description: T.nilable(String),
+            image: T.nilable(String),
+            name: T.nilable(String),
+            price: T.nilable(Integer),
+            price_detail: T.nilable(Dodopayments::Price::Variants),
+            tax_inclusive: T.nilable(T::Boolean)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/dodopayments/models/product_retrieve_params.rbi

@@ -6,14 +6,27 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductRetrieveParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
       sig do
-        params(request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Dodopayments::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Dodopayments::RequestOptions}) }
-      def to_hash; end
+      sig do
+        override.returns({ request_options: Dodopayments::RequestOptions })
+      end
+      def to_hash
+      end
     end
   end
 end

data/rbi/dodopayments/models/product_unarchive_params.rbi

@@ -6,14 +6,27 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductUnarchiveParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
       sig do
-        params(request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Dodopayments::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Dodopayments::RequestOptions}) }
-      def to_hash; end
+      sig do
+        override.returns({ request_options: Dodopayments::RequestOptions })
+      end
+      def to_hash
+      end
     end
   end
 end

data/rbi/dodopayments/models/product_update_files_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductUpdateFilesParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductUpdateFilesParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :file_name
+
+      sig do
+        params(
+          file_name: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(file_name:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { file_name: String, request_options: Dodopayments::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end