dodopayments 2.32.2 → 2.34.0

data/lib/dodopayments/models/webhook_payload.rb

@@ -101,7 +101,14 @@ module Dodopayments
           #   @return [Time, nil]
           optional :past_due_ends_at, Time, nil?: true
 
-          # @!method initialize(past_due_ends_at: nil, payload_type: :Subscription)
+          # @!attribute payment_id
+          #   Identifier of the payment that caused this event. It is set only for
+          #   `subscription.renewed`. It is null for all other subscription events.
+          #
+          #   @return [String, nil]
+          optional :payment_id, String, nil?: true
+
+          # @!method initialize(past_due_ends_at: nil, payment_id: nil, payload_type: :Subscription)
           #   Some parameter documentations has been truncated, see
           #   {Dodopayments::Models::WebhookPayload::Data::Subscription} for more details.
           #
@@ -109,6 +116,8 @@ module Dodopayments
           #
           #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
           #
+          #   @param payment_id [String, nil] Identifier of the payment that caused this event.
+          #
           #   @param payload_type [Symbol, :Subscription]
         end
 

data/lib/dodopayments/models.rb

@@ -95,6 +95,8 @@ module Dodopayments
 
   CbbProrationBehavior = Dodopayments::Models::CbbProrationBehavior
 
+  ChargeType = Dodopayments::Models::ChargeType
+
   CheckoutSessionBillingAddress = Dodopayments::Models::CheckoutSessionBillingAddress
 
   CheckoutSessionCreateParams = Dodopayments::Models::CheckoutSessionCreateParams
@@ -514,6 +516,8 @@ module Dodopayments
 
   SubscriptionRetrieveUsageHistoryParams = Dodopayments::Models::SubscriptionRetrieveUsageHistoryParams
 
+  SubscriptionServicePeriod = Dodopayments::Models::SubscriptionServicePeriod
+
   SubscriptionStatus = Dodopayments::Models::SubscriptionStatus
 
   SubscriptionUnpausedWebhookEvent = Dodopayments::Models::SubscriptionUnpausedWebhookEvent

data/lib/dodopayments/resources/invoices/payments.rb

@@ -4,60 +4,84 @@ module Dodopayments
   module Resources
     class Invoices
       class Payments
-        # @overload retrieve(payment_id, request_options: {})
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Invoices::PaymentRetrieveParams} for more details.
+        #
+        # @overload retrieve(payment_id, token: nil, request_options: {})
         #
         # @param payment_id [String] Payment ID
         #
+        # @param token [String] The signed link token. If the business asks for a credential on its invoice link
+        #
         # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [StringIO]
         #
         # @see Dodopayments::Models::Invoices::PaymentRetrieveParams
         def retrieve(payment_id, params = {})
+          parsed, options = Dodopayments::Invoices::PaymentRetrieveParams.dump_request(params)
+          query = Dodopayments::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["invoices/payments/%1$s", payment_id],
+            query: query,
             headers: {"accept" => "application/pdf"},
             model: StringIO,
-            options: params[:request_options]
+            options: options
           )
         end
 
-        # @overload retrieve_payout(payout_id, request_options: {})
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Invoices::PaymentRetrievePayoutParams} for more details.
+        #
+        # @overload retrieve_payout(payout_id, token: nil, request_options: {})
         #
         # @param payout_id [String] Payout ID
         #
+        # @param token [String] The signed link token. If the business asks for a credential on its invoice link
+        #
         # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [StringIO]
         #
         # @see Dodopayments::Models::Invoices::PaymentRetrievePayoutParams
         def retrieve_payout(payout_id, params = {})
+          parsed, options = Dodopayments::Invoices::PaymentRetrievePayoutParams.dump_request(params)
+          query = Dodopayments::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["invoices/payouts/%1$s", payout_id],
+            query: query,
             headers: {"accept" => "application/pdf"},
             model: StringIO,
-            options: params[:request_options]
+            options: options
           )
         end
 
-        # @overload retrieve_refund(refund_id, request_options: {})
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Invoices::PaymentRetrieveRefundParams} for more details.
+        #
+        # @overload retrieve_refund(refund_id, token: nil, request_options: {})
         #
         # @param refund_id [String] Refund ID
         #
+        # @param token [String] The signed link token. If the business asks for a credential on its invoice link
+        #
         # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [StringIO]
         #
         # @see Dodopayments::Models::Invoices::PaymentRetrieveRefundParams
         def retrieve_refund(refund_id, params = {})
+          parsed, options = Dodopayments::Invoices::PaymentRetrieveRefundParams.dump_request(params)
+          query = Dodopayments::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["invoices/refunds/%1$s", refund_id],
+            query: query,
             headers: {"accept" => "application/pdf"},
             model: StringIO,
-            options: params[:request_options]
+            options: options
           )
         end
 

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "2.32.2"
+  VERSION = "2.34.0"
 end

data/lib/dodopayments.rb

@@ -110,6 +110,7 @@ require_relative "dodopayments/models/brand_update_params"
 require_relative "dodopayments/models/cancellation_feedback"
 require_relative "dodopayments/models/cbb_overage_behavior"
 require_relative "dodopayments/models/cbb_proration_behavior"
+require_relative "dodopayments/models/charge_type"
 require_relative "dodopayments/models/checkout_session_billing_address"
 require_relative "dodopayments/models/checkout_session_create_params"
 require_relative "dodopayments/models/checkout_session_customization"
@@ -393,6 +394,7 @@ require_relative "dodopayments/models/subscription_retrieve_credit_usage_respons
 require_relative "dodopayments/models/subscription_retrieve_params"
 require_relative "dodopayments/models/subscription_retrieve_usage_history_params"
 require_relative "dodopayments/models/subscription_retrieve_usage_history_response"
+require_relative "dodopayments/models/subscription_service_period"
 require_relative "dodopayments/models/subscription_status"
 require_relative "dodopayments/models/subscription_unpaused_webhook_event"
 require_relative "dodopayments/models/subscription_updated_webhook_event"

data/rbi/dodopayments/models/balance_ledger_entry.rbi

@@ -268,6 +268,21 @@ module Dodopayments
             :moderation_fees,
             Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
           )
+        DODO_FIXED_FEE =
+          T.let(
+            :dodo_fixed_fee,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
+        INTERCHANGE_FEE =
+          T.let(
+            :interchange_fee,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
+        SCHEME_FEE =
+          T.let(
+            :scheme_fee,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/balance_retrieve_ledger_params.rbi

@@ -1060,6 +1060,21 @@ module Dodopayments
             :moderation_fees,
             Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
           )
+        DODO_FIXED_FEE =
+          T.let(
+            :dodo_fixed_fee,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
+        INTERCHANGE_FEE =
+          T.let(
+            :interchange_fee,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
+        SCHEME_FEE =
+          T.let(
+            :scheme_fee,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/charge_type.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    # The type of subscription charge that a payment is for.
+    #
+    # A payment has one invoice, and the invoice has one type. Thus each payment has
+    # one charge type. A payment that charges no subscription has no charge type.
+    #
+    # - `new`: the first payment of one or more subscriptions. A retry of that payment
+    #   is also `new`. A cart with new subscriptions and one-time products is `new`.
+    #   Read the one-time products from `product_cart`.
+    # - `renewal`: a charge at the billing date. A dunning retry and a manual retry of
+    #   that charge are also `renewal`. A `renewal` does not always extend the service
+    #   period. For example, the usage settlement of a paused subscription is a
+    #   `renewal` with `includes_usage` true and no entry in `service_periods`.
+    #   Examine `service_periods` before you extend access.
+    # - `plan_change`: a charge for a plan change. The change applies now or at the
+    #   next billing date.
+    # - `on_demand`: an on-demand charge of an on-demand subscription.
+    module ChargeType
+      extend Dodopayments::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Dodopayments::ChargeType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      NEW = T.let(:new, Dodopayments::ChargeType::TaggedSymbol)
+      RENEWAL = T.let(:renewal, Dodopayments::ChargeType::TaggedSymbol)
+      PLAN_CHANGE = T.let(:plan_change, Dodopayments::ChargeType::TaggedSymbol)
+      ON_DEMAND = T.let(:on_demand, Dodopayments::ChargeType::TaggedSymbol)
+
+      sig { override.returns(T::Array[Dodopayments::ChargeType::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/checkout_session_flags.rbi

@@ -83,6 +83,9 @@ module Dodopayments
 
       # If the customer is allowed to apply discount code, set it to true.
       #
+      # If this flag is false, the customer cannot change the discount codes. The
+      # discount codes that you give when you create the session still apply.
+      #
       # Default is true
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :allow_discount_code
@@ -234,6 +237,9 @@ module Dodopayments
         allow_customer_editing_zipcode: nil,
         # If the customer is allowed to apply discount code, set it to true.
         #
+        # If this flag is false, the customer cannot change the discount codes. The
+        # discount codes that you give when you create the session still apply.
+        #
         # Default is true
         allow_discount_code: nil,
         # If true, the customer can add or remove addons on a subscription product during

data/rbi/dodopayments/models/checkout_session_preview_response.rbi

@@ -409,6 +409,13 @@ module Dodopayments
         sig { returns(T.nilable(Integer)) }
         attr_accessor :discount_cycle
 
+        # The monthly equivalent of the yearly unit price after discounts, in minor units
+        # of `currency`. Only the hosted checkout sets it, when the business shows yearly
+        # plans as monthly. The value is only for display. The order summary shows the
+        # amounts that we charge.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :monthly_equivalent
+
         # name of the product
         sig { returns(T.nilable(String)) }
         attr_accessor :name
@@ -447,6 +454,7 @@ module Dodopayments
             description: T.nilable(String),
             discount_amount: T.nilable(Integer),
             discount_cycle: T.nilable(Integer),
+            monthly_equivalent: T.nilable(Integer),
             name: T.nilable(String),
             tax: T.nilable(Integer)
           ).returns(T.attached_class)
@@ -483,6 +491,11 @@ module Dodopayments
           discount_amount: nil,
           # number of cycles the discount will apply
           discount_cycle: nil,
+          # The monthly equivalent of the yearly unit price after discounts, in minor units
+          # of `currency`. Only the hosted checkout sets it, when the business shows yearly
+          # plans as monthly. The value is only for display. The order summary shows the
+          # amounts that we charge.
+          monthly_equivalent: nil,
           # name of the product
           name: nil,
           # total tax
@@ -521,6 +534,7 @@ module Dodopayments
               description: T.nilable(String),
               discount_amount: T.nilable(Integer),
               discount_cycle: T.nilable(Integer),
+              monthly_equivalent: T.nilable(Integer),
               name: T.nilable(String),
               tax: T.nilable(Integer)
             }

data/rbi/dodopayments/models/invoices/payment_retrieve_params.rbi

@@ -18,19 +18,35 @@ module Dodopayments
         sig { returns(String) }
         attr_accessor :payment_id
 
+        # The signed link token. If the business asks for a credential on its invoice
+        # links, a valid token for this record replaces the credential.
+        sig { returns(T.nilable(String)) }
+        attr_reader :token
+
+        sig { params(token: String).void }
+        attr_writer :token
+
         sig do
           params(
             payment_id: String,
+            token: String,
             request_options: Dodopayments::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(payment_id:, request_options: {})
+        def self.new(
+          payment_id:,
+          # The signed link token. If the business asks for a credential on its invoice
+          # links, a valid token for this record replaces the credential.
+          token: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
             {
               payment_id: String,
+              token: String,
               request_options: Dodopayments::RequestOptions
             }
           )

data/rbi/dodopayments/models/invoices/payment_retrieve_payout_params.rbi

@@ -18,18 +18,37 @@ module Dodopayments
         sig { returns(String) }
         attr_accessor :payout_id
 
+        # The signed link token. If the business asks for a credential on its invoice
+        # links, a valid token for this record replaces the credential.
+        sig { returns(T.nilable(String)) }
+        attr_reader :token
+
+        sig { params(token: String).void }
+        attr_writer :token
+
         sig do
           params(
             payout_id: String,
+            token: String,
             request_options: Dodopayments::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(payout_id:, request_options: {})
+        def self.new(
+          payout_id:,
+          # The signed link token. If the business asks for a credential on its invoice
+          # links, a valid token for this record replaces the credential.
+          token: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
-            { payout_id: String, request_options: Dodopayments::RequestOptions }
+            {
+              payout_id: String,
+              token: String,
+              request_options: Dodopayments::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/dodopayments/models/invoices/payment_retrieve_refund_params.rbi

@@ -18,18 +18,37 @@ module Dodopayments
         sig { returns(String) }
         attr_accessor :refund_id
 
+        # The signed link token. If the business asks for a credential on its invoice
+        # links, a valid token for this record replaces the credential.
+        sig { returns(T.nilable(String)) }
+        attr_reader :token
+
+        sig { params(token: String).void }
+        attr_writer :token
+
         sig do
           params(
             refund_id: String,
+            token: String,
             request_options: Dodopayments::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(refund_id:, request_options: {})
+        def self.new(
+          refund_id:,
+          # The signed link token. If the business asks for a credential on its invoice
+          # links, a valid token for this record replaces the credential.
+          token: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
-            { refund_id: String, request_options: Dodopayments::RequestOptions }
+            {
+              refund_id: String,
+              token: String,
+              request_options: Dodopayments::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/dodopayments/models/manual_retry_state.rbi

@@ -17,6 +17,20 @@ module Dodopayments
       sig { returns(Integer) }
       attr_accessor :sends_used
 
+      # The number of the queued automatic retry, starting at 1.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :automatic_retry_number
+
+      # The number of automatic retries that the current configuration plans for this
+      # invoice. It is never less than `automatic_retry_number`.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :automatic_retry_total
+
+      # When the next automatic retry on this invoice is scheduled. Null when no
+      # automatic retry is queued or automatic retries are disabled.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :next_automatic_retry_at
+
       # The code `POST` would fail with. Null when `can_retry` is true.
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
@@ -31,6 +45,9 @@ module Dodopayments
           can_retry: T::Boolean,
           sends_allowed: Integer,
           sends_used: Integer,
+          automatic_retry_number: T.nilable(Integer),
+          automatic_retry_total: T.nilable(Integer),
+          next_automatic_retry_at: T.nilable(Time),
           reason: T.nilable(String),
           retry_available_at: T.nilable(Time)
         ).returns(T.attached_class)
@@ -39,6 +56,14 @@ module Dodopayments
         can_retry:,
         sends_allowed:,
         sends_used:,
+        # The number of the queued automatic retry, starting at 1.
+        automatic_retry_number: nil,
+        # The number of automatic retries that the current configuration plans for this
+        # invoice. It is never less than `automatic_retry_number`.
+        automatic_retry_total: nil,
+        # When the next automatic retry on this invoice is scheduled. Null when no
+        # automatic retry is queued or automatic retries are disabled.
+        next_automatic_retry_at: nil,
         # The code `POST` would fail with. Null when `can_retry` is true.
         reason: nil,
         # When the next send becomes available. Null when no send is left, or when the
@@ -53,6 +78,9 @@ module Dodopayments
             can_retry: T::Boolean,
             sends_allowed: Integer,
             sends_used: Integer,
+            automatic_retry_number: T.nilable(Integer),
+            automatic_retry_total: T.nilable(Integer),
+            next_automatic_retry_at: T.nilable(Time),
             reason: T.nilable(String),
             retry_available_at: T.nilable(Time)
           }