dodopayments 2.17.1 → 2.18.1

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/subscription_update_params.rbi

@@ -275,6 +275,7 @@ module Dodopayments
         sig { returns(T.nilable(Integer)) }
         attr_accessor :rollover_timeframe_count
 
+        # Unit of a duration count (e.g. license-key validity period).
         sig { returns(T.nilable(Dodopayments::TimeInterval::OrSymbol)) }
         attr_accessor :rollover_timeframe_interval
 
@@ -305,6 +306,7 @@ module Dodopayments
           rollover_enabled: nil,
           rollover_percentage: nil,
           rollover_timeframe_count: nil,
+          # Unit of a duration count (e.g. license-key validity period).
           rollover_timeframe_interval: nil
         )
         end

data/rbi/dodopayments/models/time_interval.rbi

@@ -2,6 +2,7 @@
 
 module Dodopayments
   module Models
+    # Unit of a duration count (e.g. license-key validity period).
     module TimeInterval
       extend Dodopayments::Internal::Type::Enum
 

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_flags.rbs

@@ -13,6 +13,7 @@ module Dodopayments
         allow_customer_editing_tax_id: bool,
         allow_customer_editing_zipcode: bool,
         allow_discount_code: bool,
+        allow_editing_addons: bool,
         allow_phone_number_collection: bool,
         allow_tax_id: bool,
         always_create_new_customer: bool,
@@ -65,6 +66,10 @@ module Dodopayments
 
       def allow_discount_code=: (bool) -> bool
 
+      attr_reader allow_editing_addons: bool?
+
+      def allow_editing_addons=: (bool) -> bool
+
       attr_reader allow_phone_number_collection: bool?
 
       def allow_phone_number_collection=: (bool) -> bool
@@ -97,6 +102,7 @@ module Dodopayments
         ?allow_customer_editing_tax_id: bool,
         ?allow_customer_editing_zipcode: bool,
         ?allow_discount_code: bool,
+        ?allow_editing_addons: bool,
         ?allow_phone_number_collection: bool,
         ?allow_tax_id: bool,
         ?always_create_new_customer: bool,
@@ -116,6 +122,7 @@ module Dodopayments
         allow_customer_editing_tax_id: bool,
         allow_customer_editing_zipcode: bool,
         allow_discount_code: bool,
+        allow_editing_addons: bool,
         allow_phone_number_collection: bool,
         allow_tax_id: bool,
         always_create_new_customer: bool,

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?
         }

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

@@ -13,6 +13,7 @@ module Dodopayments
           credit_entitlement_id: String,
           customer_id: String,
           is_credit: bool,
+          metadata: Dodopayments::Models::metadata,
           overage_after: String,
           overage_before: String,
           transaction_type: Dodopayments::Models::CreditEntitlements::CreditLedgerEntry::transaction_type,
@@ -43,6 +44,8 @@ module Dodopayments
 
         attr_accessor is_credit: bool
 
+        attr_accessor metadata: Dodopayments::Models::metadata
+
         attr_accessor overage_after: String
 
         attr_accessor overage_before: String
@@ -68,6 +71,7 @@ module Dodopayments
           credit_entitlement_id: String,
           customer_id: String,
           is_credit: bool,
+          metadata: Dodopayments::Models::metadata,
           overage_after: String,
           overage_before: String,
           transaction_type: Dodopayments::Models::CreditEntitlements::CreditLedgerEntry::transaction_type,
@@ -88,6 +92,7 @@ module Dodopayments
           credit_entitlement_id: String,
           customer_id: String,
           is_credit: bool,
+          metadata: Dodopayments::Models::metadata,
           overage_after: String,
           overage_before: String,
           transaction_type: Dodopayments::Models::CreditEntitlements::CreditLedgerEntry::transaction_type,

data/sig/dodopayments/models/customer.rbs

@@ -7,7 +7,7 @@ module Dodopayments
         customer_id: String,
         email: String,
         name: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         phone_number: String?
       }
 
@@ -22,9 +22,11 @@ module Dodopayments
 
       attr_accessor name: String
 
-      attr_reader metadata: ::Hash[Symbol, String]?
+      attr_reader metadata: Dodopayments::Models::metadata?
 
-      def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+      def metadata=: (
+        Dodopayments::Models::metadata
+      ) -> Dodopayments::Models::metadata
 
       attr_accessor phone_number: String?
 
@@ -34,7 +36,7 @@ module Dodopayments
         customer_id: String,
         email: String,
         name: String,
-        ?metadata: ::Hash[Symbol, String],
+        ?metadata: Dodopayments::Models::metadata,
         ?phone_number: String?
       ) -> void
 
@@ -44,7 +46,7 @@ module Dodopayments
         customer_id: String,
         email: String,
         name: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         phone_number: String?
       }
     end

data/sig/dodopayments/models/customer_create_params.rbs

@@ -4,7 +4,7 @@ module Dodopayments
       {
         email: String,
         name: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         phone_number: String?
       }
       & Dodopayments::Internal::Type::request_parameters
@@ -17,16 +17,18 @@ module Dodopayments
 
       attr_accessor name: String
 
-      attr_reader metadata: ::Hash[Symbol, String]?
+      attr_reader metadata: Dodopayments::Models::metadata?
 
-      def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+      def metadata=: (
+        Dodopayments::Models::metadata
+      ) -> Dodopayments::Models::metadata
 
       attr_accessor phone_number: String?
 
       def initialize: (
         email: String,
         name: String,
-        ?metadata: ::Hash[Symbol, String],
+        ?metadata: Dodopayments::Models::metadata,
         ?phone_number: String?,
         ?request_options: Dodopayments::request_opts
       ) -> void
@@ -34,7 +36,7 @@ module Dodopayments
       def to_hash: -> {
         email: String,
         name: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         phone_number: String?,
         request_options: Dodopayments::RequestOptions
       }

data/sig/dodopayments/models/customer_limited_details.rbs

@@ -5,7 +5,7 @@ module Dodopayments
         customer_id: String,
         email: String,
         name: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         phone_number: String?
       }
 
@@ -16,9 +16,11 @@ module Dodopayments
 
       attr_accessor name: String
 
-      attr_reader metadata: ::Hash[Symbol, String]?
+      attr_reader metadata: Dodopayments::Models::metadata?
 
-      def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+      def metadata=: (
+        Dodopayments::Models::metadata
+      ) -> Dodopayments::Models::metadata
 
       attr_accessor phone_number: String?
 
@@ -26,7 +28,7 @@ module Dodopayments
         customer_id: String,
         email: String,
         name: String,
-        ?metadata: ::Hash[Symbol, String],
+        ?metadata: Dodopayments::Models::metadata,
         ?phone_number: String?
       ) -> void
 
@@ -34,7 +36,7 @@ module Dodopayments
         customer_id: String,
         email: String,
         name: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         phone_number: String?
       }
     end

data/sig/dodopayments/models/customer_update_params.rbs

@@ -4,7 +4,7 @@ module Dodopayments
       {
         customer_id: String,
         email: String?,
-        metadata: ::Hash[Symbol, String]?,
+        metadata: Dodopayments::Models::metadata?,
         name: String?,
         phone_number: String?
       }
@@ -18,7 +18,7 @@ module Dodopayments
 
       attr_accessor email: String?
 
-      attr_accessor metadata: ::Hash[Symbol, String]?
+      attr_accessor metadata: Dodopayments::Models::metadata?
 
       attr_accessor name: String?
 
@@ -27,7 +27,7 @@ module Dodopayments
       def initialize: (
         customer_id: String,
         ?email: String?,
-        ?metadata: ::Hash[Symbol, String]?,
+        ?metadata: Dodopayments::Models::metadata?,
         ?name: String?,
         ?phone_number: String?,
         ?request_options: Dodopayments::request_opts
@@ -36,7 +36,7 @@ module Dodopayments
       def to_hash: -> {
         customer_id: String,
         email: String?,
-        metadata: ::Hash[Symbol, String]?,
+        metadata: Dodopayments::Models::metadata?,
         name: String?,
         phone_number: String?,
         request_options: Dodopayments::RequestOptions

data/sig/dodopayments/models/discount.rbs

@@ -7,7 +7,7 @@ module Dodopayments
         code: String,
         created_at: Time,
         discount_id: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String],
         times_used: Integer,
@@ -29,7 +29,7 @@ module Dodopayments
 
       attr_accessor discount_id: String
 
-      attr_accessor metadata: ::Hash[Symbol, String]
+      attr_accessor metadata: Dodopayments::Models::metadata
 
       attr_accessor preserve_on_plan_change: bool
 
@@ -53,7 +53,7 @@ module Dodopayments
         code: String,
         created_at: Time,
         discount_id: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String],
         times_used: Integer,
@@ -70,7 +70,7 @@ module Dodopayments
         code: String,
         created_at: Time,
         discount_id: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String],
         times_used: Integer,

data/sig/dodopayments/models/discount_create_params.rbs

@@ -6,7 +6,7 @@ module Dodopayments
         type: Dodopayments::Models::discount_type,
         code: String?,
         expires_at: Time?,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         name: String?,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String]?,
@@ -27,9 +27,11 @@ module Dodopayments
 
       attr_accessor expires_at: Time?
 
-      attr_reader metadata: ::Hash[Symbol, String]?
+      attr_reader metadata: Dodopayments::Models::metadata?
 
-      def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+      def metadata=: (
+        Dodopayments::Models::metadata
+      ) -> Dodopayments::Models::metadata
 
       attr_accessor name: String?
 
@@ -48,7 +50,7 @@ module Dodopayments
         type: Dodopayments::Models::discount_type,
         ?code: String?,
         ?expires_at: Time?,
-        ?metadata: ::Hash[Symbol, String],
+        ?metadata: Dodopayments::Models::metadata,
         ?name: String?,
         ?preserve_on_plan_change: bool,
         ?restricted_to: ::Array[String]?,
@@ -62,7 +64,7 @@ module Dodopayments
         type: Dodopayments::Models::discount_type,
         code: String?,
         expires_at: Time?,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         name: String?,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String]?,

data/sig/dodopayments/models/discount_detail.rbs

@@ -7,7 +7,7 @@ module Dodopayments
         code: String,
         created_at: Time,
         discount_id: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         position: Integer,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String],
@@ -31,7 +31,7 @@ module Dodopayments
 
       attr_accessor discount_id: String
 
-      attr_accessor metadata: ::Hash[Symbol, String]
+      attr_accessor metadata: Dodopayments::Models::metadata
 
       attr_accessor position: Integer
 
@@ -59,7 +59,7 @@ module Dodopayments
         code: String,
         created_at: Time,
         discount_id: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         position: Integer,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String],
@@ -78,7 +78,7 @@ module Dodopayments
         code: String,
         created_at: Time,
         discount_id: String,
-        metadata: ::Hash[Symbol, String],
+        metadata: Dodopayments::Models::metadata,
         position: Integer,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String],