prelude-sdk 0.1.0.pre.alpha.2

data/lib/prelude_sdk/models/verification_create_params.rb

@@ -0,0 +1,388 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Verification#create
+    class VerificationCreateParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute target
+      #   The verification target. Either a phone number or an email address. To use the
+      #   email verification feature contact us to discuss your use case.
+      #
+      #   @return [PreludeSDK::Models::VerificationCreateParams::Target]
+      required :target, -> { PreludeSDK::VerificationCreateParams::Target }
+
+      # @!attribute dispatch_id
+      #   The identifier of the dispatch that came from the front-end SDK.
+      #
+      #   @return [String, nil]
+      optional :dispatch_id, String
+
+      # @!attribute metadata
+      #   The metadata for this verification. This object will be returned with every
+      #   response or webhook sent that refers to this verification.
+      #
+      #   @return [PreludeSDK::Models::VerificationCreateParams::Metadata, nil]
+      optional :metadata, -> { PreludeSDK::VerificationCreateParams::Metadata }
+
+      # @!attribute options
+      #   Verification options
+      #
+      #   @return [PreludeSDK::Models::VerificationCreateParams::Options, nil]
+      optional :options, -> { PreludeSDK::VerificationCreateParams::Options }
+
+      # @!attribute signals
+      #   The signals used for anti-fraud. For more details, refer to
+      #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
+      #
+      #   @return [PreludeSDK::Models::VerificationCreateParams::Signals, nil]
+      optional :signals, -> { PreludeSDK::VerificationCreateParams::Signals }
+
+      # @!method initialize(target:, dispatch_id: nil, metadata: nil, options: nil, signals: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::VerificationCreateParams} for more details.
+      #
+      #   @param target [PreludeSDK::Models::VerificationCreateParams::Target] The verification target. Either a phone number or an email address. To use the e
+      #
+      #   @param dispatch_id [String] The identifier of the dispatch that came from the front-end SDK.
+      #
+      #   @param metadata [PreludeSDK::Models::VerificationCreateParams::Metadata] The metadata for this verification. This object will be returned with every resp
+      #
+      #   @param options [PreludeSDK::Models::VerificationCreateParams::Options] Verification options
+      #
+      #   @param signals [PreludeSDK::Models::VerificationCreateParams::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      class Target < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the target. Either "phone_number" or "email_address".
+        #
+        #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Target::Type]
+        required :type, enum: -> { PreludeSDK::VerificationCreateParams::Target::Type }
+
+        # @!attribute value
+        #   An E.164 formatted phone number or an email address.
+        #
+        #   @return [String]
+        required :value, String
+
+        # @!method initialize(type:, value:)
+        #   The verification target. Either a phone number or an email address. To use the
+        #   email verification feature contact us to discuss your use case.
+        #
+        #   @param type [Symbol, PreludeSDK::Models::VerificationCreateParams::Target::Type] The type of the target. Either "phone_number" or "email_address".
+        #
+        #   @param value [String] An E.164 formatted phone number or an email address.
+
+        # The type of the target. Either "phone_number" or "email_address".
+        #
+        # @see PreludeSDK::Models::VerificationCreateParams::Target#type
+        module Type
+          extend PreludeSDK::Internal::Type::Enum
+
+          PHONE_NUMBER = :phone_number
+          EMAIL_ADDRESS = :email_address
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class Metadata < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute correlation_id
+        #   A user-defined identifier to correlate this verification with.
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!method initialize(correlation_id: nil)
+        #   The metadata for this verification. This object will be returned with every
+        #   response or webhook sent that refers to this verification.
+        #
+        #   @param correlation_id [String] A user-defined identifier to correlate this verification with.
+      end
+
+      class Options < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute app_realm
+        #   This allows you to automatically retrieve and fill the OTP code on mobile apps.
+        #   Currently only Android devices are supported.
+        #
+        #   @return [PreludeSDK::Models::VerificationCreateParams::Options::AppRealm, nil]
+        optional :app_realm, -> { PreludeSDK::VerificationCreateParams::Options::AppRealm }
+
+        # @!attribute callback_url
+        #   The URL where webhooks will be sent when verification events occur, including
+        #   verification creation, attempt creation, and delivery status changes. For more
+        #   details, refer to [Webhook](/verify/v2/documentation/webhook).
+        #
+        #   @return [String, nil]
+        optional :callback_url, String
+
+        # @!attribute code_size
+        #   The size of the code generated. It should be between 4 and 8. Defaults to the
+        #   code size specified from the Dashboard.
+        #
+        #   @return [Integer, nil]
+        optional :code_size, Integer
+
+        # @!attribute custom_code
+        #   The custom code to use for OTP verification. To use the custom code feature,
+        #   contact us to enable it for your account. For more details, refer to
+        #   [Custom Code](/verify/v2/documentation/custom-codes).
+        #
+        #   @return [String, nil]
+        optional :custom_code, String
+
+        # @!attribute locale
+        #   A BCP-47 formatted locale string with the language the text message will be sent
+        #   to. If there's no locale set, the language will be determined by the country
+        #   code of the phone number. If the language specified doesn't exist, it defaults
+        #   to US English.
+        #
+        #   @return [String, nil]
+        optional :locale, String
+
+        # @!attribute method_
+        #   The method used for verifying this phone number. The 'voice' option provides an
+        #   accessible alternative for visually impaired users by delivering the
+        #   verification code through a phone call rather than a text message. It also
+        #   allows verification of landline numbers that cannot receive SMS messages.
+        #
+        #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Method, nil]
+        optional :method_,
+                 enum: -> {
+                   PreludeSDK::VerificationCreateParams::Options::Method
+                 },
+                 api_name: :method
+
+        # @!attribute preferred_channel
+        #   The preferred channel to be used in priority for verification.
+        #
+        #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::PreferredChannel, nil]
+        optional :preferred_channel,
+                 enum: -> {
+                   PreludeSDK::VerificationCreateParams::Options::PreferredChannel
+                 }
+
+        # @!attribute sender_id
+        #   The Sender ID to use for this message. The Sender ID needs to be enabled by
+        #   Prelude.
+        #
+        #   @return [String, nil]
+        optional :sender_id, String
+
+        # @!attribute template_id
+        #   The identifier of a verification template. It applies use case-specific
+        #   settings, such as the message content or certain verification parameters.
+        #
+        #   @return [String, nil]
+        optional :template_id, String
+
+        # @!attribute variables
+        #   The variables to be replaced in the template.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :variables, PreludeSDK::Internal::Type::HashOf[String]
+
+        # @!method initialize(app_realm: nil, callback_url: nil, code_size: nil, custom_code: nil, locale: nil, method_: nil, preferred_channel: nil, sender_id: nil, template_id: nil, variables: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::VerificationCreateParams::Options} for more details.
+        #
+        #   Verification options
+        #
+        #   @param app_realm [PreludeSDK::Models::VerificationCreateParams::Options::AppRealm] This allows you to automatically retrieve and fill the OTP code on mobile apps.
+        #
+        #   @param callback_url [String] The URL where webhooks will be sent when verification events occur, including ve
+        #
+        #   @param code_size [Integer] The size of the code generated. It should be between 4 and 8. Defaults to the co
+        #
+        #   @param custom_code [String] The custom code to use for OTP verification. To use the custom code feature, con
+        #
+        #   @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
+        #
+        #   @param method_ [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Method] The method used for verifying this phone number. The 'voice' option provides an
+        #
+        #   @param preferred_channel [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::PreferredChannel] The preferred channel to be used in priority for verification.
+        #
+        #   @param sender_id [String] The Sender ID to use for this message. The Sender ID needs to be enabled by Prel
+        #
+        #   @param template_id [String] The identifier of a verification template. It applies use case-specific settings
+        #
+        #   @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
+
+        # @see PreludeSDK::Models::VerificationCreateParams::Options#app_realm
+        class AppRealm < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute platform
+          #   The platform the SMS will be sent to. We are currently only supporting
+          #   "android".
+          #
+          #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::AppRealm::Platform]
+          required :platform, enum: -> { PreludeSDK::VerificationCreateParams::Options::AppRealm::Platform }
+
+          # @!attribute value
+          #   The Android SMS Retriever API hash code that identifies your app.
+          #
+          #   @return [String]
+          required :value, String
+
+          # @!method initialize(platform:, value:)
+          #   Some parameter documentations has been truncated, see
+          #   {PreludeSDK::Models::VerificationCreateParams::Options::AppRealm} for more
+          #   details.
+          #
+          #   This allows you to automatically retrieve and fill the OTP code on mobile apps.
+          #   Currently only Android devices are supported.
+          #
+          #   @param platform [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::AppRealm::Platform] The platform the SMS will be sent to. We are currently only supporting "android"
+          #
+          #   @param value [String] The Android SMS Retriever API hash code that identifies your app.
+
+          # The platform the SMS will be sent to. We are currently only supporting
+          # "android".
+          #
+          # @see PreludeSDK::Models::VerificationCreateParams::Options::AppRealm#platform
+          module Platform
+            extend PreludeSDK::Internal::Type::Enum
+
+            ANDROID = :android
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The method used for verifying this phone number. The 'voice' option provides an
+        # accessible alternative for visually impaired users by delivering the
+        # verification code through a phone call rather than a text message. It also
+        # allows verification of landline numbers that cannot receive SMS messages.
+        #
+        # @see PreludeSDK::Models::VerificationCreateParams::Options#method_
+        module Method
+          extend PreludeSDK::Internal::Type::Enum
+
+          AUTO = :auto
+          VOICE = :voice
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The preferred channel to be used in priority for verification.
+        #
+        # @see PreludeSDK::Models::VerificationCreateParams::Options#preferred_channel
+        module PreferredChannel
+          extend PreludeSDK::Internal::Type::Enum
+
+          SMS = :sms
+          RCS = :rcs
+          WHATSAPP = :whatsapp
+          VIBER = :viber
+          ZALO = :zalo
+          TELEGRAM = :telegram
+          SILENT = :silent
+          VOICE = :voice
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class Signals < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute app_version
+        #   The version of your application.
+        #
+        #   @return [String, nil]
+        optional :app_version, String
+
+        # @!attribute device_id
+        #   The unique identifier for the user's device. For Android, this corresponds to
+        #   the `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
+        #
+        #   @return [String, nil]
+        optional :device_id, String
+
+        # @!attribute device_model
+        #   The model of the user's device.
+        #
+        #   @return [String, nil]
+        optional :device_model, String
+
+        # @!attribute device_platform
+        #   The type of the user's device.
+        #
+        #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Signals::DevicePlatform, nil]
+        optional :device_platform, enum: -> { PreludeSDK::VerificationCreateParams::Signals::DevicePlatform }
+
+        # @!attribute ip
+        #   The IP address of the user's device.
+        #
+        #   @return [String, nil]
+        optional :ip, String
+
+        # @!attribute is_trusted_user
+        #   This signal should provide a higher level of trust, indicating that the user is
+        #   genuine. Contact us to discuss your use case. For more details, refer to
+        #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
+        #
+        #   @return [Boolean, nil]
+        optional :is_trusted_user, PreludeSDK::Internal::Type::Boolean
+
+        # @!attribute os_version
+        #   The version of the user's device operating system.
+        #
+        #   @return [String, nil]
+        optional :os_version, String
+
+        # @!attribute user_agent
+        #   The user agent of the user's device. If the individual fields (os_version,
+        #   device_platform, device_model) are provided, we will prioritize those values
+        #   instead of parsing them from the user agent string.
+        #
+        #   @return [String, nil]
+        optional :user_agent, String
+
+        # @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, ip: nil, is_trusted_user: nil, os_version: nil, user_agent: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::VerificationCreateParams::Signals} for more details.
+        #
+        #   The signals used for anti-fraud. For more details, refer to
+        #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
+        #
+        #   @param app_version [String] The version of your application.
+        #
+        #   @param device_id [String] The unique identifier for the user's device. For Android, this corresponds to th
+        #
+        #   @param device_model [String] The model of the user's device.
+        #
+        #   @param device_platform [Symbol, PreludeSDK::Models::VerificationCreateParams::Signals::DevicePlatform] The type of the user's device.
+        #
+        #   @param ip [String] The IP address of the user's device.
+        #
+        #   @param is_trusted_user [Boolean] This signal should provide a higher level of trust, indicating that the user is
+        #
+        #   @param os_version [String] The version of the user's device operating system.
+        #
+        #   @param user_agent [String] The user agent of the user's device. If the individual fields (os_version, devic
+
+        # The type of the user's device.
+        #
+        # @see PreludeSDK::Models::VerificationCreateParams::Signals#device_platform
+        module DevicePlatform
+          extend PreludeSDK::Internal::Type::Enum
+
+          ANDROID = :android
+          IOS = :ios
+          IPADOS = :ipados
+          TVOS = :tvos
+          WEB = :web
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/verification_create_response.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Verification#create
+    class VerificationCreateResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The verification identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute method_
+      #   The method used for verifying this phone number.
+      #
+      #   @return [Symbol, PreludeSDK::Models::VerificationCreateResponse::Method]
+      required :method_, enum: -> { PreludeSDK::Models::VerificationCreateResponse::Method }, api_name: :method
+
+      # @!attribute status
+      #   The status of the verification.
+      #
+      #   @return [Symbol, PreludeSDK::Models::VerificationCreateResponse::Status]
+      required :status, enum: -> { PreludeSDK::Models::VerificationCreateResponse::Status }
+
+      # @!attribute channels
+      #   The ordered sequence of channels to be used for verification
+      #
+      #   @return [Array<String>, nil]
+      optional :channels, PreludeSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute metadata
+      #   The metadata for this verification.
+      #
+      #   @return [PreludeSDK::Models::VerificationCreateResponse::Metadata, nil]
+      optional :metadata, -> { PreludeSDK::Models::VerificationCreateResponse::Metadata }
+
+      # @!attribute reason
+      #   The reason why the verification was blocked. Only present when status is
+      #   "blocked".
+      #
+      #   @return [Symbol, PreludeSDK::Models::VerificationCreateResponse::Reason, nil]
+      optional :reason, enum: -> { PreludeSDK::Models::VerificationCreateResponse::Reason }
+
+      # @!attribute request_id
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute silent
+      #   The silent verification specific properties.
+      #
+      #   @return [PreludeSDK::Models::VerificationCreateResponse::Silent, nil]
+      optional :silent, -> { PreludeSDK::Models::VerificationCreateResponse::Silent }
+
+      # @!method initialize(id:, method_:, status:, channels: nil, metadata: nil, reason: nil, request_id: nil, silent: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::VerificationCreateResponse} for more details.
+      #
+      #   @param id [String] The verification identifier.
+      #
+      #   @param method_ [Symbol, PreludeSDK::Models::VerificationCreateResponse::Method] The method used for verifying this phone number.
+      #
+      #   @param status [Symbol, PreludeSDK::Models::VerificationCreateResponse::Status] The status of the verification.
+      #
+      #   @param channels [Array<String>] The ordered sequence of channels to be used for verification
+      #
+      #   @param metadata [PreludeSDK::Models::VerificationCreateResponse::Metadata] The metadata for this verification.
+      #
+      #   @param reason [Symbol, PreludeSDK::Models::VerificationCreateResponse::Reason] The reason why the verification was blocked. Only present when status is "blocke
+      #
+      #   @param request_id [String]
+      #
+      #   @param silent [PreludeSDK::Models::VerificationCreateResponse::Silent] The silent verification specific properties.
+
+      # The method used for verifying this phone number.
+      #
+      # @see PreludeSDK::Models::VerificationCreateResponse#method_
+      module Method
+        extend PreludeSDK::Internal::Type::Enum
+
+        MESSAGE = :message
+        SILENT = :silent
+        VOICE = :voice
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The status of the verification.
+      #
+      # @see PreludeSDK::Models::VerificationCreateResponse#status
+      module Status
+        extend PreludeSDK::Internal::Type::Enum
+
+        SUCCESS = :success
+        RETRY = :retry
+        BLOCKED = :blocked
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see PreludeSDK::Models::VerificationCreateResponse#metadata
+      class Metadata < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!method initialize(correlation_id: nil)
+        #   The metadata for this verification.
+        #
+        #   @param correlation_id [String]
+      end
+
+      # The reason why the verification was blocked. Only present when status is
+      # "blocked".
+      #
+      # @see PreludeSDK::Models::VerificationCreateResponse#reason
+      module Reason
+        extend PreludeSDK::Internal::Type::Enum
+
+        SUSPICIOUS = :suspicious
+        REPEATED_ATTEMPTS = :repeated_attempts
+        INVALID_PHONE_LINE = :invalid_phone_line
+        INVALID_PHONE_NUMBER = :invalid_phone_number
+        IN_BLOCK_LIST = :in_block_list
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see PreludeSDK::Models::VerificationCreateResponse#silent
+      class Silent < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute request_url
+        #   The URL to start the silent verification towards.
+        #
+        #   @return [String]
+        required :request_url, String
+
+        # @!method initialize(request_url:)
+        #   The silent verification specific properties.
+        #
+        #   @param request_url [String] The URL to start the silent verification towards.
+      end
+    end
+  end
+end