prelude-sdk 0.7.0 → 0.8.0

data/sig/prelude_sdk/models/watch_evaluate_response.rbs

@@ -0,0 +1,178 @@
+module PreludeSDK
+  module Models
+    type watch_evaluate_response =
+      {
+        id: String,
+        action: PreludeSDK::Models::WatchEvaluateResponse::action,
+        recipes: ::Array[PreludeSDK::Models::WatchEvaluateResponse::Recipe],
+        verdict: PreludeSDK::Models::WatchEvaluateResponse::verdict
+      }
+
+    class WatchEvaluateResponse < PreludeSDK::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor action: PreludeSDK::Models::WatchEvaluateResponse::action
+
+      attr_accessor recipes: ::Array[PreludeSDK::Models::WatchEvaluateResponse::Recipe]
+
+      attr_accessor verdict: PreludeSDK::Models::WatchEvaluateResponse::verdict
+
+      def initialize: (
+        id: String,
+        action: PreludeSDK::Models::WatchEvaluateResponse::action,
+        recipes: ::Array[PreludeSDK::Models::WatchEvaluateResponse::Recipe],
+        verdict: PreludeSDK::Models::WatchEvaluateResponse::verdict
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        action: PreludeSDK::Models::WatchEvaluateResponse::action,
+        recipes: ::Array[PreludeSDK::Models::WatchEvaluateResponse::Recipe],
+        verdict: PreludeSDK::Models::WatchEvaluateResponse::verdict
+      }
+
+      type action = :ALLOW | :BLOCK | :CHALLENGE
+
+      module Action
+        extend PreludeSDK::Internal::Type::Enum
+
+        ALLOW: :ALLOW
+        BLOCK: :BLOCK
+        CHALLENGE: :CHALLENGE
+
+        def self?.values: -> ::Array[PreludeSDK::Models::WatchEvaluateResponse::action]
+      end
+
+      type recipe =
+        {
+          partial_evidence: bool,
+          recipe_id: String,
+          rules: ::Array[PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule],
+          score: Integer,
+          threshold: Integer,
+          verdict: PreludeSDK::Models::WatchEvaluateResponse::Recipe::verdict,
+          determined_by: String
+        }
+
+      class Recipe < PreludeSDK::Internal::Type::BaseModel
+        attr_accessor partial_evidence: bool
+
+        attr_accessor recipe_id: String
+
+        attr_accessor rules: ::Array[PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule]
+
+        attr_accessor score: Integer
+
+        attr_accessor threshold: Integer
+
+        attr_accessor verdict: PreludeSDK::Models::WatchEvaluateResponse::Recipe::verdict
+
+        attr_reader determined_by: String?
+
+        def determined_by=: (String) -> String
+
+        def initialize: (
+          partial_evidence: bool,
+          recipe_id: String,
+          rules: ::Array[PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule],
+          score: Integer,
+          threshold: Integer,
+          verdict: PreludeSDK::Models::WatchEvaluateResponse::Recipe::verdict,
+          ?determined_by: String
+        ) -> void
+
+        def to_hash: -> {
+          partial_evidence: bool,
+          recipe_id: String,
+          rules: ::Array[PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule],
+          score: Integer,
+          threshold: Integer,
+          verdict: PreludeSDK::Models::WatchEvaluateResponse::Recipe::verdict,
+          determined_by: String
+        }
+
+        type rule =
+          {
+            outcome: PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::outcome,
+            rule_id: String,
+            weight: Integer,
+            blocked_by: String,
+            name: String,
+            unavailable: bool
+          }
+
+        class Rule < PreludeSDK::Internal::Type::BaseModel
+          attr_accessor outcome: PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::outcome
+
+          attr_accessor rule_id: String
+
+          attr_accessor weight: Integer
+
+          attr_reader blocked_by: String?
+
+          def blocked_by=: (String) -> String
+
+          attr_reader name: String?
+
+          def name=: (String) -> String
+
+          attr_reader unavailable: bool?
+
+          def unavailable=: (bool) -> bool
+
+          def initialize: (
+            outcome: PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::outcome,
+            rule_id: String,
+            weight: Integer,
+            ?blocked_by: String,
+            ?name: String,
+            ?unavailable: bool
+          ) -> void
+
+          def to_hash: -> {
+            outcome: PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::outcome,
+            rule_id: String,
+            weight: Integer,
+            blocked_by: String,
+            name: String,
+            unavailable: bool
+          }
+
+          type outcome = :TRIGGERED | :NOT_TRIGGERED | :NOT_EVALUATED
+
+          module Outcome
+            extend PreludeSDK::Internal::Type::Enum
+
+            TRIGGERED: :TRIGGERED
+            NOT_TRIGGERED: :NOT_TRIGGERED
+            NOT_EVALUATED: :NOT_EVALUATED
+
+            def self?.values: -> ::Array[PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::outcome]
+          end
+        end
+
+        type verdict = :PASS | :FLAG
+
+        module Verdict
+          extend PreludeSDK::Internal::Type::Enum
+
+          PASS: :PASS
+          FLAG: :FLAG
+
+          def self?.values: -> ::Array[PreludeSDK::Models::WatchEvaluateResponse::Recipe::verdict]
+        end
+      end
+
+      type verdict = :PASS | :FLAG
+
+      module Verdict
+        extend PreludeSDK::Internal::Type::Enum
+
+        PASS: :PASS
+        FLAG: :FLAG
+
+        def self?.values: -> ::Array[PreludeSDK::Models::WatchEvaluateResponse::verdict]
+      end
+    end
+  end
+end

data/sig/prelude_sdk/models/watch_predict_params.rbs

@@ -2,10 +2,10 @@ module PreludeSDK
   module Models
     type watch_predict_params =
       {
-        target: PreludeSDK::WatchPredictParams::Target,
+        target: PreludeSDK::Target,
         dispatch_id: String,
         metadata: PreludeSDK::WatchPredictParams::Metadata,
-        signals: PreludeSDK::WatchPredictParams::Signals
+        signals: PreludeSDK::Signals
       }
       & PreludeSDK::Internal::Type::request_parameters
 
@@ -13,7 +13,7 @@ module PreludeSDK
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
-      attr_accessor target: PreludeSDK::WatchPredictParams::Target
+      attr_accessor target: PreludeSDK::Target
 
       attr_reader dispatch_id: String?
 
@@ -25,61 +25,26 @@ module PreludeSDK
         PreludeSDK::WatchPredictParams::Metadata
       ) -> PreludeSDK::WatchPredictParams::Metadata
 
-      attr_reader signals: PreludeSDK::WatchPredictParams::Signals?
+      attr_reader signals: PreludeSDK::Signals?
 
-      def signals=: (
-        PreludeSDK::WatchPredictParams::Signals
-      ) -> PreludeSDK::WatchPredictParams::Signals
+      def signals=: (PreludeSDK::Signals) -> PreludeSDK::Signals
 
       def initialize: (
-        target: PreludeSDK::WatchPredictParams::Target,
+        target: PreludeSDK::Target,
         ?dispatch_id: String,
         ?metadata: PreludeSDK::WatchPredictParams::Metadata,
-        ?signals: PreludeSDK::WatchPredictParams::Signals,
+        ?signals: PreludeSDK::Signals,
         ?request_options: PreludeSDK::request_opts
       ) -> void
 
       def to_hash: -> {
-        target: PreludeSDK::WatchPredictParams::Target,
+        target: PreludeSDK::Target,
         dispatch_id: String,
         metadata: PreludeSDK::WatchPredictParams::Metadata,
-        signals: PreludeSDK::WatchPredictParams::Signals,
+        signals: PreludeSDK::Signals,
         request_options: PreludeSDK::RequestOptions
       }
 
-      type target =
-        {
-          type: PreludeSDK::Models::WatchPredictParams::Target::type_,
-          value: String
-        }
-
-      class Target < PreludeSDK::Internal::Type::BaseModel
-        attr_accessor type: PreludeSDK::Models::WatchPredictParams::Target::type_
-
-        attr_accessor value: String
-
-        def initialize: (
-          type: PreludeSDK::Models::WatchPredictParams::Target::type_,
-          value: String
-        ) -> void
-
-        def to_hash: -> {
-          type: PreludeSDK::Models::WatchPredictParams::Target::type_,
-          value: String
-        }
-
-        type type_ = :phone_number | :email_address
-
-        module Type
-          extend PreludeSDK::Internal::Type::Enum
-
-          PHONE_NUMBER: :phone_number
-          EMAIL_ADDRESS: :email_address
-
-          def self?.values: -> ::Array[PreludeSDK::Models::WatchPredictParams::Target::type_]
-        end
-      end
-
       type metadata = { correlation_id: String }
 
       class Metadata < PreludeSDK::Internal::Type::BaseModel
@@ -91,104 +56,6 @@ module PreludeSDK
 
         def to_hash: -> { correlation_id: String }
       end
-
-      type signals =
-        {
-          app_version: String,
-          device_id: String,
-          device_model: String,
-          device_platform: PreludeSDK::Models::WatchPredictParams::Signals::device_platform,
-          existing_user: bool,
-          ip: String,
-          is_trusted_user: bool,
-          :ja4_fingerprint => String,
-          os_version: String,
-          user_agent: String
-        }
-
-      class Signals < PreludeSDK::Internal::Type::BaseModel
-        attr_reader app_version: String?
-
-        def app_version=: (String) -> String
-
-        attr_reader device_id: String?
-
-        def device_id=: (String) -> String
-
-        attr_reader device_model: String?
-
-        def device_model=: (String) -> String
-
-        attr_reader device_platform: PreludeSDK::Models::WatchPredictParams::Signals::device_platform?
-
-        def device_platform=: (
-          PreludeSDK::Models::WatchPredictParams::Signals::device_platform
-        ) -> PreludeSDK::Models::WatchPredictParams::Signals::device_platform
-
-        attr_reader existing_user: bool?
-
-        def existing_user=: (bool) -> bool
-
-        attr_reader ip: String?
-
-        def ip=: (String) -> String
-
-        attr_reader is_trusted_user: bool?
-
-        def is_trusted_user=: (bool) -> bool
-
-        attr_reader ja4_fingerprint: String?
-
-        def ja4_fingerprint=: (String) -> String
-
-        attr_reader os_version: String?
-
-        def os_version=: (String) -> String
-
-        attr_reader user_agent: String?
-
-        def user_agent=: (String) -> String
-
-        def initialize: (
-          ?app_version: String,
-          ?device_id: String,
-          ?device_model: String,
-          ?device_platform: PreludeSDK::Models::WatchPredictParams::Signals::device_platform,
-          ?existing_user: bool,
-          ?ip: String,
-          ?is_trusted_user: bool,
-          ?ja4_fingerprint: String,
-          ?os_version: String,
-          ?user_agent: String
-        ) -> void
-
-        def to_hash: -> {
-          app_version: String,
-          device_id: String,
-          device_model: String,
-          device_platform: PreludeSDK::Models::WatchPredictParams::Signals::device_platform,
-          existing_user: bool,
-          ip: String,
-          is_trusted_user: bool,
-          :ja4_fingerprint => String,
-          os_version: String,
-          user_agent: String
-        }
-
-        type device_platform = :android | :ios | :ipados | :tvos | :web
-
-        module DevicePlatform
-          extend PreludeSDK::Internal::Type::Enum
-
-          ANDROID: :android
-          IOS: :ios
-          IPADOS: :ipados
-          TVOS: :tvos
-          WEB: :web
-
-          def self?.values: -> ::Array[PreludeSDK::Models::WatchPredictParams::Signals::device_platform]
-        end
-      end
     end
   end
 end

data/sig/prelude_sdk/models/watch_send_events_params.rbs

@@ -24,7 +24,7 @@ module PreludeSDK
         {
           confidence: PreludeSDK::Models::WatchSendEventsParams::Event::confidence,
           label: String,
-          target: PreludeSDK::WatchSendEventsParams::Event::Target
+          target: PreludeSDK::Target
         }
 
       class Event < PreludeSDK::Internal::Type::BaseModel
@@ -32,18 +32,18 @@ module PreludeSDK
 
         attr_accessor label: String
 
-        attr_accessor target: PreludeSDK::WatchSendEventsParams::Event::Target
+        attr_accessor target: PreludeSDK::Target
 
         def initialize: (
           confidence: PreludeSDK::Models::WatchSendEventsParams::Event::confidence,
           label: String,
-          target: PreludeSDK::WatchSendEventsParams::Event::Target
+          target: PreludeSDK::Target
         ) -> void
 
         def to_hash: -> {
           confidence: PreludeSDK::Models::WatchSendEventsParams::Event::confidence,
           label: String,
-          target: PreludeSDK::WatchSendEventsParams::Event::Target
+          target: PreludeSDK::Target
         }
 
         type confidence = :maximum | :high | :neutral | :low | :minimum
@@ -59,39 +59,6 @@ module PreludeSDK
 
           def self?.values: -> ::Array[PreludeSDK::Models::WatchSendEventsParams::Event::confidence]
         end
-
-        type target =
-          {
-            type: PreludeSDK::Models::WatchSendEventsParams::Event::Target::type_,
-            value: String
-          }
-
-        class Target < PreludeSDK::Internal::Type::BaseModel
-          attr_accessor type: PreludeSDK::Models::WatchSendEventsParams::Event::Target::type_
-
-          attr_accessor value: String
-
-          def initialize: (
-            type: PreludeSDK::Models::WatchSendEventsParams::Event::Target::type_,
-            value: String
-          ) -> void
-
-          def to_hash: -> {
-            type: PreludeSDK::Models::WatchSendEventsParams::Event::Target::type_,
-            value: String
-          }
-
-          type type_ = :phone_number | :email_address
-
-          module Type
-            extend PreludeSDK::Internal::Type::Enum
-
-            PHONE_NUMBER: :phone_number
-            EMAIL_ADDRESS: :email_address
-
-            def self?.values: -> ::Array[PreludeSDK::Models::WatchSendEventsParams::Event::Target::type_]
-          end
-        end
       end
     end
   end

data/sig/prelude_sdk/models/watch_send_feedbacks_params.rbs

@@ -22,13 +22,13 @@ module PreludeSDK
 
       type feedback =
         {
-          target: PreludeSDK::WatchSendFeedbacksParams::Feedback::Target,
+          target: PreludeSDK::Target,
           type: PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::type_,
           metadata: PreludeSDK::WatchSendFeedbacksParams::Feedback::Metadata
         }
 
       class Feedback < PreludeSDK::Internal::Type::BaseModel
-        attr_accessor target: PreludeSDK::WatchSendFeedbacksParams::Feedback::Target
+        attr_accessor target: PreludeSDK::Target
 
         attr_accessor type: PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::type_
 
@@ -39,50 +39,17 @@ module PreludeSDK
         ) -> PreludeSDK::WatchSendFeedbacksParams::Feedback::Metadata
 
         def initialize: (
-          target: PreludeSDK::WatchSendFeedbacksParams::Feedback::Target,
+          target: PreludeSDK::Target,
           type: PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::type_,
           ?metadata: PreludeSDK::WatchSendFeedbacksParams::Feedback::Metadata
         ) -> void
 
         def to_hash: -> {
-          target: PreludeSDK::WatchSendFeedbacksParams::Feedback::Target,
+          target: PreludeSDK::Target,
           type: PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::type_,
           metadata: PreludeSDK::WatchSendFeedbacksParams::Feedback::Metadata
         }
 
-        type target =
-          {
-            type: PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Target::type_,
-            value: String
-          }
-
-        class Target < PreludeSDK::Internal::Type::BaseModel
-          attr_accessor type: PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Target::type_
-
-          attr_accessor value: String
-
-          def initialize: (
-            type: PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Target::type_,
-            value: String
-          ) -> void
-
-          def to_hash: -> {
-            type: PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Target::type_,
-            value: String
-          }
-
-          type type_ = :phone_number | :email_address
-
-          module Type
-            extend PreludeSDK::Internal::Type::Enum
-
-            PHONE_NUMBER: :phone_number
-            EMAIL_ADDRESS: :email_address
-
-            def self?.values: -> ::Array[PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Target::type_]
-          end
-        end
-
         type type_ = :"verification.started" | :"verification.completed"
 
         module Type

data/sig/prelude_sdk/models.rbs

@@ -1,4 +1,6 @@
 module PreludeSDK
+  module Intel = PreludeSDK::Models::Intel
+
   class LookupLookupParams = PreludeSDK::Models::LookupLookupParams
 
   class NotifyGetSubscriptionConfigParams = PreludeSDK::Models::NotifyGetSubscriptionConfigParams
@@ -11,16 +13,26 @@ module PreludeSDK
 
   class NotifyListSubscriptionPhoneNumbersParams = PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams
 
+  class NotifyReplyParams = PreludeSDK::Models::NotifyReplyParams
+
   class NotifySendBatchParams = PreludeSDK::Models::NotifySendBatchParams
 
   class NotifySendParams = PreludeSDK::Models::NotifySendParams
 
+  class Signals = PreludeSDK::Models::Signals
+
+  class Target = PreludeSDK::Models::Target
+
   class TransactionalSendParams = PreludeSDK::Models::TransactionalSendParams
 
+  module Verification = PreludeSDK::Models::Verification
+
   class VerificationCheckParams = PreludeSDK::Models::VerificationCheckParams
 
   class VerificationCreateParams = PreludeSDK::Models::VerificationCreateParams
 
+  module VerificationManagement = PreludeSDK::Models::VerificationManagement
+
   class VerificationManagementDeletePhoneNumberParams = PreludeSDK::Models::VerificationManagementDeletePhoneNumberParams
 
   class VerificationManagementListPhoneNumbersParams = PreludeSDK::Models::VerificationManagementListPhoneNumbersParams
@@ -31,6 +43,8 @@ module PreludeSDK
 
   class VerificationManagementSubmitSenderIDParams = PreludeSDK::Models::VerificationManagementSubmitSenderIDParams
 
+  class WatchEvaluateParams = PreludeSDK::Models::WatchEvaluateParams
+
   class WatchPredictParams = PreludeSDK::Models::WatchPredictParams
 
   class WatchSendEventsParams = PreludeSDK::Models::WatchSendEventsParams

data/sig/prelude_sdk/resources/intel/kyc.rbs

@@ -0,0 +1,23 @@
+module PreludeSDK
+  module Resources
+    class Intel
+      class KYC
+        def match: (
+          String phone,
+          ?address: String,
+          ?birthdate: Date,
+          ?country: String,
+          ?email: String,
+          ?family_name: String,
+          ?given_name: String,
+          ?locality: String,
+          ?postal_code: String,
+          ?region: String,
+          ?request_options: PreludeSDK::request_opts
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse
+
+        def initialize: (client: PreludeSDK::Client) -> void
+      end
+    end
+  end
+end

data/sig/prelude_sdk/resources/intel.rbs

@@ -0,0 +1,9 @@
+module PreludeSDK
+  module Resources
+    class Intel
+      attr_reader kyc: PreludeSDK::Resources::Intel::KYC
+
+      def initialize: (client: PreludeSDK::Client) -> void
+    end
+  end
+end

data/sig/prelude_sdk/resources/notify.rbs

@@ -34,6 +34,15 @@ module PreludeSDK
         ?request_options: PreludeSDK::request_opts
       ) -> PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse
 
+      def reply: (
+        reply_to: String,
+        text: String,
+        to: String,
+        ?callback_url: String,
+        ?correlation_id: String,
+        ?request_options: PreludeSDK::request_opts
+      ) -> PreludeSDK::Models::NotifyReplyResponse
+
       def send_: (
         template_id: String,
         to: String,

data/sig/prelude_sdk/resources/verification/phone/history.rbs

@@ -0,0 +1,32 @@
+module PreludeSDK
+  module Resources
+    class Verification
+      class Phone
+        class History
+          def retrieve: (
+            String id,
+            ?request_options: PreludeSDK::request_opts
+          ) -> PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse
+
+          def list: (
+            ?channels: ::Array[PreludeSDK::Models::Verification::Phone::HistoryListParams::channel],
+            ?cursor: String,
+            ?device_platform: PreludeSDK::Models::Verification::Phone::HistoryListParams::device_platform,
+            ?from: Time,
+            ?limit: Integer,
+            ?max_attempts: Integer,
+            ?min_attempts: Integer,
+            ?phone_number: String,
+            ?region: String,
+            ?status: PreludeSDK::Models::Verification::Phone::HistoryListParams::status,
+            ?template_id: String,
+            ?to: Time,
+            ?request_options: PreludeSDK::request_opts
+          ) -> PreludeSDK::Models::Verification::Phone::HistoryListResponse
+
+          def initialize: (client: PreludeSDK::Client) -> void
+        end
+      end
+    end
+  end
+end

data/sig/prelude_sdk/resources/verification/phone.rbs

@@ -0,0 +1,11 @@
+module PreludeSDK
+  module Resources
+    class Verification
+      class Phone
+        attr_reader history: PreludeSDK::Resources::Verification::Phone::History
+
+        def initialize: (client: PreludeSDK::Client) -> void
+      end
+    end
+  end
+end

data/sig/prelude_sdk/resources/verification.rbs

@@ -1,18 +1,20 @@
 module PreludeSDK
   module Resources
     class Verification
+      attr_reader phone: PreludeSDK::Resources::Verification::Phone
+
       def create: (
-        target: PreludeSDK::VerificationCreateParams::Target,
+        target: PreludeSDK::Target,
         ?dispatch_id: String,
         ?metadata: PreludeSDK::VerificationCreateParams::Metadata,
         ?options: PreludeSDK::VerificationCreateParams::Options,
-        ?signals: PreludeSDK::VerificationCreateParams::Signals,
+        ?signals: PreludeSDK::Signals,
         ?request_options: PreludeSDK::request_opts
       ) -> PreludeSDK::Models::VerificationCreateResponse
 
       def check: (
         code: String,
-        target: PreludeSDK::VerificationCheckParams::Target,
+        target: PreludeSDK::Target,
         ?psd2: PreludeSDK::VerificationCheckParams::Psd2,
         ?request_options: PreludeSDK::request_opts
       ) -> PreludeSDK::Models::VerificationCheckResponse