dodopayments 1.20.0 → 1.47.0

data/rbi/dodopayments/resources/payments.rbi

@@ -5,27 +5,29 @@ module Dodopayments
     class Payments
       sig do
         params(
-          billing: T.any(Dodopayments::Models::BillingAddress, Dodopayments::Internal::AnyHash),
-          customer: T.any(
-            Dodopayments::Models::AttachExistingCustomer,
-            Dodopayments::Internal::AnyHash,
-            Dodopayments::Models::CreateNewCustomer
-          ),
-          product_cart: T::Array[T.any(Dodopayments::Models::OneTimeProductCartItem, Dodopayments::Internal::AnyHash)],
-          allowed_payment_method_types: T.nilable(T::Array[Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType::OrSymbol]),
-          billing_currency: T.nilable(Dodopayments::Models::Currency::OrSymbol),
+          billing: Dodopayments::BillingAddress::OrHash,
+          customer:
+            T.any(
+              Dodopayments::AttachExistingCustomer::OrHash,
+              Dodopayments::NewCustomer::OrHash
+            ),
+          product_cart: T::Array[Dodopayments::OneTimeProductCartItem::OrHash],
+          allowed_payment_method_types:
+            T.nilable(T::Array[Dodopayments::PaymentMethodTypes::OrSymbol]),
+          billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
           discount_code: T.nilable(String),
           metadata: T::Hash[Symbol, String],
           payment_link: T.nilable(T::Boolean),
           return_url: T.nilable(String),
           show_saved_payment_methods: T::Boolean,
           tax_id: T.nilable(String),
-          request_options: Dodopayments::RequestOpts
-        )
-          .returns(Dodopayments::Models::PaymentCreateResponse)
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Models::PaymentCreateResponse)
       end
       def create(
+        # Billing address details for the payment
         billing:,
+        # Customer information for the payment
         customer:,
         # List of products in the cart. Must contain at least 1 and at most 100 items.
         product_cart:,
@@ -36,9 +38,13 @@ module Dodopayments
         # Availability still depends on other factors (e.g., customer location, merchant
         # settings).
         allowed_payment_method_types: nil,
+        # Fix the currency in which the end customer is billed. If Dodo Payments cannot
+        # support that currency for this transaction, it will not proceed
         billing_currency: nil,
         # Discount Code to apply to the transaction
         discount_code: nil,
+        # Additional metadata associated with the payment. Defaults to empty if not
+        # provided.
         metadata: nil,
         # Whether to generate a payment link. Defaults to false if not specified.
         payment_link: nil,
@@ -51,30 +57,42 @@ module Dodopayments
         # creation will fail
         tax_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        params(payment_id: String, request_options: Dodopayments::RequestOpts)
-          .returns(Dodopayments::Models::Payment)
+        params(
+          payment_id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Payment)
       end
       def retrieve(
         # Payment Id
         payment_id,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
         params(
-          created_at_gte: T.nilable(Time),
-          created_at_lte: T.nilable(Time),
-          customer_id: T.nilable(String),
-          page_number: T.nilable(Integer),
-          page_size: T.nilable(Integer),
-          status: T.nilable(Dodopayments::Models::IntentStatus::OrSymbol),
-          subscription_id: T.nilable(String),
-          request_options: Dodopayments::RequestOpts
+          brand_id: String,
+          created_at_gte: Time,
+          created_at_lte: Time,
+          customer_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          status: Dodopayments::PaymentListParams::Status::OrSymbol,
+          subscription_id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(
+          Dodopayments::Internal::DefaultPageNumberPagination[
+            Dodopayments::Models::PaymentListResponse
+          ]
         )
-          .returns(Dodopayments::Internal::DefaultPageNumberPagination[Dodopayments::Models::PaymentListResponse])
       end
       def list(
+        # filter by Brand id
+        brand_id: nil,
         # Get events after this created time
         created_at_gte: nil,
         # Get events created before this time
@@ -90,10 +108,26 @@ module Dodopayments
         # Filter by subscription id
         subscription_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
+      sig do
+        params(
+          payment_id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Models::PaymentRetrieveLineItemsResponse)
+      end
+      def retrieve_line_items(
+        # Payment Id
+        payment_id,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Dodopayments::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/dodopayments/resources/payouts.rbi

@@ -5,11 +5,14 @@ module Dodopayments
     class Payouts
       sig do
         params(
-          page_number: T.nilable(Integer),
-          page_size: T.nilable(Integer),
-          request_options: Dodopayments::RequestOpts
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(
+          Dodopayments::Internal::DefaultPageNumberPagination[
+            Dodopayments::Models::PayoutListResponse
+          ]
         )
-          .returns(Dodopayments::Internal::DefaultPageNumberPagination[Dodopayments::Models::PayoutListResponse])
       end
       def list(
         # Page number default is 0
@@ -17,10 +20,13 @@ module Dodopayments
         # Page size default is 10 max is 100
         page_size: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # @api private
       sig { params(client: Dodopayments::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/dodopayments/resources/products/images.rbi

@@ -5,18 +5,24 @@ module Dodopayments
     class Products
       class Images
         sig do
-          params(id: String, force_update: T.nilable(T::Boolean), request_options: Dodopayments::RequestOpts)
-            .returns(Dodopayments::Models::Products::ImageUpdateResponse)
+          params(
+            id: String,
+            force_update: T::Boolean,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Models::Products::ImageUpdateResponse)
         end
         def update(
           # Product Id
           id,
           force_update: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Dodopayments::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/dodopayments/resources/products.rbi

@@ -8,78 +8,111 @@ module Dodopayments
 
       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: Dodopayments::RequestOpts
-        )
-          .returns(Dodopayments::Models::Product)
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Product)
       end
       def create(
+        # 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
-      sig { params(id: String, request_options: Dodopayments::RequestOpts).returns(Dodopayments::Models::Product) }
+      )
+      end
+
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Product)
+      end
       def retrieve(
         # Product Id
         id,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
         params(
           id: String,
           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: Dodopayments::RequestOpts
-        )
-          .void
+          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
+        ).void
       end
       def update(
         id,
         # 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.
@@ -92,33 +125,47 @@ 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
         params(
           archived: T::Boolean,
-          page_number: T.nilable(Integer),
-          page_size: T.nilable(Integer),
-          recurring: T.nilable(T::Boolean),
-          request_options: Dodopayments::RequestOpts
+          brand_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          recurring: T::Boolean,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(
+          Dodopayments::Internal::DefaultPageNumberPagination[
+            Dodopayments::Models::ProductListResponse
+          ]
         )
-          .returns(Dodopayments::Internal::DefaultPageNumberPagination[Dodopayments::Models::ProductListResponse])
       end
       def list(
         # 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
@@ -130,16 +177,46 @@ module Dodopayments
         # - `null` or absent: Show both types of products
         recurring: nil,
         request_options: {}
-      ); end
-      sig { params(id: String, request_options: Dodopayments::RequestOpts).void }
-      def delete(id, request_options: {}); end
+      )
+      end
 
-      sig { params(id: String, request_options: Dodopayments::RequestOpts).void }
-      def unarchive(id, request_options: {}); end
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).void
+      end
+      def delete(id, request_options: {})
+      end
+
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).void
+      end
+      def unarchive(id, request_options: {})
+      end
+
+      sig do
+        params(
+          id: String,
+          file_name: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Models::ProductUpdateFilesResponse)
+      end
+      def update_files(
+        # Product Id
+        id,
+        file_name:,
+        request_options: {}
+      )
+      end
 
       # @api private
       sig { params(client: Dodopayments::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/dodopayments/resources/refunds.rbi

@@ -4,35 +4,52 @@ module Dodopayments
   module Resources
     class Refunds
       sig do
-        params(payment_id: String, reason: T.nilable(String), request_options: Dodopayments::RequestOpts)
-          .returns(Dodopayments::Models::Refund)
+        params(
+          payment_id: String,
+          items:
+            T.nilable(T::Array[Dodopayments::RefundCreateParams::Item::OrHash]),
+          reason: T.nilable(String),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Refund)
       end
       def create(
         # 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
-        params(refund_id: String, request_options: Dodopayments::RequestOpts).returns(Dodopayments::Models::Refund)
+        params(
+          refund_id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Refund)
       end
       def retrieve(
         # Refund Id
         refund_id,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
         params(
-          created_at_gte: T.nilable(Time),
-          created_at_lte: T.nilable(Time),
-          customer_id: T.nilable(String),
-          page_number: T.nilable(Integer),
-          page_size: T.nilable(Integer),
-          status: T.nilable(Dodopayments::Models::RefundStatus::OrSymbol),
-          request_options: Dodopayments::RequestOpts
+          created_at_gte: Time,
+          created_at_lte: Time,
+          customer_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          status: Dodopayments::RefundListParams::Status::OrSymbol,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(
+          Dodopayments::Internal::DefaultPageNumberPagination[
+            Dodopayments::Refund
+          ]
         )
-          .returns(Dodopayments::Internal::DefaultPageNumberPagination[Dodopayments::Models::Refund])
       end
       def list(
         # Get events after this created time
@@ -48,10 +65,13 @@ module Dodopayments
         # Filter by status
         status: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # @api private
       sig { params(client: Dodopayments::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end