dodopayments 2.29.0 → 2.30.0

data/rbi/dodopayments/models/moderation_category.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    # A moderation category.
+    module ModerationCategory
+      extend Dodopayments::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Dodopayments::ModerationCategory) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      VIOLENT_CRIMES =
+        T.let(:violent_crimes, Dodopayments::ModerationCategory::TaggedSymbol)
+      SEX_RELATED_CRIMES =
+        T.let(
+          :sex_related_crimes,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      CHILD_SEXUAL_EXPLOITATION =
+        T.let(
+          :child_sexual_exploitation,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      SUICIDE_AND_SELF_HARM =
+        T.let(
+          :suicide_and_self_harm,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      INDISCRIMINATE_WEAPONS =
+        T.let(
+          :indiscriminate_weapons,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      INTELLECTUAL_PROPERTY =
+        T.let(
+          :intellectual_property,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      DEFAMATION =
+        T.let(:defamation, Dodopayments::ModerationCategory::TaggedSymbol)
+      NON_VIOLENT_CRIMES =
+        T.let(
+          :non_violent_crimes,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      HATE = T.let(:hate, Dodopayments::ModerationCategory::TaggedSymbol)
+      PRIVACY = T.let(:privacy, Dodopayments::ModerationCategory::TaggedSymbol)
+      SPECIALIZED_ADVICE =
+        T.let(
+          :specialized_advice,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      SEXUAL_CONTENT =
+        T.let(:sexual_content, Dodopayments::ModerationCategory::TaggedSymbol)
+      NON_CONSENSUAL_INTIMATE_IMAGERY =
+        T.let(
+          :non_consensual_intimate_imagery,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      MINOR_CODED_LANGUAGE =
+        T.let(
+          :minor_coded_language,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      REAL_PERSON_LIKENESS =
+        T.let(
+          :real_person_likeness,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      LIVING_ARTIST_STYLE =
+        T.let(
+          :living_artist_style,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      PROMPT_INJECTION =
+        T.let(:prompt_injection, Dodopayments::ModerationCategory::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Dodopayments::ModerationCategory::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/moderation_category_provenance.rbi

@@ -0,0 +1,184 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ModerationCategoryProvenance < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ModerationCategoryProvenance,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Child sexual exploitation.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :child_sexual_exploitation
+
+      # False depiction that is likely to injure the reputation of a real person.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :defamation
+
+      # Demeaning people because of a protected characteristic.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :hate
+
+      # Chemical, biological, radiological, nuclear or explosive weapons.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :indiscriminate_weapons
+
+      # Copyright or trademark infringement.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :intellectual_property
+
+      # Imitation of the signature style of a specific living artist.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :living_artist_style
+
+      # Age-coded language that suggests the subject is a minor.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :minor_coded_language
+
+      # Non-consensual intimate imagery: undressing, nudifying or sexualising a real
+      # person.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :non_consensual_intimate_imagery
+
+      # Non-violent crimes.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :non_violent_crimes
+
+      # Sensitive private information about a person.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :privacy
+
+      # An attempt to override or manipulate the instructions of the system.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :prompt_injection
+
+      # The likeness of a real, identifiable, named person.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :real_person_likeness
+
+      # Sex-related crimes.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :sex_related_crimes
+
+      # Sexually explicit or pornographic content.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :sexual_content
+
+      # Unqualified financial, medical, legal or electoral advice.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :specialized_advice
+
+      # Suicide and self-harm.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :suicide_and_self_harm
+
+      # Violent crimes.
+      sig { returns(Dodopayments::ModerationProvenance::TaggedSymbol) }
+      attr_accessor :violent_crimes
+
+      # How each score in `categories` was measured.
+      sig do
+        params(
+          child_sexual_exploitation:
+            Dodopayments::ModerationProvenance::OrSymbol,
+          defamation: Dodopayments::ModerationProvenance::OrSymbol,
+          hate: Dodopayments::ModerationProvenance::OrSymbol,
+          indiscriminate_weapons: Dodopayments::ModerationProvenance::OrSymbol,
+          intellectual_property: Dodopayments::ModerationProvenance::OrSymbol,
+          living_artist_style: Dodopayments::ModerationProvenance::OrSymbol,
+          minor_coded_language: Dodopayments::ModerationProvenance::OrSymbol,
+          non_consensual_intimate_imagery:
+            Dodopayments::ModerationProvenance::OrSymbol,
+          non_violent_crimes: Dodopayments::ModerationProvenance::OrSymbol,
+          privacy: Dodopayments::ModerationProvenance::OrSymbol,
+          prompt_injection: Dodopayments::ModerationProvenance::OrSymbol,
+          real_person_likeness: Dodopayments::ModerationProvenance::OrSymbol,
+          sex_related_crimes: Dodopayments::ModerationProvenance::OrSymbol,
+          sexual_content: Dodopayments::ModerationProvenance::OrSymbol,
+          specialized_advice: Dodopayments::ModerationProvenance::OrSymbol,
+          suicide_and_self_harm: Dodopayments::ModerationProvenance::OrSymbol,
+          violent_crimes: Dodopayments::ModerationProvenance::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Child sexual exploitation.
+        child_sexual_exploitation:,
+        # False depiction that is likely to injure the reputation of a real person.
+        defamation:,
+        # Demeaning people because of a protected characteristic.
+        hate:,
+        # Chemical, biological, radiological, nuclear or explosive weapons.
+        indiscriminate_weapons:,
+        # Copyright or trademark infringement.
+        intellectual_property:,
+        # Imitation of the signature style of a specific living artist.
+        living_artist_style:,
+        # Age-coded language that suggests the subject is a minor.
+        minor_coded_language:,
+        # Non-consensual intimate imagery: undressing, nudifying or sexualising a real
+        # person.
+        non_consensual_intimate_imagery:,
+        # Non-violent crimes.
+        non_violent_crimes:,
+        # Sensitive private information about a person.
+        privacy:,
+        # An attempt to override or manipulate the instructions of the system.
+        prompt_injection:,
+        # The likeness of a real, identifiable, named person.
+        real_person_likeness:,
+        # Sex-related crimes.
+        sex_related_crimes:,
+        # Sexually explicit or pornographic content.
+        sexual_content:,
+        # Unqualified financial, medical, legal or electoral advice.
+        specialized_advice:,
+        # Suicide and self-harm.
+        suicide_and_self_harm:,
+        # Violent crimes.
+        violent_crimes:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            child_sexual_exploitation:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            defamation: Dodopayments::ModerationProvenance::TaggedSymbol,
+            hate: Dodopayments::ModerationProvenance::TaggedSymbol,
+            indiscriminate_weapons:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            intellectual_property:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            living_artist_style:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            minor_coded_language:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            non_consensual_intimate_imagery:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            non_violent_crimes:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            privacy: Dodopayments::ModerationProvenance::TaggedSymbol,
+            prompt_injection: Dodopayments::ModerationProvenance::TaggedSymbol,
+            real_person_likeness:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            sex_related_crimes:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            sexual_content: Dodopayments::ModerationProvenance::TaggedSymbol,
+            specialized_advice:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            suicide_and_self_harm:
+              Dodopayments::ModerationProvenance::TaggedSymbol,
+            violent_crimes: Dodopayments::ModerationProvenance::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/moderation_category_scores.rbi

@@ -0,0 +1,171 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ModerationCategoryScores < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ModerationCategoryScores,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Child sexual exploitation.
+      sig { returns(Float) }
+      attr_accessor :child_sexual_exploitation
+
+      # False depiction that is likely to injure the reputation of a real person.
+      sig { returns(Float) }
+      attr_accessor :defamation
+
+      # Demeaning people because of a protected characteristic.
+      sig { returns(Float) }
+      attr_accessor :hate
+
+      # Chemical, biological, radiological, nuclear or explosive weapons.
+      sig { returns(Float) }
+      attr_accessor :indiscriminate_weapons
+
+      # Copyright or trademark infringement.
+      sig { returns(Float) }
+      attr_accessor :intellectual_property
+
+      # Imitation of the signature style of a specific living artist.
+      sig { returns(Float) }
+      attr_accessor :living_artist_style
+
+      # Age-coded language that suggests the subject is a minor.
+      sig { returns(Float) }
+      attr_accessor :minor_coded_language
+
+      # Non-consensual intimate imagery: undressing, nudifying or sexualising a real
+      # person.
+      sig { returns(Float) }
+      attr_accessor :non_consensual_intimate_imagery
+
+      # Non-violent crimes.
+      sig { returns(Float) }
+      attr_accessor :non_violent_crimes
+
+      # Sensitive private information about a person.
+      sig { returns(Float) }
+      attr_accessor :privacy
+
+      # An attempt to override or manipulate the instructions of the system.
+      sig { returns(Float) }
+      attr_accessor :prompt_injection
+
+      # The likeness of a real, identifiable, named person.
+      sig { returns(Float) }
+      attr_accessor :real_person_likeness
+
+      # Sex-related crimes.
+      sig { returns(Float) }
+      attr_accessor :sex_related_crimes
+
+      # Sexually explicit or pornographic content.
+      sig { returns(Float) }
+      attr_accessor :sexual_content
+
+      # Unqualified financial, medical, legal or electoral advice.
+      sig { returns(Float) }
+      attr_accessor :specialized_advice
+
+      # Suicide and self-harm.
+      sig { returns(Float) }
+      attr_accessor :suicide_and_self_harm
+
+      # Violent crimes.
+      sig { returns(Float) }
+      attr_accessor :violent_crimes
+
+      # The probability, from 0 to 1, that the screen falls in each category.
+      sig do
+        params(
+          child_sexual_exploitation: Float,
+          defamation: Float,
+          hate: Float,
+          indiscriminate_weapons: Float,
+          intellectual_property: Float,
+          living_artist_style: Float,
+          minor_coded_language: Float,
+          non_consensual_intimate_imagery: Float,
+          non_violent_crimes: Float,
+          privacy: Float,
+          prompt_injection: Float,
+          real_person_likeness: Float,
+          sex_related_crimes: Float,
+          sexual_content: Float,
+          specialized_advice: Float,
+          suicide_and_self_harm: Float,
+          violent_crimes: Float
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Child sexual exploitation.
+        child_sexual_exploitation:,
+        # False depiction that is likely to injure the reputation of a real person.
+        defamation:,
+        # Demeaning people because of a protected characteristic.
+        hate:,
+        # Chemical, biological, radiological, nuclear or explosive weapons.
+        indiscriminate_weapons:,
+        # Copyright or trademark infringement.
+        intellectual_property:,
+        # Imitation of the signature style of a specific living artist.
+        living_artist_style:,
+        # Age-coded language that suggests the subject is a minor.
+        minor_coded_language:,
+        # Non-consensual intimate imagery: undressing, nudifying or sexualising a real
+        # person.
+        non_consensual_intimate_imagery:,
+        # Non-violent crimes.
+        non_violent_crimes:,
+        # Sensitive private information about a person.
+        privacy:,
+        # An attempt to override or manipulate the instructions of the system.
+        prompt_injection:,
+        # The likeness of a real, identifiable, named person.
+        real_person_likeness:,
+        # Sex-related crimes.
+        sex_related_crimes:,
+        # Sexually explicit or pornographic content.
+        sexual_content:,
+        # Unqualified financial, medical, legal or electoral advice.
+        specialized_advice:,
+        # Suicide and self-harm.
+        suicide_and_self_harm:,
+        # Violent crimes.
+        violent_crimes:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            child_sexual_exploitation: Float,
+            defamation: Float,
+            hate: Float,
+            indiscriminate_weapons: Float,
+            intellectual_property: Float,
+            living_artist_style: Float,
+            minor_coded_language: Float,
+            non_consensual_intimate_imagery: Float,
+            non_violent_crimes: Float,
+            privacy: Float,
+            prompt_injection: Float,
+            real_person_likeness: Float,
+            sex_related_crimes: Float,
+            sexual_content: Float,
+            specialized_advice: Float,
+            suicide_and_self_harm: Float,
+            violent_crimes: Float
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/moderation_decision.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+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
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Dodopayments::ModerationDecision) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      ALLOW = T.let(:allow, Dodopayments::ModerationDecision::TaggedSymbol)
+      FLAG = T.let(:flag, Dodopayments::ModerationDecision::TaggedSymbol)
+      DENY = T.let(:deny, Dodopayments::ModerationDecision::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Dodopayments::ModerationDecision::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/moderation_provenance.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+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
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Dodopayments::ModerationProvenance) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      TARGETED =
+        T.let(:targeted, Dodopayments::ModerationProvenance::TaggedSymbol)
+      BROAD = T.let(:broad, Dodopayments::ModerationProvenance::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Dodopayments::ModerationProvenance::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/moderation_retrieve_usage_params.rbi

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

data/rbi/dodopayments/models/moderation_retrieve_usage_response.rbi

@@ -0,0 +1,104 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ModerationRetrieveUsageResponse < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::Models::ModerationRetrieveUsageResponse,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Your billable screens per UTC day for the last 30 days, charged or not. A day
+      # with no screens is not in the list.
+      sig do
+        returns(
+          T::Array[Dodopayments::Models::ModerationRetrieveUsageResponse::Daily]
+        )
+      end
+      attr_accessor :daily
+
+      # 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.
+      sig { returns(Integer) }
+      attr_accessor :screens_to_next_block
+
+      # Billable screens that Dodo Payments has not charged for yet.
+      sig { returns(Integer) }
+      attr_accessor :unbilled_screens
+
+      # Your moderation usage.
+      sig do
+        params(
+          daily:
+            T::Array[
+              Dodopayments::Models::ModerationRetrieveUsageResponse::Daily::OrHash
+            ],
+          screens_to_next_block: Integer,
+          unbilled_screens: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Your billable screens per UTC day for the last 30 days, charged or not. A day
+        # with no screens is not in the list.
+        daily:,
+        # 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.
+        screens_to_next_block:,
+        # Billable screens that Dodo Payments has not charged for yet.
+        unbilled_screens:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            daily:
+              T::Array[
+                Dodopayments::Models::ModerationRetrieveUsageResponse::Daily
+              ],
+            screens_to_next_block: Integer,
+            unbilled_screens: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Daily < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Models::ModerationRetrieveUsageResponse::Daily,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The UTC day.
+        sig { returns(Date) }
+        attr_accessor :date
+
+        # Billable screens on that day.
+        sig { returns(Integer) }
+        attr_accessor :screens
+
+        sig { params(date: Date, screens: Integer).returns(T.attached_class) }
+        def self.new(
+          # The UTC day.
+          date:,
+          # Billable screens on that day.
+          screens:
+        )
+        end
+
+        sig { override.returns({ date: Date, screens: Integer }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end