prelude-sdk 0.6.0 → 0.8.0

data/sig/prelude_sdk/models/intel/kyc_match_response.rbs

@@ -0,0 +1,276 @@
+module PreludeSDK
+  module Models
+    module Intel
+      type kyc_match_response =
+        {
+          address_match: PreludeSDK::Models::Intel::KYCMatchResponse::address_match,
+          address_match_score: Integer,
+          birthdate_match: PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match,
+          country_code: String,
+          country_match: PreludeSDK::Models::Intel::KYCMatchResponse::country_match,
+          email_match: PreludeSDK::Models::Intel::KYCMatchResponse::email_match,
+          email_match_score: Integer,
+          family_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match,
+          family_name_match_score: Integer,
+          given_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match,
+          given_name_match_score: Integer,
+          locality_match: PreludeSDK::Models::Intel::KYCMatchResponse::locality_match,
+          locality_match_score: Integer,
+          operator: String,
+          phone_number: String,
+          postal_code_match: PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match,
+          region_match: PreludeSDK::Models::Intel::KYCMatchResponse::region_match,
+          region_match_score: Integer,
+          request_id: String
+        }
+
+      class KYCMatchResponse < PreludeSDK::Internal::Type::BaseModel
+        attr_reader address_match: PreludeSDK::Models::Intel::KYCMatchResponse::address_match?
+
+        def address_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::address_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::address_match
+
+        attr_reader address_match_score: Integer?
+
+        def address_match_score=: (Integer) -> Integer
+
+        attr_reader birthdate_match: PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match?
+
+        def birthdate_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match
+
+        attr_reader country_code: String?
+
+        def country_code=: (String) -> String
+
+        attr_reader country_match: PreludeSDK::Models::Intel::KYCMatchResponse::country_match?
+
+        def country_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::country_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::country_match
+
+        attr_reader email_match: PreludeSDK::Models::Intel::KYCMatchResponse::email_match?
+
+        def email_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::email_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::email_match
+
+        attr_reader email_match_score: Integer?
+
+        def email_match_score=: (Integer) -> Integer
+
+        attr_reader family_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match?
+
+        def family_name_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match
+
+        attr_reader family_name_match_score: Integer?
+
+        def family_name_match_score=: (Integer) -> Integer
+
+        attr_reader given_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match?
+
+        def given_name_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match
+
+        attr_reader given_name_match_score: Integer?
+
+        def given_name_match_score=: (Integer) -> Integer
+
+        attr_reader locality_match: PreludeSDK::Models::Intel::KYCMatchResponse::locality_match?
+
+        def locality_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::locality_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::locality_match
+
+        attr_reader locality_match_score: Integer?
+
+        def locality_match_score=: (Integer) -> Integer
+
+        attr_reader operator: String?
+
+        def operator=: (String) -> String
+
+        attr_reader phone_number: String?
+
+        def phone_number=: (String) -> String
+
+        attr_reader postal_code_match: PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match?
+
+        def postal_code_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match
+
+        attr_reader region_match: PreludeSDK::Models::Intel::KYCMatchResponse::region_match?
+
+        def region_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::region_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::region_match
+
+        attr_reader region_match_score: Integer?
+
+        def region_match_score=: (Integer) -> Integer
+
+        attr_reader request_id: String?
+
+        def request_id=: (String) -> String
+
+        def initialize: (
+          ?address_match: PreludeSDK::Models::Intel::KYCMatchResponse::address_match,
+          ?address_match_score: Integer,
+          ?birthdate_match: PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match,
+          ?country_code: String,
+          ?country_match: PreludeSDK::Models::Intel::KYCMatchResponse::country_match,
+          ?email_match: PreludeSDK::Models::Intel::KYCMatchResponse::email_match,
+          ?email_match_score: Integer,
+          ?family_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match,
+          ?family_name_match_score: Integer,
+          ?given_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match,
+          ?given_name_match_score: Integer,
+          ?locality_match: PreludeSDK::Models::Intel::KYCMatchResponse::locality_match,
+          ?locality_match_score: Integer,
+          ?operator: String,
+          ?phone_number: String,
+          ?postal_code_match: PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match,
+          ?region_match: PreludeSDK::Models::Intel::KYCMatchResponse::region_match,
+          ?region_match_score: Integer,
+          ?request_id: String
+        ) -> void
+
+        def to_hash: -> {
+          address_match: PreludeSDK::Models::Intel::KYCMatchResponse::address_match,
+          address_match_score: Integer,
+          birthdate_match: PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match,
+          country_code: String,
+          country_match: PreludeSDK::Models::Intel::KYCMatchResponse::country_match,
+          email_match: PreludeSDK::Models::Intel::KYCMatchResponse::email_match,
+          email_match_score: Integer,
+          family_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match,
+          family_name_match_score: Integer,
+          given_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match,
+          given_name_match_score: Integer,
+          locality_match: PreludeSDK::Models::Intel::KYCMatchResponse::locality_match,
+          locality_match_score: Integer,
+          operator: String,
+          phone_number: String,
+          postal_code_match: PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match,
+          region_match: PreludeSDK::Models::Intel::KYCMatchResponse::region_match,
+          region_match_score: Integer,
+          request_id: String
+        }
+
+        type address_match = :true | :false | :not_available
+
+        module AddressMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::address_match]
+        end
+
+        type birthdate_match = :true | :false | :not_available
+
+        module BirthdateMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match]
+        end
+
+        type country_match = :true | :false | :not_available
+
+        module CountryMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::country_match]
+        end
+
+        type email_match = :true | :false | :not_available
+
+        module EmailMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::email_match]
+        end
+
+        type family_name_match = :true | :false | :not_available
+
+        module FamilyNameMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match]
+        end
+
+        type given_name_match = :true | :false | :not_available
+
+        module GivenNameMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match]
+        end
+
+        type locality_match = :true | :false | :not_available
+
+        module LocalityMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::locality_match]
+        end
+
+        type postal_code_match = :true | :false | :not_available
+
+        module PostalCodeMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match]
+        end
+
+        type region_match = :true | :false | :not_available
+
+        module RegionMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::region_match]
+        end
+      end
+    end
+  end
+end

data/sig/prelude_sdk/models/notify_reply_params.rbs

@@ -0,0 +1,50 @@
+module PreludeSDK
+  module Models
+    type notify_reply_params =
+      {
+        reply_to: String,
+        text: String,
+        to: String,
+        callback_url: String,
+        correlation_id: String
+      }
+      & PreludeSDK::Internal::Type::request_parameters
+
+    class NotifyReplyParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      attr_accessor reply_to: String
+
+      attr_accessor text: String
+
+      attr_accessor to: String
+
+      attr_reader callback_url: String?
+
+      def callback_url=: (String) -> String
+
+      attr_reader correlation_id: String?
+
+      def correlation_id=: (String) -> String
+
+      def initialize: (
+        reply_to: String,
+        text: String,
+        to: String,
+        ?callback_url: String,
+        ?correlation_id: String,
+        ?request_options: PreludeSDK::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        reply_to: String,
+        text: String,
+        to: String,
+        callback_url: String,
+        correlation_id: String,
+        request_options: PreludeSDK::RequestOptions
+      }
+    end
+  end
+end

data/sig/prelude_sdk/models/notify_reply_response.rbs

@@ -0,0 +1,54 @@
+module PreludeSDK
+  module Models
+    type notify_reply_response =
+      {
+        id: String,
+        created_at: Time,
+        reply_to: String,
+        text: String,
+        to: String,
+        callback_url: String,
+        correlation_id: String
+      }
+
+    class NotifyReplyResponse < PreludeSDK::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor reply_to: String
+
+      attr_accessor text: String
+
+      attr_accessor to: String
+
+      attr_reader callback_url: String?
+
+      def callback_url=: (String) -> String
+
+      attr_reader correlation_id: String?
+
+      def correlation_id=: (String) -> String
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        reply_to: String,
+        text: String,
+        to: String,
+        ?callback_url: String,
+        ?correlation_id: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        reply_to: String,
+        text: String,
+        to: String,
+        callback_url: String,
+        correlation_id: String
+      }
+    end
+  end
+end

data/sig/prelude_sdk/models/signals.rbs

@@ -0,0 +1,101 @@
+module PreludeSDK
+  module Models
+    type signals =
+      {
+        app_version: String,
+        device_id: String,
+        device_model: String,
+        device_platform: PreludeSDK::Models::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::Signals::device_platform?
+
+      def device_platform=: (
+        PreludeSDK::Models::Signals::device_platform
+      ) -> PreludeSDK::Models::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::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::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::Signals::device_platform]
+      end
+    end
+  end
+end

data/sig/prelude_sdk/models/target.rbs

@@ -0,0 +1,29 @@
+module PreludeSDK
+  module Models
+    type target = { type: PreludeSDK::Models::Target::type_, value: String }
+
+    class Target < PreludeSDK::Internal::Type::BaseModel
+      attr_accessor type: PreludeSDK::Models::Target::type_
+
+      attr_accessor value: String
+
+      def initialize: (
+        type: PreludeSDK::Models::Target::type_,
+        value: String
+      ) -> void
+
+      def to_hash: -> { type: PreludeSDK::Models::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::Target::type_]
+      end
+    end
+  end
+end

data/sig/prelude_sdk/models/verification/phone/history_list_params.rbs

@@ -0,0 +1,187 @@
+module PreludeSDK
+  module Models
+    module Verification
+      module Phone
+        type history_list_params =
+          {
+            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
+          }
+          & PreludeSDK::Internal::Type::request_parameters
+
+        class HistoryListParams < PreludeSDK::Internal::Type::BaseModel
+          extend PreludeSDK::Internal::Type::RequestParameters::Converter
+          include PreludeSDK::Internal::Type::RequestParameters
+
+          attr_reader channels: ::Array[PreludeSDK::Models::Verification::Phone::HistoryListParams::channel]?
+
+          def channels=: (
+            ::Array[PreludeSDK::Models::Verification::Phone::HistoryListParams::channel]
+          ) -> ::Array[PreludeSDK::Models::Verification::Phone::HistoryListParams::channel]
+
+          attr_reader cursor: String?
+
+          def cursor=: (String) -> String
+
+          attr_reader device_platform: PreludeSDK::Models::Verification::Phone::HistoryListParams::device_platform?
+
+          def device_platform=: (
+            PreludeSDK::Models::Verification::Phone::HistoryListParams::device_platform
+          ) -> PreludeSDK::Models::Verification::Phone::HistoryListParams::device_platform
+
+          attr_reader from: Time?
+
+          def from=: (Time) -> Time
+
+          attr_reader limit: Integer?
+
+          def limit=: (Integer) -> Integer
+
+          attr_reader max_attempts: Integer?
+
+          def max_attempts=: (Integer) -> Integer
+
+          attr_reader min_attempts: Integer?
+
+          def min_attempts=: (Integer) -> Integer
+
+          attr_reader phone_number: String?
+
+          def phone_number=: (String) -> String
+
+          attr_reader region: String?
+
+          def region=: (String) -> String
+
+          attr_reader status: PreludeSDK::Models::Verification::Phone::HistoryListParams::status?
+
+          def status=: (
+            PreludeSDK::Models::Verification::Phone::HistoryListParams::status
+          ) -> PreludeSDK::Models::Verification::Phone::HistoryListParams::status
+
+          attr_reader template_id: String?
+
+          def template_id=: (String) -> String
+
+          attr_reader to: Time?
+
+          def to=: (Time) -> Time
+
+          def initialize: (
+            ?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
+          ) -> void
+
+          def to_hash: -> {
+            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::RequestOptions
+          }
+
+          type channel =
+            :sms
+            | :rcs
+            | :whatsapp
+            | :viber
+            | :zalo
+            | :telegram
+            | :voice
+            | :silent
+
+          module Channel
+            extend PreludeSDK::Internal::Type::Enum
+
+            SMS: :sms
+            RCS: :rcs
+            WHATSAPP: :whatsapp
+            VIBER: :viber
+            ZALO: :zalo
+            TELEGRAM: :telegram
+            VOICE: :voice
+            SILENT: :silent
+
+            def self?.values: -> ::Array[PreludeSDK::Models::Verification::Phone::HistoryListParams::channel]
+          end
+
+          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::Verification::Phone::HistoryListParams::device_platform]
+          end
+
+          type status =
+            :converted
+            | :not_converted
+            | :pending_check
+            | :sent
+            | :challenged
+            | :suspected_fraud
+            | :in_blocklist
+            | :invalid_line
+            | :invalid_number
+            | :rate_limited
+            | :expired_signals
+            | :shadowed
+
+          module Status
+            extend PreludeSDK::Internal::Type::Enum
+
+            CONVERTED: :converted
+            NOT_CONVERTED: :not_converted
+            PENDING_CHECK: :pending_check
+            SENT: :sent
+            CHALLENGED: :challenged
+            SUSPECTED_FRAUD: :suspected_fraud
+            IN_BLOCKLIST: :in_blocklist
+            INVALID_LINE: :invalid_line
+            INVALID_NUMBER: :invalid_number
+            RATE_LIMITED: :rate_limited
+            EXPIRED_SIGNALS: :expired_signals
+            SHADOWED: :shadowed
+
+            def self?.values: -> ::Array[PreludeSDK::Models::Verification::Phone::HistoryListParams::status]
+          end
+        end
+      end
+    end
+  end
+end