stripe 20.0.0 → 20.1.0.pre.alpha.1

data/lib/stripe/resources/v2/signals/account_evaluation.rb

@@ -0,0 +1,247 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Signals
+      # Account Evaluation resource for the Signals API.
+      class AccountEvaluation < APIResource
+        OBJECT_NAME = "v2.signals.account_evaluation"
+        def self.object_name
+          "v2.signals.account_evaluation"
+        end
+
+        class AccountActivityDetails < ::Stripe::StripeObject
+          # The ID of the account activity created or associated with the evaluation.
+          attr_reader :account_activity
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class AccountDetails < ::Stripe::StripeObject
+          class Data < ::Stripe::StripeObject
+            class Defaults < ::Stripe::StripeObject
+              class Profile < ::Stripe::StripeObject
+                # The business URL.
+                attr_reader :business_url
+                # Doing business as (DBA) name.
+                attr_reader :doing_business_as
+                # Description of the account's product or service.
+                attr_reader :product_description
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # Account profile data.
+              attr_reader :profile
+
+              def self.inner_class_types
+                @inner_class_types = { profile: Profile }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+
+            class Identity < ::Stripe::StripeObject
+              class BusinessDetails < ::Stripe::StripeObject
+                # Registered business name.
+                attr_reader :registered_name
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # Business details for identity data.
+              attr_reader :business_details
+
+              def self.inner_class_types
+                @inner_class_types = { business_details: BusinessDetails }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Default account settings.
+            attr_reader :defaults
+            # Identity data.
+            attr_reader :identity
+
+            def self.inner_class_types
+              @inner_class_types = { defaults: Defaults, identity: Identity }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The v2 account ID of the account.
+          attr_reader :account
+          # The v1 customer ID of the account, for users not yet migrated to v2/accounts.
+          attr_reader :customer
+          # Inline account data to evaluate without creating a v2 account.
+          attr_reader :data
+
+          def self.inner_class_types
+            @inner_class_types = { data: Data }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class EvaluatedSignals < ::Stripe::StripeObject
+          class FraudulentWebsite < ::Stripe::StripeObject
+            # Human-readable details about the fraudulent website evaluation, when available.
+            attr_reader :details
+            # Timestamp at which the signal was evaluated.
+            attr_reader :evaluated_at
+            # Categorical assessment of the fraudulent website risk.
+            attr_reader :risk_level
+            # The account signal ID containing the full fraudulent website signal result.
+            attr_reader :signal
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class UserAccountSharing < ::Stripe::StripeObject
+            # Timestamp at which the signal was evaluated.
+            attr_reader :evaluated_at
+            # Categorical assessment of the account-sharing risk.
+            attr_reader :risk_level
+            # The specific risk score for the account, between 0.00 and 100.00, when available.
+            attr_reader :score
+            # The account signal ID containing the full user account-sharing signal result.
+            attr_reader :signal
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = { score: :decimal_string }
+            end
+          end
+
+          class UserMultiAccounting < ::Stripe::StripeObject
+            # Timestamp at which the signal was evaluated.
+            attr_reader :evaluated_at
+            # Categorical assessment of the multi-accounting risk.
+            attr_reader :risk_level
+            # The specific risk score for the account, between 0.00 and 100.00, when available.
+            attr_reader :score
+            # The account signal ID containing the full user multi-accounting signal result.
+            attr_reader :signal
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = { score: :decimal_string }
+            end
+          end
+          # Fraudulent website result for the evaluation, when available.
+          attr_reader :fraudulent_website
+          # User account-sharing result for the evaluation, when available.
+          attr_reader :user_account_sharing
+          # User multi-accounting result for the evaluation, when available.
+          attr_reader :user_multi_accounting
+
+          def self.inner_class_types
+            @inner_class_types = {
+              fraudulent_website: FraudulentWebsite,
+              user_account_sharing: UserAccountSharing,
+              user_multi_accounting: UserMultiAccounting,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = {
+              user_account_sharing: { kind: :object, fields: { score: :decimal_string } },
+              user_multi_accounting: { kind: :object, fields: { score: :decimal_string } },
+            }
+          end
+        end
+        # Account activity recorded alongside this evaluation, when applicable.
+        attr_reader :account_activity_details
+        # The account, customer, or inline account data being evaluated.
+        attr_reader :account_details
+        # Timestamp at which the evaluation was created.
+        attr_reader :created
+        # Signal results that are available for the evaluation.
+        attr_reader :evaluated_signals
+        # Unique identifier for the account evaluation.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # List of signals still pending evaluation.
+        attr_reader :pending_signals
+        # List of signals requested for evaluation.
+        attr_reader :requested_signals
+
+        def self.inner_class_types
+          @inner_class_types = {
+            account_activity_details: AccountActivityDetails,
+            account_details: AccountDetails,
+            evaluated_signals: EvaluatedSignals,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+
+        def self.field_encodings
+          @field_encodings = {
+            evaluated_signals: {
+              kind: :object,
+              fields: {
+                user_account_sharing: { kind: :object, fields: { score: :decimal_string } },
+                user_multi_accounting: { kind: :object, fields: { score: :decimal_string } },
+              },
+            },
+          }
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/signals/account_signal.rb

@@ -0,0 +1,339 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Signals
+      # An automatically evaluated signal on an account. Each Account Signal object corresponds to
+      # exactly one signal type, indicated by type. Only the type-specific field is populated; other
+      # type-specific payload fields are null. If an account has multiple signals, Stripe creates
+      # separate account signal objects.
+      class AccountSignal < APIResource
+        OBJECT_NAME = "v2.signals.account_signal"
+        def self.object_name
+          "v2.signals.account_signal"
+        end
+
+        class AccountDetails < ::Stripe::StripeObject
+          # The v2 account ID of the account.
+          attr_reader :account
+          # The v1 customer ID of the account, for users not yet migrated to v2/accounts.
+          attr_reader :customer
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class FraudulentMerchant < ::Stripe::StripeObject
+          class AdditionalDetails < ::Stripe::StripeObject
+            class Indicator < ::Stripe::StripeObject
+              # A brief explanation of how this indicator contributed to the fraudulent merchant probability.
+              attr_reader :explanation
+              # The effect this indicator had on the overall risk level.
+              attr_reader :impact
+              # The name of the specific indicator used in the risk assessment.
+              attr_reader :indicator
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Array of objects representing individual factors that contributed to the calculated probability. Absent when risk level is unknown,
+            # or when the user is not on a product tier that includes indicators.
+            attr_reader :indicators
+
+            def self.inner_class_types
+              @inner_class_types = { indicators: Indicator }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Supplementary contextual data for the signal, including indicators.
+          attr_reader :additional_details
+          # The probability of the merchant being fraudulent. Can be between 0.00 and 100.00. Absent when risk level is unknown,
+          # or when the user is not on a product tier that includes numeric scores.
+          attr_reader :probability
+          # Categorical assessment of the fraudulent merchant risk based on probability.
+          attr_reader :risk_level
+
+          def self.inner_class_types
+            @inner_class_types = { additional_details: AdditionalDetails }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = { probability: :decimal_string }
+          end
+        end
+
+        class FraudulentWebsite < ::Stripe::StripeObject
+          # Human-readable details about the fraudulent website evaluation.
+          attr_reader :details
+          # Categorical assessment of the fraudulent website risk.
+          attr_reader :risk_level
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class MerchantDelinquency < ::Stripe::StripeObject
+          class AdditionalDetails < ::Stripe::StripeObject
+            class Indicator < ::Stripe::StripeObject
+              # A brief explanation of how this indicator contributed to the delinquency probability.
+              attr_reader :explanation
+              # The effect this indicator had on the overall risk level.
+              attr_reader :impact
+              # The name of the specific indicator used in the risk assessment.
+              attr_reader :indicator
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Array of objects representing individual factors that contributed to the calculated probability of delinquency. Absent when risk level is unknown,
+            # or when the user is not on a product tier that includes indicators.
+            attr_reader :indicators
+
+            def self.inner_class_types
+              @inner_class_types = { indicators: Indicator }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Supplementary contextual data for the signal, including indicators.
+          attr_reader :additional_details
+          # The probability of delinquency. Can be between 0.00 and 100.00. Absent when risk level is unknown,
+          # or when the user is not on a product tier that includes numeric scores.
+          attr_reader :probability
+          # Categorical assessment of the delinquency risk based on probability.
+          attr_reader :risk_level
+
+          def self.inner_class_types
+            @inner_class_types = { additional_details: AdditionalDetails }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = { probability: :decimal_string }
+          end
+        end
+
+        class PaymentDelinquencyExposure < ::Stripe::StripeObject
+          class AdditionalDetails < ::Stripe::StripeObject
+            class GrossExposureAmount < ::Stripe::StripeObject
+              # ISO 4217 currency code.
+              attr_reader :currency
+              # Amount in minor units for the given currency.
+              attr_reader :value
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+
+              def self.field_encodings
+                @field_encodings = { value: :int64_string }
+              end
+            end
+            # Total payments still exposed to dispute or refund risk in the event of delinquency.
+            attr_reader :gross_exposure_amount
+            # Percentage of Gross Exposure expected to be disputed or refunded and materialize as a loss in the event of delinquency.
+            attr_reader :loss_given_default_in_percentages
+            # Predicted window size in days until dispute is raised.
+            attr_reader :predicted_dispute_window_in_days
+
+            def self.inner_class_types
+              @inner_class_types = { gross_exposure_amount: GrossExposureAmount }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = {
+                gross_exposure_amount: { kind: :object, fields: { value: :int64_string } },
+              }
+            end
+          end
+
+          class ExposureAmount < ::Stripe::StripeObject
+            # ISO 4217 currency code.
+            attr_reader :currency
+            # Amount in minor units for the given currency.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = { value: :int64_string }
+            end
+          end
+          # Additional details about the exposure assessment.
+          attr_reader :additional_details
+          # The exposure amount if this account becomes delinquent.
+          attr_reader :exposure_amount
+
+          def self.inner_class_types
+            @inner_class_types = {
+              additional_details: AdditionalDetails,
+              exposure_amount: ExposureAmount,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = {
+              additional_details: {
+                kind: :object,
+                fields: { gross_exposure_amount: { kind: :object, fields: { value: :int64_string } } },
+              },
+              exposure_amount: { kind: :object, fields: { value: :int64_string } },
+            }
+          end
+        end
+
+        class UserAccountSharing < ::Stripe::StripeObject
+          # Categorical assessment of the account-sharing risk.
+          attr_reader :risk_level
+          # The specific risk score for the account, between 0.00 and 100.00. Absent when risk level is
+          # not_assessed or unknown, or when the user is not on a product tier that includes numeric scores.
+          attr_reader :score
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = { score: :decimal_string }
+          end
+        end
+
+        class UserMultiAccounting < ::Stripe::StripeObject
+          # Categorical assessment of the multi-accounting risk.
+          attr_reader :risk_level
+          # The specific risk score for the account, between 0.00 and 100.00. Absent when risk level is
+          # not_assessed or unknown, or when the user is not on a product tier that includes numeric scores.
+          attr_reader :score
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = { score: :decimal_string }
+          end
+        end
+        # The account or customer this signal is associated with.
+        attr_reader :account_details
+        # The account evaluation that produced this signal, if applicable.
+        attr_reader :account_evaluation
+        # Timestamp at which the signal was created.
+        attr_reader :created
+        # Data for the fraudulent merchant signal. Present only when type is fraudulent_merchant.
+        attr_reader :fraudulent_merchant
+        # Data for the fraudulent website signal. Present only when type is fraudulent_website.
+        attr_reader :fraudulent_website
+        # Unique identifier for the account signal.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # Data for the merchant delinquency signal. Present only when type is merchant_delinquency.
+        attr_reader :merchant_delinquency
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Data for the payment delinquency exposure signal. Present only when type is payment_delinquency_exposure.
+        attr_reader :payment_delinquency_exposure
+        # The type of signal.
+        attr_reader :type
+        # Data for the user account-sharing signal. Present only when type is user_account_sharing.
+        attr_reader :user_account_sharing
+        # Data for the user multi-accounting signal. Present only when type is user_multi_accounting.
+        attr_reader :user_multi_accounting
+
+        def self.inner_class_types
+          @inner_class_types = {
+            account_details: AccountDetails,
+            fraudulent_merchant: FraudulentMerchant,
+            fraudulent_website: FraudulentWebsite,
+            merchant_delinquency: MerchantDelinquency,
+            payment_delinquency_exposure: PaymentDelinquencyExposure,
+            user_account_sharing: UserAccountSharing,
+            user_multi_accounting: UserMultiAccounting,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+
+        def self.field_encodings
+          @field_encodings = {
+            fraudulent_merchant: { kind: :object, fields: { probability: :decimal_string } },
+            merchant_delinquency: { kind: :object, fields: { probability: :decimal_string } },
+            payment_delinquency_exposure: {
+              kind: :object,
+              fields: {
+                additional_details: {
+                  kind: :object,
+                  fields: { gross_exposure_amount: { kind: :object, fields: { value: :int64_string } } },
+                },
+                exposure_amount: { kind: :object, fields: { value: :int64_string } },
+              },
+            },
+            user_account_sharing: { kind: :object, fields: { score: :decimal_string } },
+            user_multi_accounting: { kind: :object, fields: { score: :decimal_string } },
+          }
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/signals/payment_retry_evaluation.rb

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Signals
+      # The PaymentRetryEvaluation resource represents an active or completed retry
+      # monitoring session for a specific failed payment.
+      class PaymentRetryEvaluation < APIResource
+        OBJECT_NAME = "v2.signals.payment_retry_evaluation"
+        def self.object_name
+          "v2.signals.payment_retry_evaluation"
+        end
+
+        # When the evaluation was canceled, if applicable.
+        attr_reader :canceled_at
+        # Reason provided for canceling the evaluation.
+        attr_reader :cancellation_reason
+        # When the evaluation was created.
+        attr_reader :created
+        # Unique identifier for the evaluation.
+        attr_reader :id
+        # The PaymentRetrySignal resource represents a single retry recommendation
+        # generated by the ML scoring model.
+        attr_reader :latest_signal
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The payment intent being evaluated, if provided instead of a payment record.
+        attr_reader :payment_intent
+        # The payment record being evaluated.
+        attr_reader :payment_record
+        # Current status of the evaluation.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/signals/payment_retry_signal.rb

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Signals
+      # The PaymentRetrySignal resource represents a single retry recommendation
+      # generated by the ML scoring model.
+      class PaymentRetrySignal < APIResource
+        OBJECT_NAME = "v2.signals.payment_retry_signal"
+        def self.object_name
+          "v2.signals.payment_retry_signal"
+        end
+
+        class Recommendation < ::Stripe::StripeObject
+          # The recommended action to take.
+          attr_reader :action
+          # Human-readable reason for the recommendation.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # When this signal was created.
+        attr_reader :created
+        # The evaluation that generated this signal.
+        attr_reader :evaluation
+        # Unique identifier for the signal.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The payment intent this signal relates to.
+        attr_reader :payment_intent
+        # The payment record this signal relates to.
+        attr_reader :payment_record
+        # The retry recommendation.
+        attr_reader :recommendation
+
+        def self.inner_class_types
+          @inner_class_types = { recommendation: Recommendation }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end