dodopayments 2.29.0 → 2.30.0

data/lib/dodopayments/models/moderation_category_scores.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class ModerationCategoryScores < Dodopayments::Internal::Type::BaseModel
+      # @!attribute child_sexual_exploitation
+      #   Child sexual exploitation.
+      #
+      #   @return [Float]
+      required :child_sexual_exploitation, Float
+
+      # @!attribute defamation
+      #   False depiction that is likely to injure the reputation of a real person.
+      #
+      #   @return [Float]
+      required :defamation, Float
+
+      # @!attribute hate
+      #   Demeaning people because of a protected characteristic.
+      #
+      #   @return [Float]
+      required :hate, Float
+
+      # @!attribute indiscriminate_weapons
+      #   Chemical, biological, radiological, nuclear or explosive weapons.
+      #
+      #   @return [Float]
+      required :indiscriminate_weapons, Float
+
+      # @!attribute intellectual_property
+      #   Copyright or trademark infringement.
+      #
+      #   @return [Float]
+      required :intellectual_property, Float
+
+      # @!attribute living_artist_style
+      #   Imitation of the signature style of a specific living artist.
+      #
+      #   @return [Float]
+      required :living_artist_style, Float
+
+      # @!attribute minor_coded_language
+      #   Age-coded language that suggests the subject is a minor.
+      #
+      #   @return [Float]
+      required :minor_coded_language, Float
+
+      # @!attribute non_consensual_intimate_imagery
+      #   Non-consensual intimate imagery: undressing, nudifying or sexualising a real
+      #   person.
+      #
+      #   @return [Float]
+      required :non_consensual_intimate_imagery, Float
+
+      # @!attribute non_violent_crimes
+      #   Non-violent crimes.
+      #
+      #   @return [Float]
+      required :non_violent_crimes, Float
+
+      # @!attribute privacy
+      #   Sensitive private information about a person.
+      #
+      #   @return [Float]
+      required :privacy, Float
+
+      # @!attribute prompt_injection
+      #   An attempt to override or manipulate the instructions of the system.
+      #
+      #   @return [Float]
+      required :prompt_injection, Float
+
+      # @!attribute real_person_likeness
+      #   The likeness of a real, identifiable, named person.
+      #
+      #   @return [Float]
+      required :real_person_likeness, Float
+
+      # @!attribute sex_related_crimes
+      #   Sex-related crimes.
+      #
+      #   @return [Float]
+      required :sex_related_crimes, Float
+
+      # @!attribute sexual_content
+      #   Sexually explicit or pornographic content.
+      #
+      #   @return [Float]
+      required :sexual_content, Float
+
+      # @!attribute specialized_advice
+      #   Unqualified financial, medical, legal or electoral advice.
+      #
+      #   @return [Float]
+      required :specialized_advice, Float
+
+      # @!attribute suicide_and_self_harm
+      #   Suicide and self-harm.
+      #
+      #   @return [Float]
+      required :suicide_and_self_harm, Float
+
+      # @!attribute violent_crimes
+      #   Violent crimes.
+      #
+      #   @return [Float]
+      required :violent_crimes, Float
+
+      # @!method initialize(child_sexual_exploitation:, defamation:, hate:, indiscriminate_weapons:, intellectual_property:, living_artist_style:, minor_coded_language:, non_consensual_intimate_imagery:, non_violent_crimes:, privacy:, prompt_injection:, real_person_likeness:, sex_related_crimes:, sexual_content:, specialized_advice:, suicide_and_self_harm:, violent_crimes:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ModerationCategoryScores} for more details.
+      #
+      #   The probability, from 0 to 1, that the screen falls in each category.
+      #
+      #   @param child_sexual_exploitation [Float] Child sexual exploitation.
+      #
+      #   @param defamation [Float] False depiction that is likely to injure the reputation of a real person.
+      #
+      #   @param hate [Float] Demeaning people because of a protected characteristic.
+      #
+      #   @param indiscriminate_weapons [Float] Chemical, biological, radiological, nuclear or explosive weapons.
+      #
+      #   @param intellectual_property [Float] Copyright or trademark infringement.
+      #
+      #   @param living_artist_style [Float] Imitation of the signature style of a specific living artist.
+      #
+      #   @param minor_coded_language [Float] Age-coded language that suggests the subject is a minor.
+      #
+      #   @param non_consensual_intimate_imagery [Float] Non-consensual intimate imagery: undressing, nudifying or sexualising a real per
+      #
+      #   @param non_violent_crimes [Float] Non-violent crimes.
+      #
+      #   @param privacy [Float] Sensitive private information about a person.
+      #
+      #   @param prompt_injection [Float] An attempt to override or manipulate the instructions of the system.
+      #
+      #   @param real_person_likeness [Float] The likeness of a real, identifiable, named person.
+      #
+      #   @param sex_related_crimes [Float] Sex-related crimes.
+      #
+      #   @param sexual_content [Float] Sexually explicit or pornographic content.
+      #
+      #   @param specialized_advice [Float] Unqualified financial, medical, legal or electoral advice.
+      #
+      #   @param suicide_and_self_harm [Float] Suicide and self-harm.
+      #
+      #   @param violent_crimes [Float] Violent crimes.
+    end
+  end
+end

data/lib/dodopayments/models/moderation_decision.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # The verdict. `allow` means the content passed. `deny` means block the content.
+    # `flag` means apply your own judgement. It is not a soft deny.
+    module ModerationDecision
+      extend Dodopayments::Internal::Type::Enum
+
+      ALLOW = :allow
+      FLAG = :flag
+      DENY = :deny
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/models/moderation_provenance.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # How a score was measured. `targeted` means a check for that one category
+    # measured it. `broad` means the general check that covers all categories measured
+    # it.
+    module ModerationProvenance
+      extend Dodopayments::Internal::Type::Enum
+
+      TARGETED = :targeted
+      BROAD = :broad
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/models/moderation_retrieve_usage_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Moderation#retrieve_usage
+    class ModerationRetrieveUsageParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/moderation_retrieve_usage_response.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Moderation#retrieve_usage
+    class ModerationRetrieveUsageResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute daily
+      #   Your billable screens per UTC day for the last 30 days, charged or not. A day
+      #   with no screens is not in the list.
+      #
+      #   @return [Array<Dodopayments::Models::ModerationRetrieveUsageResponse::Daily>]
+      required :daily,
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::ModerationRetrieveUsageResponse::Daily] }
+
+      # @!attribute screens_to_next_block
+      #   Billable screens still needed to fill the next block of 1000. A full block is
+      #   charged within one hour, so this value is 1000 when your unbilled screens fill
+      #   whole blocks.
+      #
+      #   @return [Integer]
+      required :screens_to_next_block, Integer
+
+      # @!attribute unbilled_screens
+      #   Billable screens that Dodo Payments has not charged for yet.
+      #
+      #   @return [Integer]
+      required :unbilled_screens, Integer
+
+      # @!method initialize(daily:, screens_to_next_block:, unbilled_screens:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ModerationRetrieveUsageResponse} for more details.
+      #
+      #   Your moderation usage.
+      #
+      #   @param daily [Array<Dodopayments::Models::ModerationRetrieveUsageResponse::Daily>] Your billable screens per UTC day for the last 30 days, charged or not. A day wi
+      #
+      #   @param screens_to_next_block [Integer] Billable screens still needed to fill the next block of 1000. A full block is ch
+      #
+      #   @param unbilled_screens [Integer] Billable screens that Dodo Payments has not charged for yet.
+
+      class Daily < Dodopayments::Internal::Type::BaseModel
+        # @!attribute date
+        #   The UTC day.
+        #
+        #   @return [Date]
+        required :date, Date
+
+        # @!attribute screens
+        #   Billable screens on that day.
+        #
+        #   @return [Integer]
+        required :screens, Integer
+
+        # @!method initialize(date:, screens:)
+        #   @param date [Date] The UTC day.
+        #
+        #   @param screens [Integer] Billable screens on that day.
+      end
+    end
+  end
+end

data/lib/dodopayments/models/moderation_screen_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Moderation#screen
+    class ModerationScreenParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute image
+      #   The image to screen, as base64, with or without a `data:image/...;base64,`
+      #   prefix. The formats are JPEG, PNG, WebP, GIF and BMP. The limit is 6991530
+      #   base64 characters, and the decoded image must be at most 5 MiB.
+      #
+      #   @return [String, nil]
+      optional :image, String, nil?: true
+
+      # @!attribute request_id
+      #   Your identifier for this screen, up to 128 characters, with no control
+      #   characters. The response returns it in `request_id`.
+      #
+      #   @return [String, nil]
+      optional :request_id, String, nil?: true
+
+      # @!attribute text
+      #   The text to screen, up to 8000 characters.
+      #
+      #   @return [String, nil]
+      optional :text, String, nil?: true
+
+      # @!method initialize(image: nil, request_id: nil, text: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ModerationScreenParams} for more details.
+      #
+      #   @param image [String, nil] The image to screen, as base64, with or without a `data:image/...;base64,` prefi
+      #
+      #   @param request_id [String, nil] Your identifier for this screen, up to 128 characters, with no control character
+      #
+      #   @param text [String, nil] The text to screen, up to 8000 characters.
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/moderation_screen_response.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Moderation#screen
+    class ModerationScreenResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute categories
+      #   The probability, from 0 to 1, that the screen falls in each category.
+      #
+      #   @return [Dodopayments::Models::ModerationCategoryScores]
+      required :categories, -> { Dodopayments::ModerationCategoryScores }
+
+      # @!attribute compound_triggered
+      #   True when real-person likeness and sexual content together crossed their
+      #   combined threshold, the pattern of a sexual deepfake.
+      #
+      #   @return [Boolean]
+      required :compound_triggered, Dodopayments::Internal::Type::Boolean
+
+      # @!attribute decision
+      #   The verdict. `allow` means the content passed. `deny` means block the content.
+      #   `flag` means apply your own judgement. It is not a soft deny.
+      #
+      #   @return [Symbol, Dodopayments::Models::ModerationDecision]
+      required :decision, enum: -> { Dodopayments::ModerationDecision }
+
+      # @!attribute latency_ms
+      #   The time the screen took, in milliseconds.
+      #
+      #   @return [Integer]
+      required :latency_ms, Integer
+
+      # @!attribute normalized_applied
+      #   True when the text was also screened in a normalized form, with obfuscation such
+      #   as invisible or look-alike characters removed.
+      #
+      #   @return [Boolean]
+      required :normalized_applied, Dodopayments::Internal::Type::Boolean
+
+      # @!attribute notes
+      #   Human-readable reasons for the decision. The wording can change, so do not parse
+      #   it.
+      #
+      #   @return [Array<String>]
+      required :notes, Dodopayments::Internal::Type::ArrayOf[String]
+
+      # @!attribute passes
+      #   The number of yes/no questions the model answered for this screen.
+      #
+      #   @return [Integer]
+      required :passes, Integer
+
+      # @!attribute provenance
+      #   How each score in `categories` was measured.
+      #
+      #   @return [Dodopayments::Models::ModerationCategoryProvenance]
+      required :provenance, -> { Dodopayments::ModerationCategoryProvenance }
+
+      # @!attribute request_id
+      #   The `request_id` you sent, or null.
+      #
+      #   @return [String, nil]
+      required :request_id, String, nil?: true
+
+      # @!attribute triggered
+      #   The categories whose score crossed the threshold of the category. It can be
+      #   empty on a `flag` from the general check. `notes` then gives the reason.
+      #
+      #   @return [Array<Symbol, Dodopayments::Models::ModerationCategory>]
+      required :triggered, -> { Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::ModerationCategory] }
+
+      # @!method initialize(categories:, compound_triggered:, decision:, latency_ms:, normalized_applied:, notes:, passes:, provenance:, request_id:, triggered:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ModerationScreenResponse} for more details.
+      #
+      #   The verdict of one screen.
+      #
+      #   @param categories [Dodopayments::Models::ModerationCategoryScores] The probability, from 0 to 1, that the screen falls in each category.
+      #
+      #   @param compound_triggered [Boolean] True when real-person likeness and sexual content together crossed their combine
+      #
+      #   @param decision [Symbol, Dodopayments::Models::ModerationDecision] The verdict. `allow` means the content passed. `deny` means block the content. `
+      #
+      #   @param latency_ms [Integer] The time the screen took, in milliseconds.
+      #
+      #   @param normalized_applied [Boolean] True when the text was also screened in a normalized form, with obfuscation such
+      #
+      #   @param notes [Array<String>] Human-readable reasons for the decision. The wording can change, so do not parse
+      #
+      #   @param passes [Integer] The number of yes/no questions the model answered for this screen.
+      #
+      #   @param provenance [Dodopayments::Models::ModerationCategoryProvenance] How each score in `categories` was measured.
+      #
+      #   @param request_id [String, nil] The `request_id` you sent, or null.
+      #
+      #   @param triggered [Array<Symbol, Dodopayments::Models::ModerationCategory>] The categories whose score crossed the threshold of the category. It can be empt
+    end
+  end
+end

data/lib/dodopayments/models/payment.rb

@@ -52,6 +52,14 @@ module Dodopayments
       #   @return [Array<Dodopayments::Models::Dispute>]
       required :disputes, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Dispute] }
 
+      # @!attribute is_multi_subscription
+      #   True when one payment starts more than one subscription. Read this field to find
+      #   the payment type. Do not read the length of `subscription_ids`. Do not read
+      #   `subscription_id` for null.
+      #
+      #   @return [Boolean]
+      required :is_multi_subscription, Dodopayments::Internal::Type::Boolean
+
       # @!attribute is_update_payment_method
       #   Whether this payment was created solely to update a subscription's payment
       #   method (a zero-/setup-amount charge). `false` for normal charges.
@@ -108,6 +116,14 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::Currency]
       required :settlement_currency, enum: -> { Dodopayments::Currency }
 
+      # @!attribute subscription_ids
+      #   Every subscription that this payment starts or charges, in a stable order. It is
+      #   empty for a one-time payment. It holds the value of `subscription_id` when the
+      #   payment names one subscription.
+      #
+      #   @return [Array<String>]
+      required :subscription_ids, Dodopayments::Internal::Type::ArrayOf[String]
+
       # @!attribute total_amount
       #   Total amount charged to the customer including tax, in the currency's smallest
       #   unit (e.g. cents for USD, yen for JPY, fils for KWD — see the currency's decimal
@@ -257,7 +273,9 @@ module Dodopayments
       optional :status, enum: -> { Dodopayments::IntentStatus }, nil?: true
 
       # @!attribute subscription_id
-      #   Identifier of the subscription if payment is part of a subscription
+      #   Identifier of the subscription if payment is part of a subscription. A
+      #   multi-subscription payment leaves this null, because no single subscription owns
+      #   the payment. Read `subscription_ids` for those.
       #
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
@@ -275,7 +293,7 @@ module Dodopayments
       #   @return [Time, nil]
       optional :updated_at, Time, nil?: true
 
-      # @!method initialize(billing:, brand_id:, business_id:, created_at:, currency:, customer:, digital_products_delivered:, disputes:, is_update_payment_method:, metadata:, payment_id:, payment_provider:, refunds:, retry_attempt:, settlement_amount:, settlement_currency:, total_amount:, card_holder_name: nil, card_issuing_country: nil, card_last_four: nil, card_network: nil, card_type: nil, checkout_session_id: nil, custom_field_responses: nil, discount_id: nil, discounts: nil, error_code: nil, error_message: nil, invoice_id: nil, invoice_url: nil, payment_link: nil, payment_method: nil, payment_method_id: nil, payment_method_type: nil, product_cart: nil, refund_status: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
+      # @!method initialize(billing:, brand_id:, business_id:, created_at:, currency:, customer:, digital_products_delivered:, disputes:, is_multi_subscription:, is_update_payment_method:, metadata:, payment_id:, payment_provider:, refunds:, retry_attempt:, settlement_amount:, settlement_currency:, subscription_ids:, total_amount:, card_holder_name: nil, card_issuing_country: nil, card_last_four: nil, card_network: nil, card_type: nil, checkout_session_id: nil, custom_field_responses: nil, discount_id: nil, discounts: nil, error_code: nil, error_message: nil, invoice_id: nil, invoice_url: nil, payment_link: nil, payment_method: nil, payment_method_id: nil, payment_method_type: nil, product_cart: nil, refund_status: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Payment} for more details.
       #
@@ -295,6 +313,8 @@ module Dodopayments
       #
       #   @param disputes [Array<Dodopayments::Models::Dispute>] List of disputes associated with this payment
       #
+      #   @param is_multi_subscription [Boolean] True when one payment starts more than one subscription. Read this field
+      #
       #   @param is_update_payment_method [Boolean] Whether this payment was created solely to update a subscription's
       #
       #   @param metadata [Hash{Symbol=>String, Float, Boolean}] Additional custom data associated with the payment
@@ -311,6 +331,8 @@ module Dodopayments
       #
       #   @param settlement_currency [Symbol, Dodopayments::Models::Currency] The currency in which the settlement_amount will be credited to your Dodo balanc
       #
+      #   @param subscription_ids [Array<String>] Every subscription that this payment starts or charges, in a stable order.
+      #
       #   @param total_amount [Integer] Total amount charged to the customer including tax, in the currency's smallest u
       #
       #   @param card_holder_name [String, nil] Cardholder name
@@ -355,7 +377,7 @@ module Dodopayments
       #
       #   @param status [Symbol, Dodopayments::Models::IntentStatus, nil] Current status of the payment intent
       #
-      #   @param subscription_id [String, nil] Identifier of the subscription if payment is part of a subscription
+      #   @param subscription_id [String, nil] Identifier of the subscription if payment is part of a subscription.
       #
       #   @param tax [Integer, nil] Amount of tax collected in the currency's smallest unit
       #

data/lib/dodopayments/models/payment_list_response.rb

@@ -34,6 +34,14 @@ module Dodopayments
       #   @return [Boolean]
       required :has_license_key, Dodopayments::Internal::Type::Boolean
 
+      # @!attribute is_multi_subscription
+      #   True when one payment starts more than one subscription. Read this field to find
+      #   the payment type. Do not read the length of `subscription_ids`. Do not read
+      #   `subscription_id` for null.
+      #
+      #   @return [Boolean]
+      required :is_multi_subscription, Dodopayments::Internal::Type::Boolean
+
       # @!attribute metadata
       #   Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
       #
@@ -52,6 +60,14 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::PaymentListResponse::PaymentProvider]
       required :payment_provider, enum: -> { Dodopayments::Models::PaymentListResponse::PaymentProvider }
 
+      # @!attribute subscription_ids
+      #   Every subscription that this payment starts or charges, in a stable order. It is
+      #   empty for a one-time payment. It holds the value of `subscription_id` when the
+      #   payment names one subscription.
+      #
+      #   @return [Array<String>]
+      required :subscription_ids, Dodopayments::Internal::Type::ArrayOf[String]
+
       # @!attribute total_amount
       #
       #   @return [Integer]
@@ -114,7 +130,7 @@ module Dodopayments
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!method initialize(brand_id:, created_at:, currency:, customer:, digital_products_delivered:, has_license_key:, metadata:, payment_id:, payment_provider:, total_amount:, card_last_four: nil, card_network: nil, dispute_status: nil, invoice_id: nil, invoice_url: nil, payment_method: nil, payment_method_type: nil, refund_status: nil, status: nil, subscription_id: nil)
+      # @!method initialize(brand_id:, created_at:, currency:, customer:, digital_products_delivered:, has_license_key:, is_multi_subscription:, metadata:, payment_id:, payment_provider:, subscription_ids:, total_amount:, card_last_four: nil, card_network: nil, dispute_status: nil, invoice_id: nil, invoice_url: nil, payment_method: nil, payment_method_type: nil, refund_status: nil, status: nil, subscription_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::PaymentListResponse} for more details.
       #
@@ -130,12 +146,16 @@ module Dodopayments
       #
       #   @param has_license_key [Boolean]
       #
+      #   @param is_multi_subscription [Boolean] True when one payment starts more than one subscription. Read this field
+      #
       #   @param metadata [Hash{Symbol=>String, Float, Boolean}] Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
       #
       #   @param payment_id [String]
       #
       #   @param payment_provider [Symbol, Dodopayments::Models::PaymentListResponse::PaymentProvider] Which processor handled this payment. `stripe` / `adyen` for BYOP routes
       #
+      #   @param subscription_ids [Array<String>] Every subscription that this payment starts or charges, in a stable order.
+      #
       #   @param total_amount [Integer]
       #
       #   @param card_last_four [String, nil] The last four digits of the card

data/lib/dodopayments/models/payouts/breakup/detail_list_response.rb

@@ -40,8 +40,9 @@ module Dodopayments
 
           # @!attribute payout_currency_amount
           #   Amount in the payout's currency, in that currency's smallest unit (cents for
-          #   USD, yen for JPY, fils for KWD). Uses cumulative rounding to ensure sum matches
-          #   payout total exactly.
+          #   USD, yen for JPY, fils for KWD). The entry is converted at the rate the payout
+          #   settled at. These amounts sum to the value of the entries, which can be less
+          #   than the payout: the grouped breakup reports the difference as `unattributed`.
           #
           #   @return [Integer]
           required :payout_currency_amount, Integer
@@ -68,8 +69,8 @@ module Dodopayments
           #   Some parameter documentations has been truncated, see
           #   {Dodopayments::Models::Payouts::Breakup::DetailListResponse} for more details.
           #
-          #   Individual balance ledger entry for a payout, with amounts pro-rated into the
-          #   payout's currency.
+          #   Individual balance ledger entry for a payout, converted into the payout's
+          #   currency.
           #
           #   @param id [String] Unique identifier of the balance ledger entry.
           #

data/lib/dodopayments/models/payouts/breakup_retrieve_response.rb

@@ -6,7 +6,8 @@ module Dodopayments
       class BreakupRetrieveResponseItem < Dodopayments::Internal::Type::BaseModel
         # @!attribute event_type
         #   The type of balance ledger event (e.g., "payment", "refund", "dispute",
-        #   "payment_fees").
+        #   "payment_fees"), or `unattributed` for the payout amount the entries do not
+        #   account for.
         #
         #   @return [String]
         required :event_type, String
@@ -24,6 +25,21 @@ module Dodopayments
         #
         #   Payout breakup aggregated by event type, with amounts in the payout's currency.
         #
+        #   The rows sum to the payout amount. The last row can be `unattributed`, which is
+        #   not a ledger event type. It holds the payout amount less the entries that fund
+        #   it, and it takes either sign:
+        #
+        #   - Positive: the entries come to less than the payout, so the payout drew on the
+        #     balance an earlier cycle left over. A cycle of refunds and disputes produces a
+        #     large positive value.
+        #   - Negative: the entries come to more than the payout, and the remainder funds a
+        #     later payout. This is the common case, for two reasons. The walk that claims
+        #     the entries stops at the first one that reaches its target, so it passes the
+        #     target by part of an entry. The target is also the gross debit, which holds
+        #     the payout fee, and the fee is not a line here.
+        #
+        #   The row is absent when the two are equal.
+        #
         #   @param event_type [String] The type of balance ledger event (e.g., "payment", "refund", "dispute", "payment
         #
         #   @param total [Integer] Total amount for this event type in the payout's currency, in that currency's sm

data/lib/dodopayments/models.rb

@@ -350,6 +350,20 @@ module Dodopayments
 
   MiscListSupportedCountriesParams = Dodopayments::Models::MiscListSupportedCountriesParams
 
+  ModerationCategory = Dodopayments::Models::ModerationCategory
+
+  ModerationCategoryProvenance = Dodopayments::Models::ModerationCategoryProvenance
+
+  ModerationCategoryScores = Dodopayments::Models::ModerationCategoryScores
+
+  ModerationDecision = Dodopayments::Models::ModerationDecision
+
+  ModerationProvenance = Dodopayments::Models::ModerationProvenance
+
+  ModerationRetrieveUsageParams = Dodopayments::Models::ModerationRetrieveUsageParams
+
+  ModerationScreenParams = Dodopayments::Models::ModerationScreenParams
+
   NewCustomer = Dodopayments::Models::NewCustomer
 
   OnDemandSubscription = Dodopayments::Models::OnDemandSubscription

data/lib/dodopayments/resources/checkout_sessions.rb

@@ -8,7 +8,7 @@ module Dodopayments
       #
       # @overload create(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, cancel_url: nil, confirm: nil, custom_fields: nil, customer: nil, customer_business_name: nil, customization: nil, discount_code: nil, discount_codes: nil, feature_flags: nil, force_3ds: nil, mandate_min_amount_inr_paise: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, tax_id: nil, request_options: {})
       #
-      # @param product_cart [Array<Dodopayments::Models::ProductItemReq>]
+      # @param product_cart [Array<Dodopayments::Models::ProductItemReq>] The products of the checkout. A cart holds at most 20 of them, one-time and
       #
       # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil] Customers will never see payment methods that are not in this list.
       #
@@ -95,7 +95,7 @@ module Dodopayments
       #
       # @overload preview(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, cancel_url: nil, confirm: nil, custom_fields: nil, customer: nil, customer_business_name: nil, customization: nil, discount_code: nil, discount_codes: nil, feature_flags: nil, force_3ds: nil, mandate_min_amount_inr_paise: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, tax_id: nil, request_options: {})
       #
-      # @param product_cart [Array<Dodopayments::Models::ProductItemReq>]
+      # @param product_cart [Array<Dodopayments::Models::ProductItemReq>] The products of the checkout. A cart holds at most 20 of them, one-time and
       #
       # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil] Customers will never see payment methods that are not in this list.
       #