dodopayments 2.17.1 → 2.18.0

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/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/products/localized_prices.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Products
+      class LocalizedPrices
+        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(Dodopayments::Products::LocalizedPrice)
+        end
+        def create(
+          # Product Id
+          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
+          params(
+            id: String,
+            product_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Products::LocalizedPrice)
+        end
+        def retrieve(
+          # Localized Price Id
+          id,
+          # Product Id
+          product_id:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          params(
+            id: String,
+            product_id: String,
+            amount: T.nilable(Integer),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Products::LocalizedPrice)
+        end
+        def update(
+          # Path param: Localized Price Id
+          id,
+          # Path param: Product Id
+          product_id:,
+          # Body param: 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
+          params(
+            product_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Products::ListLocalizedPricesResponse)
+        end
+        def list(
+          # Product Id
+          product_id,
+          request_options: {}
+        )
+        end
+
+        sig do
+          params(
+            id: String,
+            product_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).void
+        end
+        def archive(
+          # Localized Price Id
+          id,
+          # Product Id
+          product_id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/products.rbi

@@ -9,6 +9,9 @@ module Dodopayments
       sig { returns(Dodopayments::Resources::Products::ShortLinks) }
       attr_reader :short_links
 
+      sig { returns(Dodopayments::Resources::Products::LocalizedPrices) }
+      attr_reader :localized_prices
+
       sig do
         params(
           name: String,
@@ -37,7 +40,7 @@ module Dodopayments
           license_key_enabled: T.nilable(T::Boolean),
           metadata: T::Hash[Symbol, String],
           pricing_mode:
-            T.nilable(Dodopayments::ProductCreateParams::PricingMode::OrSymbol),
+            T.nilable(Dodopayments::Products::PricingMode::OrSymbol),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Product)
       end
@@ -139,7 +142,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
         ).void

data/sig/dodopayments/models/checkout_session_request.rbs

@@ -17,7 +17,7 @@ module Dodopayments
         feature_flags: Dodopayments::CheckoutSessionFlags,
         :force_3ds => bool?,
         mandate_min_amount_inr_paise: Integer?,
-        metadata: ::Hash[Symbol, String]?,
+        metadata: Dodopayments::Models::metadata?,
         minimal_address: bool,
         payment_method_id: String?,
         product_collection_id: String?,
@@ -69,7 +69,7 @@ module Dodopayments
 
       attr_accessor mandate_min_amount_inr_paise: Integer?
 
-      attr_accessor metadata: ::Hash[Symbol, String]?
+      attr_accessor metadata: Dodopayments::Models::metadata?
 
       attr_reader minimal_address: bool?
 
@@ -109,7 +109,7 @@ module Dodopayments
         ?feature_flags: Dodopayments::CheckoutSessionFlags,
         ?force_3ds: bool?,
         ?mandate_min_amount_inr_paise: Integer?,
-        ?metadata: ::Hash[Symbol, String]?,
+        ?metadata: Dodopayments::Models::metadata?,
         ?minimal_address: bool,
         ?payment_method_id: String?,
         ?product_collection_id: String?,
@@ -136,7 +136,7 @@ module Dodopayments
         feature_flags: Dodopayments::CheckoutSessionFlags,
         :force_3ds => bool?,
         mandate_min_amount_inr_paise: Integer?,
-        metadata: ::Hash[Symbol, String]?,
+        metadata: Dodopayments::Models::metadata?,
         minimal_address: bool,
         payment_method_id: String?,
         product_collection_id: String?,

data/sig/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rbs

@@ -9,7 +9,7 @@ module Dodopayments
           entry_type: Dodopayments::Models::CreditEntitlements::ledger_entry_type,
           expires_at: Time?,
           idempotency_key: String?,
-          metadata: ::Hash[Symbol, String]?,
+          metadata: Dodopayments::Models::metadata?,
           reason: String?
         }
         & Dodopayments::Internal::Type::request_parameters
@@ -30,7 +30,7 @@ module Dodopayments
 
         attr_accessor idempotency_key: String?
 
-        attr_accessor metadata: ::Hash[Symbol, String]?
+        attr_accessor metadata: Dodopayments::Models::metadata?
 
         attr_accessor reason: String?
 
@@ -41,7 +41,7 @@ module Dodopayments
           entry_type: Dodopayments::Models::CreditEntitlements::ledger_entry_type,
           ?expires_at: Time?,
           ?idempotency_key: String?,
-          ?metadata: ::Hash[Symbol, String]?,
+          ?metadata: Dodopayments::Models::metadata?,
           ?reason: String?,
           ?request_options: Dodopayments::request_opts
         ) -> void
@@ -53,7 +53,7 @@ module Dodopayments
           entry_type: Dodopayments::Models::CreditEntitlements::ledger_entry_type,
           expires_at: Time?,
           idempotency_key: String?,
-          metadata: ::Hash[Symbol, String]?,
+          metadata: Dodopayments::Models::metadata?,
           reason: String?,
           request_options: Dodopayments::RequestOptions
         }

data/sig/dodopayments/models/credit_entitlements/balance_list_grants_response.rbs

@@ -15,7 +15,7 @@ module Dodopayments
           source_type: Dodopayments::Models::CreditEntitlements::BalanceListGrantsResponse::source_type,
           updated_at: Time,
           expires_at: Time?,
-          metadata: ::Hash[Symbol, String]?,
+          metadata: Dodopayments::Models::metadata?,
           parent_grant_id: String?,
           source_id: String?
         }
@@ -45,7 +45,7 @@ module Dodopayments
 
         attr_accessor expires_at: Time?
 
-        attr_accessor metadata: ::Hash[Symbol, String]?
+        attr_accessor metadata: Dodopayments::Models::metadata?
 
         attr_accessor parent_grant_id: String?
 
@@ -64,7 +64,7 @@ module Dodopayments
           source_type: Dodopayments::Models::CreditEntitlements::BalanceListGrantsResponse::source_type,
           updated_at: Time,
           ?expires_at: Time?,
-          ?metadata: ::Hash[Symbol, String]?,
+          ?metadata: Dodopayments::Models::metadata?,
           ?parent_grant_id: String?,
           ?source_id: String?
         ) -> void
@@ -82,7 +82,7 @@ module Dodopayments
           source_type: Dodopayments::Models::CreditEntitlements::BalanceListGrantsResponse::source_type,
           updated_at: Time,
           expires_at: Time?,
-          metadata: ::Hash[Symbol, String]?,
+          metadata: Dodopayments::Models::metadata?,
           parent_grant_id: String?,
           source_id: String?
         }