dodopayments 2.17.0 → 2.18.0

data/rbi/dodopayments/models/product_list_response.rbi

@@ -79,11 +79,7 @@ module Dodopayments
       # Pricing mode for localized pricing. NULL means base-only (no localized rules
       # apply).
       sig do
-        returns(
-          T.nilable(
-            Dodopayments::Models::ProductListResponse::PricingMode::TaggedSymbol
-          )
-        )
+        returns(T.nilable(Dodopayments::Products::PricingMode::TaggedSymbol))
       end
       attr_accessor :pricing_mode
 
@@ -116,9 +112,7 @@ module Dodopayments
               )
             ),
           pricing_mode:
-            T.nilable(
-              Dodopayments::Models::ProductListResponse::PricingMode::OrSymbol
-            ),
+            T.nilable(Dodopayments::Products::PricingMode::OrSymbol),
           tax_inclusive: T.nilable(T::Boolean)
         ).returns(T.attached_class)
       end
@@ -186,51 +180,13 @@ module Dodopayments
             price: T.nilable(Integer),
             price_detail: T.nilable(Dodopayments::Price::Variants),
             pricing_mode:
-              T.nilable(
-                Dodopayments::Models::ProductListResponse::PricingMode::TaggedSymbol
-              ),
+              T.nilable(Dodopayments::Products::PricingMode::TaggedSymbol),
             tax_inclusive: T.nilable(T::Boolean)
           }
         )
       end
       def to_hash
       end
-
-      # Pricing mode for localized pricing. NULL means base-only (no localized rules
-      # apply).
-      module PricingMode
-        extend Dodopayments::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Dodopayments::Models::ProductListResponse::PricingMode
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        BY_CURRENCY =
-          T.let(
-            :by_currency,
-            Dodopayments::Models::ProductListResponse::PricingMode::TaggedSymbol
-          )
-        BY_COUNTRY =
-          T.let(
-            :by_country,
-            Dodopayments::Models::ProductListResponse::PricingMode::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Dodopayments::Models::ProductListResponse::PricingMode::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/dodopayments/models/product_update_params.rbi

@@ -135,11 +135,7 @@ module Dodopayments
       # Update the pricing mode. Omit to leave unchanged; set to null to clear (which
       # archives all active localized rules for this product). Changing to a different
       # non-null mode also archives any rules whose mode doesn't match the new mode.
-      sig do
-        returns(
-          T.nilable(Dodopayments::ProductUpdateParams::PricingMode::OrSymbol)
-        )
-      end
+      sig { returns(T.nilable(Dodopayments::Products::PricingMode::OrSymbol)) }
       attr_accessor :pricing_mode
 
       # Tax category of the product.
@@ -177,7 +173,7 @@ module Dodopayments
               )
             ),
           pricing_mode:
-            T.nilable(Dodopayments::ProductUpdateParams::PricingMode::OrSymbol),
+            T.nilable(Dodopayments::Products::PricingMode::OrSymbol),
           tax_category: T.nilable(Dodopayments::TaxCategory::OrSymbol),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -276,9 +272,7 @@ module Dodopayments
                 )
               ),
             pricing_mode:
-              T.nilable(
-                Dodopayments::ProductUpdateParams::PricingMode::OrSymbol
-              ),
+              T.nilable(Dodopayments::Products::PricingMode::OrSymbol),
             tax_category: T.nilable(Dodopayments::TaxCategory::OrSymbol),
             request_options: Dodopayments::RequestOptions
           }
@@ -340,40 +334,6 @@ module Dodopayments
         def to_hash
         end
       end
-
-      # Update the pricing mode. Omit to leave unchanged; set to null to clear (which
-      # archives all active localized rules for this product). Changing to a different
-      # non-null mode also archives any rules whose mode doesn't match the new mode.
-      module PricingMode
-        extend Dodopayments::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Dodopayments::ProductUpdateParams::PricingMode)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        BY_CURRENCY =
-          T.let(
-            :by_currency,
-            Dodopayments::ProductUpdateParams::PricingMode::TaggedSymbol
-          )
-        BY_COUNTRY =
-          T.let(
-            :by_country,
-            Dodopayments::ProductUpdateParams::PricingMode::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Dodopayments::ProductUpdateParams::PricingMode::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/dodopayments/models/products/list_localized_prices_response.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Products
+      class ListLocalizedPricesResponse < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Products::ListLocalizedPricesResponse,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Array[Dodopayments::Products::LocalizedPrice]) }
+        attr_accessor :items
+
+        sig do
+          params(
+            items: T::Array[Dodopayments::Products::LocalizedPrice::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(items:)
+        end
+
+        sig do
+          override.returns(
+            { items: T::Array[Dodopayments::Products::LocalizedPrice] }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/products/localized_price.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Products
+      class LocalizedPrice < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Products::LocalizedPrice,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for the localized price.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Amount in the smallest currency unit (e.g., cents).
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # Timestamp when the localized price was created.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Currency to charge in.
+        sig { returns(Dodopayments::Currency::TaggedSymbol) }
+        attr_accessor :currency
+
+        # Pricing mode of the rule: by_currency or by_country.
+        sig { returns(Dodopayments::Products::PricingMode::TaggedSymbol) }
+        attr_accessor :mode
+
+        # Product this localized price belongs to.
+        sig { returns(String) }
+        attr_accessor :product_id
+
+        # Timestamp when the localized price was last updated.
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        # Country the rule applies to. Only set when mode is by_country.
+        sig { returns(T.nilable(Dodopayments::CountryCode::TaggedSymbol)) }
+        attr_accessor :country_code
+
+        sig do
+          params(
+            id: String,
+            amount: Integer,
+            created_at: Time,
+            currency: Dodopayments::Currency::OrSymbol,
+            mode: Dodopayments::Products::PricingMode::OrSymbol,
+            product_id: String,
+            updated_at: Time,
+            country_code: T.nilable(Dodopayments::CountryCode::OrSymbol)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for the localized price.
+          id:,
+          # Amount in the smallest currency unit (e.g., cents).
+          amount:,
+          # Timestamp when the localized price was created.
+          created_at:,
+          # Currency to charge in.
+          currency:,
+          # Pricing mode of the rule: by_currency or by_country.
+          mode:,
+          # Product this localized price belongs to.
+          product_id:,
+          # Timestamp when the localized price was last updated.
+          updated_at:,
+          # Country the rule applies to. Only set when mode is by_country.
+          country_code: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              amount: Integer,
+              created_at: Time,
+              currency: Dodopayments::Currency::TaggedSymbol,
+              mode: Dodopayments::Products::PricingMode::TaggedSymbol,
+              product_id: String,
+              updated_at: Time,
+              country_code: T.nilable(Dodopayments::CountryCode::TaggedSymbol)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/products/localized_price_archive_params.rbi

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

data/rbi/dodopayments/models/products/localized_price_create_params.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Products
+      class LocalizedPriceCreateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Products::LocalizedPriceCreateParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :product_id
+
+        # Amount in the smallest currency unit (e.g., cents). Must be greater than zero.
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # Currency to charge in. Must be a supported currency.
+        sig { returns(Dodopayments::Currency::OrSymbol) }
+        attr_accessor :currency
+
+        # Required when the product's pricing_mode is by_country; forbidden when
+        # by_currency.
+        sig { returns(T.nilable(Dodopayments::CountryCode::OrSymbol)) }
+        attr_accessor :country_code
+
+        sig do
+          params(
+            product_id: String,
+            amount: Integer,
+            currency: Dodopayments::Currency::OrSymbol,
+            country_code: T.nilable(Dodopayments::CountryCode::OrSymbol),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          product_id:,
+          # Amount in the smallest currency unit (e.g., cents). Must be greater than zero.
+          amount:,
+          # Currency to charge in. Must be a supported currency.
+          currency:,
+          # Required when the product's pricing_mode is by_country; forbidden when
+          # by_currency.
+          country_code: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              product_id: String,
+              amount: Integer,
+              currency: Dodopayments::Currency::OrSymbol,
+              country_code: T.nilable(Dodopayments::CountryCode::OrSymbol),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/products/localized_price_list_params.rbi

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

data/rbi/dodopayments/models/products/localized_price_retrieve_params.rbi

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

data/rbi/dodopayments/models/products/localized_price_update_params.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Products
+      class LocalizedPriceUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Products::LocalizedPriceUpdateParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :product_id
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # New amount in the smallest currency unit (e.g., cents). Must be greater than
+        # zero. The currency and country_code of an existing rule cannot be changed.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :amount
+
+        sig do
+          params(
+            product_id: String,
+            id: String,
+            amount: T.nilable(Integer),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          product_id:,
+          id:,
+          # New amount in the smallest currency unit (e.g., cents). Must be greater than
+          # zero. The currency and country_code of an existing rule cannot be changed.
+          amount: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              product_id: String,
+              id: String,
+              amount: T.nilable(Integer),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/products/pricing_mode.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Products
+      module PricingMode
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Dodopayments::Products::PricingMode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BY_CURRENCY =
+          T.let(:by_currency, Dodopayments::Products::PricingMode::TaggedSymbol)
+        BY_COUNTRY =
+          T.let(:by_country, Dodopayments::Products::PricingMode::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Dodopayments::Products::PricingMode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models.rbi

@@ -310,6 +310,12 @@ module Dodopayments
 
   LicenseValidateParams = Dodopayments::Models::LicenseValidateParams
 
+  Metadata =
+    T.let(
+      Dodopayments::Models::Metadata,
+      Dodopayments::Internal::Type::Converter
+    )
+
   Meter = Dodopayments::Models::Meter
 
   MeterAggregation = Dodopayments::Models::MeterAggregation

data/rbi/dodopayments/resources/checkout_sessions.rbi

@@ -116,7 +116,11 @@ module Dodopayments
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::CheckoutSessionStatus)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # Checkout Session ID
+        id,
+        request_options: {}
+      )
       end
 
       sig do

data/rbi/dodopayments/resources/entitlements/grants.rbi

@@ -35,6 +35,34 @@ module Dodopayments
         )
         end
 
+        # For entitlements whose license-key config uses `manual` fulfillment, grants are
+        # created in the `pending` state without a key. Call this endpoint to deliver the
+        # key: the grant moves to `delivered`, the customer is emailed the key, and the
+        # `license_key.created` and `entitlement_grant.delivered` webhook events are sent.
+        sig do
+          params(
+            grant_id: String,
+            key: String,
+            activations_limit: T.nilable(Integer),
+            expires_at: T.nilable(Time),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Entitlements::EntitlementGrant)
+        end
+        def fulfill_license_key(
+          # Grant ID
+          grant_id,
+          # The license key value to deliver to the customer.
+          key:,
+          # Per-key activation limit. Defaults to the entitlement's license-key
+          # configuration.
+          activations_limit: nil,
+          # When the key expires. Defaults to the duration in the entitlement's license-key
+          # configuration.
+          expires_at: nil,
+          request_options: {}
+        )
+        end
+
         # Revoke a single grant. Idempotent: re-revoking an already-revoked grant returns
         # the grant in its current state.
         sig do

data/rbi/dodopayments/resources/invoices/payments.rbi

@@ -10,7 +10,11 @@ module Dodopayments
             request_options: Dodopayments::RequestOptions::OrHash
           ).returns(StringIO)
         end
-        def retrieve(payment_id, request_options: {})
+        def retrieve(
+          # Payment ID
+          payment_id,
+          request_options: {}
+        )
         end
 
         sig do
@@ -19,7 +23,11 @@ module Dodopayments
             request_options: Dodopayments::RequestOptions::OrHash
           ).returns(StringIO)
         end
-        def retrieve_payout(payout_id, request_options: {})
+        def retrieve_payout(
+          # Payout ID
+          payout_id,
+          request_options: {}
+        )
         end
 
         sig do
@@ -28,7 +36,11 @@ module Dodopayments
             request_options: Dodopayments::RequestOptions::OrHash
           ).returns(StringIO)
         end
-        def retrieve_refund(refund_id, request_options: {})
+        def retrieve_refund(
+          # Refund ID
+          refund_id,
+          request_options: {}
+        )
         end
 
         # @api private