dodopayments 1.22.0 → 1.47.0

data/rbi/dodopayments/models/product_update_files_response.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductUpdateFilesResponse < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::Models::ProductUpdateFilesResponse,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :file_id
+
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig { params(file_id: String, url: String).returns(T.attached_class) }
+      def self.new(file_id:, url:)
+      end
+
+      sig { override.returns({ file_id: String, url: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_update_params.rbi

@@ -6,14 +6,43 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductUpdateParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
       # Available Addons for subscription products
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :addons
 
+      sig { returns(T.nilable(String)) }
+      attr_accessor :brand_id
+
       # Description of the product, optional and must be at most 1000 characters.
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
+      # Choose how you would like you digital product delivered
+      sig do
+        returns(
+          T.nilable(Dodopayments::ProductUpdateParams::DigitalProductDelivery)
+        )
+      end
+      attr_reader :digital_product_delivery
+
+      sig do
+        params(
+          digital_product_delivery:
+            T.nilable(
+              Dodopayments::ProductUpdateParams::DigitalProductDelivery::OrHash
+            )
+        ).void
+      end
+      attr_writer :digital_product_delivery
+
       # Product image id after its uploaded to S3
       sig { returns(T.nilable(String)) }
       attr_accessor :image_id
@@ -32,14 +61,18 @@ module Dodopayments
       sig { returns(T.nilable(Integer)) }
       attr_accessor :license_key_activations_limit
 
-      sig { returns(T.nilable(Dodopayments::Models::LicenseKeyDuration)) }
+      # 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.
+      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
 
@@ -50,49 +83,67 @@ 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_accessor :metadata
+
       # Name of the product, optional and must be at most 100 characters.
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
+      # Price details of the product.
       sig do
         returns(
-          T.nilable(T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice))
+          T.nilable(
+            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(T.nilable(Dodopayments::Models::TaxCategory::OrSymbol)) }
+      # Tax category of the product.
+      sig { returns(T.nilable(Dodopayments::TaxCategory::OrSymbol)) }
       attr_accessor :tax_category
 
       sig do
         params(
           addons: T.nilable(T::Array[String]),
+          brand_id: T.nilable(String),
           description: T.nilable(String),
+          digital_product_delivery:
+            T.nilable(
+              Dodopayments::ProductUpdateParams::DigitalProductDelivery::OrHash
+            ),
           image_id: T.nilable(String),
           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.nilable(T::Hash[Symbol, String]),
           name: T.nilable(String),
-          price: T.nilable(
-            T.any(
-              Dodopayments::Models::Price::OneTimePrice,
-              Dodopayments::Internal::AnyHash,
-              Dodopayments::Models::Price::RecurringPrice
-            )
-          ),
-          tax_category: T.nilable(Dodopayments::Models::TaxCategory::OrSymbol),
-          request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          price:
+            T.nilable(
+              T.any(
+                Dodopayments::Price::OneTimePrice::OrHash,
+                Dodopayments::Price::RecurringPrice::OrHash
+              )
+            ),
+          tax_category: T.nilable(Dodopayments::TaxCategory::OrSymbol),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # Available Addons for subscription products
         addons: nil,
+        brand_id: nil,
         # Description of the product, optional and must be at most 1000 characters.
         description: nil,
+        # Choose how you would like you digital product delivered
+        digital_product_delivery: nil,
         # Product image id after its uploaded to S3
         image_id: nil,
         # Message sent to the customer upon license key activation.
@@ -105,39 +156,111 @@ module Dodopayments
         # Only applicable if `license_key_enabled` is `true`. Represents the maximum
         # number of times the license key can be activated.
         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.
         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.
         license_key_enabled: nil,
+        # Additional metadata for the product
+        metadata: nil,
         # Name of the product, optional and must be at most 100 characters.
         name: nil,
+        # Price details of the product.
         price: nil,
-        # Represents the different categories of taxation applicable to various products
-        # and services.
+        # Tax category of the product.
         tax_category: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
+        override.returns(
+          {
+            addons: T.nilable(T::Array[String]),
+            brand_id: T.nilable(String),
+            description: T.nilable(String),
+            digital_product_delivery:
+              T.nilable(
+                Dodopayments::ProductUpdateParams::DigitalProductDelivery
+              ),
+            image_id: T.nilable(String),
+            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.nilable(T::Hash[Symbol, String]),
+            name: T.nilable(String),
+            price:
+              T.nilable(
+                T.any(
+                  Dodopayments::Price::OneTimePrice,
+                  Dodopayments::Price::RecurringPrice
+                )
+              ),
+            tax_category: T.nilable(Dodopayments::TaxCategory::OrSymbol),
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class DigitalProductDelivery < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::ProductUpdateParams::DigitalProductDelivery,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # External URL to digital product
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_url
+
+        # Uploaded files ids of digital product
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :files
+
+        # 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),
+            files: T.nilable(T::Array[String]),
+            instructions: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # External URL to digital product
+          external_url: nil,
+          # Uploaded files ids of digital product
+          files: nil,
+          # Instructions to download and use the digital product
+          instructions: nil
+        )
+        end
+
+        sig do
+          override.returns(
             {
-              addons: T.nilable(T::Array[String]),
-              description: T.nilable(String),
-              image_id: 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),
-              price: T.nilable(T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice)),
-              tax_category: T.nilable(Dodopayments::Models::TaxCategory::OrSymbol),
-              request_options: Dodopayments::RequestOptions
+              external_url: T.nilable(String),
+              files: T.nilable(T::Array[String]),
+              instructions: T.nilable(String)
             }
           )
+        end
+        def to_hash
+        end
       end
-      def to_hash; end
     end
   end
 end

data/rbi/dodopayments/models/products/image_update_params.rbi

@@ -7,27 +7,39 @@ module Dodopayments
         extend Dodopayments::Internal::Type::RequestParameters::Converter
         include Dodopayments::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Products::ImageUpdateParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
         sig { returns(T.nilable(T::Boolean)) }
-        attr_accessor :force_update
+        attr_reader :force_update
+
+        sig { params(force_update: T::Boolean).void }
+        attr_writer :force_update
 
         sig do
           params(
-            force_update: T.nilable(T::Boolean),
-            request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash)
-          )
-            .returns(T.attached_class)
+            force_update: T::Boolean,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(force_update: nil, request_options: {})
         end
-        def self.new(force_update: nil, request_options: {}); end
 
         sig do
           override.returns(
             {
-              force_update: T.nilable(T::Boolean),
+              force_update: T::Boolean,
               request_options: Dodopayments::RequestOptions
             }
           )
         end
-        def to_hash; end
+        def to_hash
+        end
       end
     end
   end

data/rbi/dodopayments/models/products/image_update_response.rbi

@@ -4,17 +4,31 @@ module Dodopayments
   module Models
     module Products
       class ImageUpdateResponse < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Models::Products::ImageUpdateResponse,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
         sig { returns(String) }
         attr_accessor :url
 
         sig { returns(T.nilable(String)) }
         attr_accessor :image_id
 
-        sig { params(url: String, image_id: T.nilable(String)).returns(T.attached_class) }
-        def self.new(url:, image_id: nil); end
+        sig do
+          params(url: String, image_id: T.nilable(String)).returns(
+            T.attached_class
+          )
+        end
+        def self.new(url:, image_id: nil)
+        end
 
-        sig { override.returns({url: String, image_id: T.nilable(String)}) }
-        def to_hash; end
+        sig { override.returns({ url: String, image_id: T.nilable(String) }) }
+        def to_hash
+        end
       end
     end
   end

data/rbi/dodopayments/models/refund.rbi

@@ -3,6 +3,11 @@
 module Dodopayments
   module Models
     class Refund < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Dodopayments::Refund, Dodopayments::Internal::AnyHash)
+        end
+
       # The unique identifier of the business issuing the refund.
       sig { returns(String) }
       attr_accessor :business_id
@@ -11,6 +16,10 @@ module Dodopayments
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # If true the refund is a partial refund
+      sig { returns(T::Boolean) }
+      attr_accessor :is_partial
+
       # The unique identifier of the payment associated with the refund.
       sig { returns(String) }
       attr_accessor :payment_id
@@ -19,14 +28,16 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :refund_id
 
-      sig { returns(Dodopayments::Models::RefundStatus::TaggedSymbol) }
+      # The current status of the refund.
+      sig { returns(Dodopayments::RefundStatus::OrSymbol) }
       attr_accessor :status
 
       # The refunded amount.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :amount
 
-      sig { returns(T.nilable(Dodopayments::Models::Currency::TaggedSymbol)) }
+      # The currency of the refund, represented as an ISO 4217 currency code.
+      sig { returns(T.nilable(Dodopayments::Currency::OrSymbol)) }
       attr_accessor :currency
 
       # The reason provided for the refund, if any. Optional.
@@ -37,47 +48,54 @@ module Dodopayments
         params(
           business_id: String,
           created_at: Time,
+          is_partial: T::Boolean,
           payment_id: String,
           refund_id: String,
-          status: Dodopayments::Models::RefundStatus::OrSymbol,
+          status: Dodopayments::RefundStatus::OrSymbol,
           amount: T.nilable(Integer),
-          currency: T.nilable(Dodopayments::Models::Currency::OrSymbol),
+          currency: T.nilable(Dodopayments::Currency::OrSymbol),
           reason: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # The unique identifier of the business issuing the refund.
         business_id:,
         # The timestamp of when the refund was created in UTC.
         created_at:,
+        # If true the refund is a partial refund
+        is_partial:,
         # The unique identifier of the payment associated with the refund.
         payment_id:,
         # The unique identifier of the refund.
         refund_id:,
+        # The current status of the refund.
         status:,
         # The refunded amount.
         amount: nil,
+        # The currency of the refund, represented as an ISO 4217 currency code.
         currency: nil,
         # The reason provided for the refund, if any. Optional.
         reason: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              business_id: String,
-              created_at: Time,
-              payment_id: String,
-              refund_id: String,
-              status: Dodopayments::Models::RefundStatus::TaggedSymbol,
-              amount: T.nilable(Integer),
-              currency: T.nilable(Dodopayments::Models::Currency::TaggedSymbol),
-              reason: T.nilable(String)
-            }
-          )
+        override.returns(
+          {
+            business_id: String,
+            created_at: Time,
+            is_partial: T::Boolean,
+            payment_id: String,
+            refund_id: String,
+            status: Dodopayments::RefundStatus::OrSymbol,
+            amount: T.nilable(Integer),
+            currency: T.nilable(Dodopayments::Currency::OrSymbol),
+            reason: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/dodopayments/models/refund_create_params.rbi

@@ -6,10 +6,24 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::RefundCreateParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
       # The unique identifier of the payment to be refunded.
       sig { returns(String) }
       attr_accessor :payment_id
 
+      # Partially Refund an Individual Item
+      sig do
+        returns(T.nilable(T::Array[Dodopayments::RefundCreateParams::Item]))
+      end
+      attr_accessor :items
+
       # The reason for the refund, if any. Maximum length is 3000 characters. Optional.
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
@@ -17,27 +31,89 @@ module Dodopayments
       sig do
         params(
           payment_id: String,
+          items:
+            T.nilable(T::Array[Dodopayments::RefundCreateParams::Item::OrHash]),
           reason: 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(
         # The unique identifier of the payment to be refunded.
         payment_id:,
+        # Partially Refund an Individual Item
+        items: nil,
         # The reason for the refund, if any. Maximum length is 3000 characters. Optional.
         reason: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns({
-                     payment_id: String,
-                     reason: T.nilable(String),
-                     request_options: Dodopayments::RequestOptions
-                   })
+        override.returns(
+          {
+            payment_id: String,
+            items: T.nilable(T::Array[Dodopayments::RefundCreateParams::Item]),
+            reason: T.nilable(String),
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Item < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::RefundCreateParams::Item,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The id of the item (i.e. `product_id` or `addon_id`)
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The amount to refund. if None the whole item is refunded
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :amount
+
+        # Specify if tax is inclusive of the refund. Default true.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :tax_inclusive
+
+        sig { params(tax_inclusive: T::Boolean).void }
+        attr_writer :tax_inclusive
+
+        sig do
+          params(
+            item_id: String,
+            amount: T.nilable(Integer),
+            tax_inclusive: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The id of the item (i.e. `product_id` or `addon_id`)
+          item_id:,
+          # The amount to refund. if None the whole item is refunded
+          amount: nil,
+          # Specify if tax is inclusive of the refund. Default true.
+          tax_inclusive: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              item_id: String,
+              amount: T.nilable(Integer),
+              tax_inclusive: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
       end
-      def to_hash; end
     end
   end
 end