prelude-sdk 0.7.0 → 0.9.0

data/lib/prelude_sdk/models/watch_predict_response.rb

@@ -28,29 +28,43 @@ module PreludeSDK
       #   when prediction is "suspicious" and the anti-fraud system detected specific risk
       #   signals.
       #
-      #   - `account_risk_profile` - The target matches a risk profile derived from the
-      #     outcomes reported on your own account, rather than from a signal shared across
-      #     accounts.
-      #   - `behavioral_pattern` - The phone number past behavior during verification
-      #     flows exhibits suspicious patterns.
-      #   - `device_attribute` - The device exhibits characteristics associated with
-      #     suspicious activity patterns.
-      #   - `fraud_database` - The phone number has been flagged as suspicious in one or
-      #     more of our fraud databases.
-      #   - `location_discrepancy` - The phone number prefix and IP address discrepancy
-      #     indicates potential fraud.
-      #   - `network_fingerprint` - The network connection exhibits characteristics
-      #     associated with suspicious activity patterns.
-      #   - `poor_conversion_history` - The phone number has a history of poorly
-      #     converting to a verified phone number.
-      #   - `prefix_concentration` - The phone number is part of a range known to be
-      #     associated with suspicious activity patterns.
-      #   - `suspected_request_tampering` - The SDK signature is invalid and the request
-      #     is considered to be tampered with.
-      #   - `suspicious_ip_address` - The IP address is deemed to be associated with
-      #     suspicious activity patterns.
-      #   - `temporary_phone_number` - The phone number is known to be a temporary or
-      #     disposable number.
+      #   - `account_risk_profile` - The request matches a risk profile derived from the
+      #     outcomes reported on your own account.
+      #   - `automation_signature` - The request appears to come from an automated client
+      #     rather than a person.
+      #   - `carrier_not_permitted` - The destination carrier is one this account does not
+      #     accept traffic for.
+      #   - `client_fingerprint_mismatch` - The client does not appear to be the platform
+      #     it identifies itself as.
+      #   - `custom_policy` - A rule configured for your account matched this request.
+      #   - `device_emulator` - The request appears to come from an emulator rather than a
+      #     physical device.
+      #   - `device_not_permitted` - The device platform is one your account blocks.
+      #   - `device_reuse` - One device is driving verifications for an unusual number of
+      #     phone numbers.
+      #   - `expired_signals` - The SDK signals were collected too long before the request
+      #     to still attest to it.
+      #   - `fraud_database` - The phone number is flagged in one or more of the fraud
+      #     databases Prelude consults.
+      #   - `invalid_signature` - The SDK signature did not verify, so the request cannot
+      #     be attributed to the device it claims to come from.
+      #   - `ip_concentration` - The request shares its origin with an unusual volume of
+      #     other verifications.
+      #   - `ip_reputation` - The originating IP address is not trusted.
+      #   - `location_mismatch` - The network location and the phone number's country are
+      #     inconsistent.
+      #   - `missing_signals` - The verification expected Prelude SDK signals and none
+      #     arrived.
+      #   - `number_range_abuse` - The phone number belongs to a range currently
+      #     associated with abuse.
+      #   - `poor_conversion_history` - Traffic resembling this request rarely completes a
+      #     verification.
+      #   - `proxy_network` - The request did not arrive over the subscriber's own access
+      #     network.
+      #   - `repeated_attempts` - The phone number exceeded the allowed number of
+      #     verification attempts in a short period.
+      #   - `temporary_phone_number` - The phone number belongs to a disposable or
+      #     short-lived numbering service.
       #
       #   @return [Array<Symbol, PreludeSDK::Models::WatchPredictResponse::RiskFactor>, nil]
       optional :risk_factors,
@@ -85,15 +99,24 @@ module PreludeSDK
         extend PreludeSDK::Internal::Type::Enum
 
         ACCOUNT_RISK_PROFILE = :account_risk_profile
-        BEHAVIORAL_PATTERN = :behavioral_pattern
-        DEVICE_ATTRIBUTE = :device_attribute
+        AUTOMATION_SIGNATURE = :automation_signature
+        CARRIER_NOT_PERMITTED = :carrier_not_permitted
+        CLIENT_FINGERPRINT_MISMATCH = :client_fingerprint_mismatch
+        CUSTOM_POLICY = :custom_policy
+        DEVICE_EMULATOR = :device_emulator
+        DEVICE_NOT_PERMITTED = :device_not_permitted
+        DEVICE_REUSE = :device_reuse
+        EXPIRED_SIGNALS = :expired_signals
         FRAUD_DATABASE = :fraud_database
-        LOCATION_DISCREPANCY = :location_discrepancy
-        NETWORK_FINGERPRINT = :network_fingerprint
+        INVALID_SIGNATURE = :invalid_signature
+        IP_CONCENTRATION = :ip_concentration
+        IP_REPUTATION = :ip_reputation
+        LOCATION_MISMATCH = :location_mismatch
+        MISSING_SIGNALS = :missing_signals
+        NUMBER_RANGE_ABUSE = :number_range_abuse
         POOR_CONVERSION_HISTORY = :poor_conversion_history
-        PREFIX_CONCENTRATION = :prefix_concentration
-        SUSPECTED_REQUEST_TAMPERING = :suspected_request_tampering
-        SUSPICIOUS_IP_ADDRESS = :suspicious_ip_address
+        PROXY_NETWORK = :proxy_network
+        REPEATED_ATTEMPTS = :repeated_attempts
         TEMPORARY_PHONE_NUMBER = :temporary_phone_number
 
         # @!method self.values

data/lib/prelude_sdk/models/watch_send_events_params.rb

@@ -46,8 +46,8 @@ module PreludeSDK
         # @!attribute target
         #   The event target. Only supports phone numbers for now.
         #
-        #   @return [PreludeSDK::Models::WatchSendEventsParams::Event::Target]
-        required :target, -> { PreludeSDK::WatchSendEventsParams::Event::Target }
+        #   @return [PreludeSDK::Models::Target]
+        required :target, -> { PreludeSDK::Target }
 
         # @!method initialize(confidence:, label:, target:)
         #   Some parameter documentations has been truncated, see
@@ -57,7 +57,7 @@ module PreludeSDK
         #
         #   @param label [String] A label to describe what the event refers to.
         #
-        #   @param target [PreludeSDK::Models::WatchSendEventsParams::Event::Target] The event target. Only supports phone numbers for now.
+        #   @param target [PreludeSDK::Models::Target] The event target. Only supports phone numbers for now.
 
         # How much this event tells us to trust the end-user's legitimacy — not how
         # certain you are that the event occurred. In increasing order of trust:
@@ -82,41 +82,6 @@ module PreludeSDK
           # @!method self.values
           #   @return [Array<Symbol>]
         end
-
-        # @see PreludeSDK::Models::WatchSendEventsParams::Event#target
-        class Target < PreludeSDK::Internal::Type::BaseModel
-          # @!attribute type
-          #   The type of the target. Either "phone_number" or "email_address".
-          #
-          #   @return [Symbol, PreludeSDK::Models::WatchSendEventsParams::Event::Target::Type]
-          required :type, enum: -> { PreludeSDK::WatchSendEventsParams::Event::Target::Type }
-
-          # @!attribute value
-          #   An E.164 formatted phone number or an email address.
-          #
-          #   @return [String]
-          required :value, String
-
-          # @!method initialize(type:, value:)
-          #   The event target. Only supports phone numbers for now.
-          #
-          #   @param type [Symbol, PreludeSDK::Models::WatchSendEventsParams::Event::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::WatchSendEventsParams::Event::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
       end
     end
   end

data/lib/prelude_sdk/models/watch_send_feedbacks_params.rb

@@ -27,8 +27,8 @@ module PreludeSDK
         # @!attribute target
         #   The feedback target. Only supports phone numbers for now.
         #
-        #   @return [PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Target]
-        required :target, -> { PreludeSDK::WatchSendFeedbacksParams::Feedback::Target }
+        #   @return [PreludeSDK::Models::Target]
+        required :target, -> { PreludeSDK::Target }
 
         # @!attribute type
         #   The type of feedback.
@@ -43,47 +43,12 @@ module PreludeSDK
         optional :metadata, -> { PreludeSDK::WatchSendFeedbacksParams::Feedback::Metadata }
 
         # @!method initialize(target:, type:, metadata: nil)
-        #   @param target [PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Target] The feedback target. Only supports phone numbers for now.
+        #   @param target [PreludeSDK::Models::Target] The feedback target. Only supports phone numbers for now.
         #
         #   @param type [Symbol, PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Type] The type of feedback.
         #
         #   @param metadata [PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Metadata] The metadata for this feedback.
 
-        # @see PreludeSDK::Models::WatchSendFeedbacksParams::Feedback#target
-        class Target < PreludeSDK::Internal::Type::BaseModel
-          # @!attribute type
-          #   The type of the target. Either "phone_number" or "email_address".
-          #
-          #   @return [Symbol, PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Target::Type]
-          required :type, enum: -> { PreludeSDK::WatchSendFeedbacksParams::Feedback::Target::Type }
-
-          # @!attribute value
-          #   An E.164 formatted phone number or an email address.
-          #
-          #   @return [String]
-          required :value, String
-
-          # @!method initialize(type:, value:)
-          #   The feedback target. Only supports phone numbers for now.
-          #
-          #   @param type [Symbol, PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::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::WatchSendFeedbacksParams::Feedback::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
-
         # The type of feedback.
         #
         # @see PreludeSDK::Models::WatchSendFeedbacksParams::Feedback#type

data/lib/prelude_sdk/models.rb

@@ -39,6 +39,8 @@ module PreludeSDK
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  Intel = PreludeSDK::Models::Intel
+
   LookupLookupParams = PreludeSDK::Models::LookupLookupParams
 
   NotifyGetSubscriptionConfigParams = PreludeSDK::Models::NotifyGetSubscriptionConfigParams
@@ -52,16 +54,26 @@ module PreludeSDK
 
   NotifyListSubscriptionPhoneNumbersParams = PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams
 
+  NotifyReplyParams = PreludeSDK::Models::NotifyReplyParams
+
   NotifySendBatchParams = PreludeSDK::Models::NotifySendBatchParams
 
   NotifySendParams = PreludeSDK::Models::NotifySendParams
 
+  Signals = PreludeSDK::Models::Signals
+
+  Target = PreludeSDK::Models::Target
+
   TransactionalSendParams = PreludeSDK::Models::TransactionalSendParams
 
+  Verification = PreludeSDK::Models::Verification
+
   VerificationCheckParams = PreludeSDK::Models::VerificationCheckParams
 
   VerificationCreateParams = PreludeSDK::Models::VerificationCreateParams
 
+  VerificationManagement = PreludeSDK::Models::VerificationManagement
+
   VerificationManagementDeletePhoneNumberParams =
     PreludeSDK::Models::VerificationManagementDeletePhoneNumberParams
 
@@ -76,6 +88,8 @@ module PreludeSDK
   VerificationManagementSubmitSenderIDParams =
     PreludeSDK::Models::VerificationManagementSubmitSenderIDParams
 
+  WatchEvaluateParams = PreludeSDK::Models::WatchEvaluateParams
+
   WatchPredictParams = PreludeSDK::Models::WatchPredictParams
 
   WatchSendEventsParams = PreludeSDK::Models::WatchSendEventsParams

data/lib/prelude_sdk/resources/intel/kyc.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Resources
+    class Intel
+      # Retrieve detailed information about a phone number including carrier data, line
+      # type, and portability status.
+      class KYC
+        # Verify identity attributes against the subscriber record held by the end-user's
+        # mobile operator. Send a phone number along with the attributes to check; Prelude
+        # resolves the operator internally and returns a per-attribute match. Currently
+        # available for France only (Orange, SFR, Bouygues) and must be enabled for your
+        # account.
+        #
+        # @overload match(phone, address: nil, birthdate: nil, country: nil, email: nil, family_name: nil, given_name: nil, locality: nil, postal_code: nil, region: nil, request_options: {})
+        #
+        # @param phone [String] An E.164 formatted phone number whose subscriber identity to match against.
+        #
+        # @param address [String] The street address.
+        #
+        # @param birthdate [Date] The date of birth in ISO 8601 (`YYYY-MM-DD`) format. Compared exactly.
+        #
+        # @param country [String] The ISO 3166-1 alpha-2 country code. Compared exactly.
+        #
+        # @param email [String] The email address.
+        #
+        # @param family_name [String] The end-user's family (last) name.
+        #
+        # @param given_name [String] The end-user's given (first) name.
+        #
+        # @param locality [String] The locality (city).
+        #
+        # @param postal_code [String] The postal code. Compared exactly.
+        #
+        # @param region [String] The region, state, or province.
+        #
+        # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [PreludeSDK::Models::Intel::KYCMatchResponse]
+        #
+        # @see PreludeSDK::Models::Intel::KYCMatchParams
+        def match(phone, params = {})
+          parsed, options = PreludeSDK::Intel::KYCMatchParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["v2/intel/kyc/match/%1$s", phone],
+            body: parsed,
+            model: PreludeSDK::Models::Intel::KYCMatchResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [PreludeSDK::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/resources/intel.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Resources
+    class Intel
+      # Retrieve detailed information about a phone number including carrier data, line
+      # type, and portability status.
+      # @return [PreludeSDK::Resources::Intel::KYC]
+      attr_reader :kyc
+
+      # @api private
+      #
+      # @param client [PreludeSDK::Client]
+      def initialize(client:)
+        @client = client
+        @kyc = PreludeSDK::Resources::Intel::KYC.new(client: client)
+      end
+    end
+  end
+end

data/lib/prelude_sdk/resources/notify.rb

@@ -163,6 +163,41 @@ module PreludeSDK
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {PreludeSDK::Models::NotifyReplyParams} for more details.
+      #
+      # Send a free-form text reply to an inbound WhatsApp message within the 24-hour
+      # conversation window. See
+      # [WhatsApp 2-Way Messaging](/notify/v2/documentation/whatsapp) for details.
+      #
+      # @overload reply(reply_to:, text:, to:, callback_url: nil, correlation_id: nil, request_options: {})
+      #
+      # @param reply_to [String] The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
+      #
+      # @param text [String] The reply message body sent as a free-form WhatsApp text.
+      #
+      # @param to [String] The recipient's phone number in E.164 format. Must match the phone number that s
+      #
+      # @param callback_url [String] The URL where webhooks will be sent for delivery events of this reply.
+      #
+      # @param correlation_id [String] A user-defined identifier to correlate this reply with your internal systems. It
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::NotifyReplyResponse]
+      #
+      # @see PreludeSDK::Models::NotifyReplyParams
+      def reply(params)
+        parsed, options = PreludeSDK::NotifyReplyParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v2/notify/reply",
+          body: parsed,
+          model: PreludeSDK::Models::NotifyReplyResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {PreludeSDK::Models::NotifySendParams} for more details.
       #

data/lib/prelude_sdk/resources/verification/phone/history.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Resources
+    class Verification
+      class Phone
+        # Verify phone numbers.
+        class History
+          # Retrieve everything Prelude recorded for one phone verification: its outcome and
+          # the device, network and anti-fraud context it was created in, the chronological
+          # timeline of every message attempt and code check, and the anti-fraud signals you
+          # forwarded.
+          #
+          # The identifier is the `id` returned by
+          # [Create or retry a verification](/verify/v2/api-reference/create-or-retry-a-verification)
+          # or the `verification_id` of the verification webhooks. Both `lifecycle` and
+          # `signals` are optional: a verification can resolve with its top-level fields
+          # alone.
+          #
+          # @overload retrieve(id, request_options: {})
+          #
+          # @param id [String] The verification identifier.
+          #
+          # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse]
+          #
+          # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveParams
+          def retrieve(id, params = {})
+            @client.request(
+              method: :get,
+              path: ["v2/verification/phone/history/%1$s", id],
+              model: PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse,
+              options: params[:request_options]
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {PreludeSDK::Models::Verification::Phone::HistoryListParams} for more details.
+          #
+          # List your phone verifications, most recent first, one entry per verification
+          # with its outcome, channels, attempts and cost. Every filter is optional and they
+          # combine with AND.
+          #
+          # Use it to find every verification a phone number went through from your support
+          # tooling, then
+          # [Get a phone verification](/verify/v2/api-reference/history/get-a-phone-verification)
+          # for the full timeline of one of them. A cursor is bound to the filters that
+          # produced it: pass `next_cursor` back with the exact same query parameters.
+          #
+          # @overload list(channels: nil, cursor: nil, device_platform: nil, from: nil, limit: nil, max_attempts: nil, min_attempts: nil, phone_number: nil, region: nil, status: nil, template_id: nil, to: nil, request_options: {})
+          #
+          # @param channels [Array<Symbol, PreludeSDK::Models::Verification::Phone::HistoryListParams::Channel>] Only verifications that could use one of these channels. Repeat the parameter fo
+          #
+          # @param cursor [String] Pagination cursor from the previous response.
+          #
+          # @param device_platform [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListParams::DevicePlatform] Only verifications created from this device platform.
+          #
+          # @param from [Time] Only verifications created at or after this RFC 3339 timestamp. Goes with `to`,
+          #
+          # @param limit [Integer] Maximum number of verifications to return per page.
+          #
+          # @param max_attempts [Integer] Only verifications that sent at most this many messages. `0` keeps the verificat
+          #
+          # @param min_attempts [Integer] Only verifications that sent at least this many messages.
+          #
+          # @param phone_number [String] Only verifications targeting this E.164 phone number. The leading `+` may be omi
+          #
+          # @param region [String] Only verifications of phone numbers from this region, as an ISO 3166-1 alpha-2 c
+          #
+          # @param status [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListParams::Status] Only verifications in this status. `pending_check` cannot be filtered on.
+          #
+          # @param template_id [String] Only verifications sent with this template, as returned in `template_id` by [Get
+          #
+          # @param to [Time] Only verifications created at or before this RFC 3339 timestamp. Goes with `from
+          #
+          # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [PreludeSDK::Models::Verification::Phone::HistoryListResponse]
+          #
+          # @see PreludeSDK::Models::Verification::Phone::HistoryListParams
+          def list(params = {})
+            parsed, options = PreludeSDK::Verification::Phone::HistoryListParams.dump_request(params)
+            query = PreludeSDK::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: "v2/verification/phone/history",
+              query: query,
+              model: PreludeSDK::Models::Verification::Phone::HistoryListResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [PreludeSDK::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/resources/verification/phone.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Resources
+    class Verification
+      class Phone
+        # Verify phone numbers.
+        # @return [PreludeSDK::Resources::Verification::Phone::History]
+        attr_reader :history
+
+        # @api private
+        #
+        # @param client [PreludeSDK::Client]
+        def initialize(client:)
+          @client = client
+          @history = PreludeSDK::Resources::Verification::Phone::History.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/resources/verification.rb

@@ -4,6 +4,9 @@ module PreludeSDK
   module Resources
     # Verify phone numbers.
     class Verification
+      # @return [PreludeSDK::Resources::Verification::Phone]
+      attr_reader :phone
+
       # Some parameter documentations has been truncated, see
       # {PreludeSDK::Models::VerificationCreateParams} for more details.
       #
@@ -13,7 +16,7 @@ module PreludeSDK
       #
       # @overload create(target:, dispatch_id: nil, metadata: nil, options: nil, signals: nil, request_options: {})
       #
-      # @param target [PreludeSDK::Models::VerificationCreateParams::Target] The verification target. Either a phone number or an email address. To use the e
+      # @param target [PreludeSDK::Models::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.
       #
@@ -21,7 +24,7 @@ module PreludeSDK
       #
       # @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 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]
       #
@@ -48,7 +51,7 @@ module PreludeSDK
       #
       # @param code [String] The OTP code to validate.
       #
-      # @param target [PreludeSDK::Models::VerificationCheckParams::Target] The verification target. Either a phone number or an email address. To use the e
+      # @param target [PreludeSDK::Models::Target] The verification target. Either a phone number or an email address. To use the e
       #
       # @param psd2 [PreludeSDK::Models::VerificationCheckParams::Psd2] Required when checking a code issued under the `prelude:psd2` template. The subm
       #
@@ -73,6 +76,7 @@ module PreludeSDK
       # @param client [PreludeSDK::Client]
       def initialize(client:)
         @client = client
+        @phone = PreludeSDK::Resources::Verification::Phone.new(client: client)
       end
     end
   end

data/lib/prelude_sdk/resources/verification_management/sandbox.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Resources
+    class VerificationManagement
+      # Verify phone numbers.
+      class Sandbox
+        # Some parameter documentations has been truncated, see
+        # {PreludeSDK::Models::VerificationManagement::SandboxAddPhoneNumberParams} for
+        # more details.
+        #
+        # Register a phone number as a sandbox number and associate it with a fixed
+        # attempt code. Subsequent verification attempts against this number will not
+        # trigger a real SMS/call and will validate against the configured attempt code.
+        #
+        # This operation is idempotent - re-adding the same phone number will overwrite
+        # the existing attempt code.
+        #
+        # In order to get access to this endpoint, contact our support team.
+        #
+        # @overload add_phone_number(attempt_code:, phone_number:, request_options: {})
+        #
+        # @param attempt_code [String] The fixed attempt code that will validate verification attempts for this phone n
+        #
+        # @param phone_number [String] An E.164 formatted phone number to add to the sandbox list.
+        #
+        # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [PreludeSDK::Models::VerificationManagement::SandboxAddPhoneNumberResponse]
+        #
+        # @see PreludeSDK::Models::VerificationManagement::SandboxAddPhoneNumberParams
+        def add_phone_number(params)
+          parsed, options = PreludeSDK::VerificationManagement::SandboxAddPhoneNumberParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: "v2/verification/management/phone-numbers/sandbox",
+            body: parsed,
+            model: PreludeSDK::Models::VerificationManagement::SandboxAddPhoneNumberResponse,
+            options: options
+          )
+        end
+
+        # Remove a phone number from the sandbox list.
+        #
+        # This operation is idempotent - deleting a phone number that is not in the
+        # sandbox list will succeed without making any changes.
+        #
+        # In order to get access to this endpoint, contact our support team.
+        #
+        # @overload delete_phone_number(phone_number, request_options: {})
+        #
+        # @param phone_number [String] The E.164 formatted phone number to remove from the sandbox list.
+        #
+        # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [PreludeSDK::Models::VerificationManagement::SandboxDeletePhoneNumberResponse]
+        #
+        # @see PreludeSDK::Models::VerificationManagement::SandboxDeletePhoneNumberParams
+        def delete_phone_number(phone_number, params = {})
+          @client.request(
+            method: :delete,
+            path: ["v2/verification/management/phone-numbers/sandbox/%1$s", phone_number],
+            model: PreludeSDK::Models::VerificationManagement::SandboxDeletePhoneNumberResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Retrieve the list of sandbox phone numbers for the account. Sandbox numbers are
+        # test numbers that bypass the real verification flow and return a fixed attempt
+        # code.
+        #
+        # In order to get access to this endpoint, contact our support team.
+        #
+        # @overload list_phone_numbers(request_options: {})
+        #
+        # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse]
+        #
+        # @see PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersParams
+        def list_phone_numbers(params = {})
+          @client.request(
+            method: :get,
+            path: "v2/verification/management/phone-numbers/sandbox",
+            model: PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [PreludeSDK::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end