prelude-sdk 0.7.0 → 0.9.0

data/lib/prelude_sdk/resources/verification_management.rb

@@ -4,6 +4,10 @@ module PreludeSDK
   module Resources
     # Verify phone numbers.
     class VerificationManagement
+      # Verify phone numbers.
+      # @return [PreludeSDK::Resources::VerificationManagement::Sandbox]
+      attr_reader :sandbox
+
       # Remove a phone number from the allow or block list.
       #
       # This operation is idempotent - re-deleting the same phone number will not result
@@ -135,6 +139,7 @@ module PreludeSDK
       # @param client [PreludeSDK::Client]
       def initialize(client:)
         @client = client
+        @sandbox = PreludeSDK::Resources::VerificationManagement::Sandbox.new(client: client)
       end
     end
   end

data/lib/prelude_sdk/resources/watch.rb

@@ -4,6 +4,49 @@ module PreludeSDK
   module Resources
     # Evaluate email addresses and phone numbers for trustworthiness.
     class Watch
+      # Some parameter documentations has been truncated, see
+      # {PreludeSDK::Models::WatchEvaluateParams} for more details.
+      #
+      # **Beta.** The request and response shapes may still change. Talk to us before
+      # you build against it. Flows, recipes and rules are authored through the Watch
+      # Management API, or configured by Prelude on your behalf.
+      #
+      # Score a target against the rules configured for one moment in your product —
+      # signup, checkout, password reset. The flow selects which recipes run; each
+      # recipe scores its rules against a threshold and returns its own verdict, and the
+      # evaluation answers with the most severe verdict and action across them. Where
+      # Predict returns a single model-derived outcome, Eval returns the full breakdown,
+      # so you can see which rules fired and which could not run. Scoring-only — it does
+      # not update counters by itself.
+      #
+      # @overload evaluate(flow_id:, target:, attributes: nil, dispatch_id: nil, signals: nil, request_options: {})
+      #
+      # @param flow_id [String] The flow to evaluate. A flow names the moment you are guarding and selects the r
+      #
+      # @param target [PreludeSDK::Models::Target] The identifier to score — a phone number or email address.
+      #
+      # @param attributes [Hash{Symbol=>String}] Values for the attributes the flow's recipes declare, keyed without the `attr.`
+      #
+      # @param dispatch_id [String] The identifier of the dispatch that came from the front-end SDK. Signals it carr
+      #
+      # @param signals [PreludeSDK::Models::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::WatchEvaluateResponse]
+      #
+      # @see PreludeSDK::Models::WatchEvaluateParams
+      def evaluate(params)
+        parsed, options = PreludeSDK::WatchEvaluateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v2/watch/eval",
+          body: parsed,
+          model: PreludeSDK::Models::WatchEvaluateResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {PreludeSDK::Models::WatchPredictParams} for more details.
       #
@@ -16,13 +59,13 @@ module PreludeSDK
       #
       # @overload predict(target:, dispatch_id: nil, metadata: nil, signals: nil, request_options: {})
       #
-      # @param target [PreludeSDK::Models::WatchPredictParams::Target] The signup identifier to score — a phone number or email address.
+      # @param target [PreludeSDK::Models::Target] The signup identifier to score — a phone number or email address.
       #
       # @param dispatch_id [String] The identifier of the dispatch that came from the front-end SDK.
       #
       # @param metadata [PreludeSDK::Models::WatchPredictParams::Metadata] The metadata for this prediction.
       #
-      # @param signals [PreludeSDK::Models::WatchPredictParams::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
+      # @param signals [PreludeSDK::Models::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
       #
       # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/prelude_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PreludeSDK
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

data/lib/prelude_sdk.rb

@@ -52,6 +52,8 @@ require_relative "prelude_sdk/errors"
 require_relative "prelude_sdk/internal/transport/base_client"
 require_relative "prelude_sdk/internal/transport/pooled_net_requester"
 require_relative "prelude_sdk/client"
+require_relative "prelude_sdk/models/intel/kyc_match_params"
+require_relative "prelude_sdk/models/intel/kyc_match_response"
 require_relative "prelude_sdk/models/lookup_lookup_params"
 require_relative "prelude_sdk/models/lookup_lookup_response"
 require_relative "prelude_sdk/models/notify_get_subscription_config_params"
@@ -64,16 +66,33 @@ require_relative "prelude_sdk/models/notify_list_subscription_phone_number_event
 require_relative "prelude_sdk/models/notify_list_subscription_phone_number_events_response"
 require_relative "prelude_sdk/models/notify_list_subscription_phone_numbers_params"
 require_relative "prelude_sdk/models/notify_list_subscription_phone_numbers_response"
+require_relative "prelude_sdk/models/notify_reply_params"
+require_relative "prelude_sdk/models/notify_reply_response"
 require_relative "prelude_sdk/models/notify_send_batch_params"
 require_relative "prelude_sdk/models/notify_send_batch_response"
 require_relative "prelude_sdk/models/notify_send_params"
 require_relative "prelude_sdk/models/notify_send_response"
+require_relative "prelude_sdk/models/signals"
+require_relative "prelude_sdk/models/target"
 require_relative "prelude_sdk/models/transactional_send_params"
 require_relative "prelude_sdk/models/transactional_send_response"
+require_relative "prelude_sdk/models/verification/phone/history_list_params"
+require_relative "prelude_sdk/models/verification/phone/history_list_response"
+require_relative "prelude_sdk/models/verification/phone/history_retrieve_params"
+require_relative "prelude_sdk/models/verification/phone/history_retrieve_response"
+require_relative "prelude_sdk/models/verification/phone/phone_verification_carrier"
+require_relative "prelude_sdk/models/verification/phone/phone_verification_money"
+require_relative "prelude_sdk/models/verification/phone/phone_verification_psd2_transaction"
 require_relative "prelude_sdk/models/verification_check_params"
 require_relative "prelude_sdk/models/verification_check_response"
 require_relative "prelude_sdk/models/verification_create_params"
 require_relative "prelude_sdk/models/verification_create_response"
+require_relative "prelude_sdk/models/verification_management/sandbox_add_phone_number_params"
+require_relative "prelude_sdk/models/verification_management/sandbox_add_phone_number_response"
+require_relative "prelude_sdk/models/verification_management/sandbox_delete_phone_number_params"
+require_relative "prelude_sdk/models/verification_management/sandbox_delete_phone_number_response"
+require_relative "prelude_sdk/models/verification_management/sandbox_list_phone_numbers_params"
+require_relative "prelude_sdk/models/verification_management/sandbox_list_phone_numbers_response"
 require_relative "prelude_sdk/models/verification_management_delete_phone_number_params"
 require_relative "prelude_sdk/models/verification_management_delete_phone_number_response"
 require_relative "prelude_sdk/models/verification_management_list_phone_numbers_params"
@@ -84,6 +103,8 @@ require_relative "prelude_sdk/models/verification_management_set_phone_number_pa
 require_relative "prelude_sdk/models/verification_management_set_phone_number_response"
 require_relative "prelude_sdk/models/verification_management_submit_sender_id_params"
 require_relative "prelude_sdk/models/verification_management_submit_sender_id_response"
+require_relative "prelude_sdk/models/watch_evaluate_params"
+require_relative "prelude_sdk/models/watch_evaluate_response"
 require_relative "prelude_sdk/models/watch_predict_params"
 require_relative "prelude_sdk/models/watch_predict_response"
 require_relative "prelude_sdk/models/watch_send_events_params"
@@ -91,9 +112,14 @@ require_relative "prelude_sdk/models/watch_send_events_response"
 require_relative "prelude_sdk/models/watch_send_feedbacks_params"
 require_relative "prelude_sdk/models/watch_send_feedbacks_response"
 require_relative "prelude_sdk/models"
+require_relative "prelude_sdk/resources/intel"
+require_relative "prelude_sdk/resources/intel/kyc"
 require_relative "prelude_sdk/resources/lookup"
 require_relative "prelude_sdk/resources/notify"
 require_relative "prelude_sdk/resources/transactional"
 require_relative "prelude_sdk/resources/verification"
+require_relative "prelude_sdk/resources/verification/phone"
+require_relative "prelude_sdk/resources/verification/phone/history"
 require_relative "prelude_sdk/resources/verification_management"
+require_relative "prelude_sdk/resources/verification_management/sandbox"
 require_relative "prelude_sdk/resources/watch"

data/rbi/prelude_sdk/client.rbi

@@ -39,6 +39,9 @@ module PreludeSDK
     sig { returns(PreludeSDK::Resources::Watch) }
     attr_reader :watch
 
+    sig { returns(PreludeSDK::Resources::Intel) }
+    attr_reader :intel
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/prelude_sdk/models/intel/kyc_match_params.rbi

@@ -0,0 +1,147 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module Intel
+      class KYCMatchParams < PreludeSDK::Internal::Type::BaseModel
+        extend PreludeSDK::Internal::Type::RequestParameters::Converter
+        include PreludeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Intel::KYCMatchParams,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # An E.164 formatted phone number whose subscriber identity to match against.
+        sig { returns(String) }
+        attr_accessor :phone
+
+        # The street address.
+        sig { returns(T.nilable(String)) }
+        attr_reader :address
+
+        sig { params(address: String).void }
+        attr_writer :address
+
+        # The date of birth in ISO 8601 (`YYYY-MM-DD`) format. Compared exactly.
+        sig { returns(T.nilable(Date)) }
+        attr_reader :birthdate
+
+        sig { params(birthdate: Date).void }
+        attr_writer :birthdate
+
+        # The ISO 3166-1 alpha-2 country code. Compared exactly.
+        sig { returns(T.nilable(String)) }
+        attr_reader :country
+
+        sig { params(country: String).void }
+        attr_writer :country
+
+        # The email address.
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        # The end-user's family (last) name.
+        sig { returns(T.nilable(String)) }
+        attr_reader :family_name
+
+        sig { params(family_name: String).void }
+        attr_writer :family_name
+
+        # The end-user's given (first) name.
+        sig { returns(T.nilable(String)) }
+        attr_reader :given_name
+
+        sig { params(given_name: String).void }
+        attr_writer :given_name
+
+        # The locality (city).
+        sig { returns(T.nilable(String)) }
+        attr_reader :locality
+
+        sig { params(locality: String).void }
+        attr_writer :locality
+
+        # The postal code. Compared exactly.
+        sig { returns(T.nilable(String)) }
+        attr_reader :postal_code
+
+        sig { params(postal_code: String).void }
+        attr_writer :postal_code
+
+        # The region, state, or province.
+        sig { returns(T.nilable(String)) }
+        attr_reader :region
+
+        sig { params(region: String).void }
+        attr_writer :region
+
+        sig do
+          params(
+            phone: String,
+            address: String,
+            birthdate: Date,
+            country: String,
+            email: String,
+            family_name: String,
+            given_name: String,
+            locality: String,
+            postal_code: String,
+            region: String,
+            request_options: PreludeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An E.164 formatted phone number whose subscriber identity to match against.
+          phone:,
+          # The street address.
+          address: nil,
+          # The date of birth in ISO 8601 (`YYYY-MM-DD`) format. Compared exactly.
+          birthdate: nil,
+          # The ISO 3166-1 alpha-2 country code. Compared exactly.
+          country: nil,
+          # The email address.
+          email: nil,
+          # The end-user's family (last) name.
+          family_name: nil,
+          # The end-user's given (first) name.
+          given_name: nil,
+          # The locality (city).
+          locality: nil,
+          # The postal code. Compared exactly.
+          postal_code: nil,
+          # The region, state, or province.
+          region: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              phone: String,
+              address: String,
+              birthdate: Date,
+              country: String,
+              email: String,
+              family_name: String,
+              given_name: String,
+              locality: String,
+              postal_code: String,
+              region: String,
+              request_options: PreludeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end