prelude-sdk 0.6.0 → 0.8.0

data/rbi/prelude_sdk/models/verification_management/sandbox_add_phone_number_response.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      class SandboxAddPhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::VerificationManagement::SandboxAddPhoneNumberResponse,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The fixed attempt code associated with the sandbox phone number.
+        sig { returns(String) }
+        attr_accessor :attempt_code
+
+        # The E.164 formatted phone number that was added to the sandbox list.
+        sig { returns(String) }
+        attr_accessor :phone_number
+
+        sig do
+          params(attempt_code: String, phone_number: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The fixed attempt code associated with the sandbox phone number.
+          attempt_code:,
+          # The E.164 formatted phone number that was added to the sandbox list.
+          phone_number:
+        )
+        end
+
+        sig { override.returns({ attempt_code: String, phone_number: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management/sandbox_delete_phone_number_params.rbi

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

data/rbi/prelude_sdk/models/verification_management/sandbox_delete_phone_number_response.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      class SandboxDeletePhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::VerificationManagement::SandboxDeletePhoneNumberResponse,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The E.164 formatted phone number that was removed from the sandbox list.
+        sig { returns(String) }
+        attr_accessor :phone_number
+
+        sig { params(phone_number: String).returns(T.attached_class) }
+        def self.new(
+          # The E.164 formatted phone number that was removed from the sandbox list.
+          phone_number:
+        )
+        end
+
+        sig { override.returns({ phone_number: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_params.rbi

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

data/rbi/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_response.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      class SandboxListPhoneNumbersResponse < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # A list of sandbox phone numbers.
+        sig do
+          returns(
+            T::Array[
+              PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse::PhoneNumber
+            ]
+          )
+        end
+        attr_accessor :phone_numbers
+
+        sig do
+          params(
+            phone_numbers:
+              T::Array[
+                PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse::PhoneNumber::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A list of sandbox phone numbers.
+          phone_numbers:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              phone_numbers:
+                T::Array[
+                  PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse::PhoneNumber
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class PhoneNumber < PreludeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse::PhoneNumber,
+                PreludeSDK::Internal::AnyHash
+              )
+            end
+
+          # The fixed attempt code associated with the sandbox phone number.
+          sig { returns(String) }
+          attr_accessor :attempt_code
+
+          # The date and time when the phone number was added to the sandbox list.
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # An E.164 formatted phone number.
+          sig { returns(String) }
+          attr_accessor :phone_number
+
+          sig do
+            params(
+              attempt_code: String,
+              created_at: Time,
+              phone_number: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The fixed attempt code associated with the sandbox phone number.
+            attempt_code:,
+            # The date and time when the phone number was added to the sandbox list.
+            created_at:,
+            # An E.164 formatted phone number.
+            phone_number:
+          )
+          end
+
+          sig do
+            override.returns(
+              { attempt_code: String, created_at: Time, phone_number: String }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/watch_evaluate_params.rbi

@@ -0,0 +1,109 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class WatchEvaluateParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(PreludeSDK::WatchEvaluateParams, PreludeSDK::Internal::AnyHash)
+        end
+
+      # The flow to evaluate. A flow names the moment you are guarding and selects the
+      # recipes that run.
+      sig { returns(String) }
+      attr_accessor :flow_id
+
+      # The identifier to score — a phone number or email address.
+      sig { returns(PreludeSDK::Target) }
+      attr_reader :target
+
+      sig { params(target: PreludeSDK::Target::OrHash).void }
+      attr_writer :target
+
+      # Values for the attributes the flow's recipes declare, keyed without the `attr.`
+      # namespace a rule uses to reference them.
+      #
+      # An attribute a recipe declares and this request omits is treated as missing
+      # evidence, not as an empty value: the rules reading it report `NOT_EVALUATED`
+      # rather than being scored as though the condition were false. A key no recipe in
+      # the flow declares is ignored rather than rejected, so one payload can serve
+      # flows that read different attributes.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :attributes
+
+      sig { params(attributes: T::Hash[Symbol, String]).void }
+      attr_writer :attributes
+
+      # The identifier of the dispatch that came from the front-end SDK. Signals it
+      # carries fill in anything the request did not state; the request wins where both
+      # supply a value.
+      sig { returns(T.nilable(String)) }
+      attr_reader :dispatch_id
+
+      sig { params(dispatch_id: String).void }
+      attr_writer :dispatch_id
+
+      # The signals used for anti-fraud. For more details, refer to
+      # [Signals](/verify/v2/documentation/prevent-fraud#signals).
+      sig { returns(T.nilable(PreludeSDK::Signals)) }
+      attr_reader :signals
+
+      sig { params(signals: PreludeSDK::Signals::OrHash).void }
+      attr_writer :signals
+
+      sig do
+        params(
+          flow_id: String,
+          target: PreludeSDK::Target::OrHash,
+          attributes: T::Hash[Symbol, String],
+          dispatch_id: String,
+          signals: PreludeSDK::Signals::OrHash,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The flow to evaluate. A flow names the moment you are guarding and selects the
+        # recipes that run.
+        flow_id:,
+        # The identifier to score — a phone number or email address.
+        target:,
+        # Values for the attributes the flow's recipes declare, keyed without the `attr.`
+        # namespace a rule uses to reference them.
+        #
+        # An attribute a recipe declares and this request omits is treated as missing
+        # evidence, not as an empty value: the rules reading it report `NOT_EVALUATED`
+        # rather than being scored as though the condition were false. A key no recipe in
+        # the flow declares is ignored rather than rejected, so one payload can serve
+        # flows that read different attributes.
+        attributes: nil,
+        # The identifier of the dispatch that came from the front-end SDK. Signals it
+        # carries fill in anything the request did not state; the request wins where both
+        # supply a value.
+        dispatch_id: nil,
+        # The signals used for anti-fraud. For more details, refer to
+        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
+        signals: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            flow_id: String,
+            target: PreludeSDK::Target,
+            attributes: T::Hash[Symbol, String],
+            dispatch_id: String,
+            signals: PreludeSDK::Signals,
+            request_options: PreludeSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end