prelude-sdk 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c0ab52c77ef4b4adef294278608b900e799d87addb9838aa9d0f1b670cba4e3
-  data.tar.gz: 44b544a684b17f92a020198981d31f6013a43cc7d73b47c475f680529e332adb
+  metadata.gz: 8731fe84115bb4e974b30b47e338de7edb1f104b7cf647c48fa5d02e0b18ae8d
+  data.tar.gz: ef60164897791a51d47662deac42eafc71b8a1036b0bd8cb9440564f01149c39
 SHA512:
-  metadata.gz: 73d77009ae1589ec192685756e1ab08475f561447e281ff9ce16104be9c64bd16dc8658a9563d10c8fff0d8bf1ebf48756c2545125ba6e7f2c65ba59f020514d
-  data.tar.gz: 97b509de3dbc882b0ba62e84e19d7aaf4a17219a9d689d6e3fa309d07685969e92ce049326640c9f06f2038e1f8e5d90433955e5e9f5e3dd0d75cc779253e381
+  metadata.gz: 6a1bd302938e69cddf9fc148cf5f8cee8b1562afa6ce41e0290764c0b9cce9565fe5d7303648f13911a8ae32a7166cd67dd0bff7b55e901f91fc9d7e62266fbe
+  data.tar.gz: 02e63639aa44241d657fb07bdcd1877bb2de1c8290459dd07afd1c4320fd5e7a357b8836b4c04b375ba25b6874091bac694837075eb2d600590785221fb307f8

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.8.0 (2026-09-18)
+
+Full Changelog: [v0.7.0...v0.8.0](https://github.com/prelude-so/ruby-sdk/compare/v0.7.0...v0.8.0)
+
+### Features
+
+* **api:** manual updates ([fd3a3b9](https://github.com/prelude-so/ruby-sdk/commit/fd3a3b9945d005824ebfa07b69d554bc1de532fd))
+
 ## 0.7.0 (2026-09-15)
 
 Full Changelog: [v0.6.0...v0.7.0](https://github.com/prelude-so/ruby-sdk/compare/v0.6.0...v0.7.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "prelude-sdk", "~> 0.7.0"
+gem "prelude-sdk", "~> 0.8.0"
 ```
 
 <!-- x-release-please-end -->
@@ -184,9 +184,7 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-prelude.verification.create(
-  target: PreludeSDK::VerificationCreateParams::Target.new(type: "phone_number", value: "+30123456789")
-)
+prelude.verification.create(target: PreludeSDK::Target.new(type: "phone_number", value: "+30123456789"))
 ```
 
 Or, equivalently:
@@ -197,7 +195,7 @@ prelude.verification.create(target: {type: "phone_number", value: "+30123456789"
 
 # You can also splat a full Params class:
 params = PreludeSDK::VerificationCreateParams.new(
-  target: PreludeSDK::VerificationCreateParams::Target.new(type: "phone_number", value: "+30123456789")
+  target: PreludeSDK::Target.new(type: "phone_number", value: "+30123456789")
 )
 prelude.verification.create(**params)
 ```

data/lib/prelude_sdk/client.rb

@@ -44,6 +44,9 @@ module PreludeSDK
     # @return [PreludeSDK::Resources::Watch]
     attr_reader :watch
 
+    # @return [PreludeSDK::Resources::Intel]
+    attr_reader :intel
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -111,6 +114,7 @@ module PreludeSDK
       @verification = PreludeSDK::Resources::Verification.new(client: self)
       @verification_management = PreludeSDK::Resources::VerificationManagement.new(client: self)
       @watch = PreludeSDK::Resources::Watch.new(client: self)
+      @intel = PreludeSDK::Resources::Intel.new(client: self)
     end
   end
 end

data/lib/prelude_sdk/internal/type/base_model.rb

@@ -438,11 +438,11 @@ module PreludeSDK
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `lookup_lookup_response` is a `PreludeSDK::Models::LookupLookupResponse`
-        #   lookup_lookup_response => {
-        #     caller_name: caller_name,
-        #     country_code: country_code,
-        #     flags: flags
+        #   # `signals` is a `PreludeSDK::Signals`
+        #   signals => {
+        #     app_version: app_version,
+        #     device_id: device_id,
+        #     device_model: device_model
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/prelude_sdk/models/intel/kyc_match_params.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module Intel
+      # @see PreludeSDK::Resources::Intel::KYC#match
+      class KYCMatchParams < PreludeSDK::Internal::Type::BaseModel
+        extend PreludeSDK::Internal::Type::RequestParameters::Converter
+        include PreludeSDK::Internal::Type::RequestParameters
+
+        # @!attribute phone
+        #   An E.164 formatted phone number whose subscriber identity to match against.
+        #
+        #   @return [String]
+        required :phone, String
+
+        # @!attribute address
+        #   The street address.
+        #
+        #   @return [String, nil]
+        optional :address, String
+
+        # @!attribute birthdate
+        #   The date of birth in ISO 8601 (`YYYY-MM-DD`) format. Compared exactly.
+        #
+        #   @return [Date, nil]
+        optional :birthdate, Date
+
+        # @!attribute country
+        #   The ISO 3166-1 alpha-2 country code. Compared exactly.
+        #
+        #   @return [String, nil]
+        optional :country, String
+
+        # @!attribute email
+        #   The email address.
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute family_name
+        #   The end-user's family (last) name.
+        #
+        #   @return [String, nil]
+        optional :family_name, String
+
+        # @!attribute given_name
+        #   The end-user's given (first) name.
+        #
+        #   @return [String, nil]
+        optional :given_name, String
+
+        # @!attribute locality
+        #   The locality (city).
+        #
+        #   @return [String, nil]
+        optional :locality, String
+
+        # @!attribute postal_code
+        #   The postal code. Compared exactly.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String
+
+        # @!attribute region
+        #   The region, state, or province.
+        #
+        #   @return [String, nil]
+        optional :region, String
+
+        # @!method initialize(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}]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/intel/kyc_match_response.rb

@@ -0,0 +1,305 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module Intel
+      # @see PreludeSDK::Resources::Intel::KYC#match
+      class KYCMatchResponse < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute address_match
+        #   Whether the street address matched the operator's record.
+        #
+        #   @return [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::AddressMatch, nil]
+        optional :address_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::AddressMatch }
+
+        # @!attribute address_match_score
+        #   Similarity score (0-99) for the address. Returned only on a non-match.
+        #
+        #   @return [Integer, nil]
+        optional :address_match_score, Integer
+
+        # @!attribute birthdate_match
+        #   Whether the date of birth matched the operator's record. Compared exactly; never
+        #   scored.
+        #
+        #   @return [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::BirthdateMatch, nil]
+        optional :birthdate_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::BirthdateMatch }
+
+        # @!attribute country_code
+        #   The country code of the phone number.
+        #
+        #   @return [String, nil]
+        optional :country_code, String
+
+        # @!attribute country_match
+        #   Whether the country matched the operator's record. Compared exactly; never
+        #   scored.
+        #
+        #   @return [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::CountryMatch, nil]
+        optional :country_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::CountryMatch }
+
+        # @!attribute email_match
+        #   Whether the email address matched the operator's record.
+        #
+        #   @return [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::EmailMatch, nil]
+        optional :email_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::EmailMatch }
+
+        # @!attribute email_match_score
+        #   Similarity score (0-99) for the email. Returned only on a non-match.
+        #
+        #   @return [Integer, nil]
+        optional :email_match_score, Integer
+
+        # @!attribute family_name_match
+        #   Whether the family name matched the operator's record.
+        #
+        #   @return [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::FamilyNameMatch, nil]
+        optional :family_name_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::FamilyNameMatch }
+
+        # @!attribute family_name_match_score
+        #   Similarity score (0-99) for the family name. Returned only on a non-match.
+        #
+        #   @return [Integer, nil]
+        optional :family_name_match_score, Integer
+
+        # @!attribute given_name_match
+        #   Whether the given name matched the operator's record.
+        #
+        #   @return [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::GivenNameMatch, nil]
+        optional :given_name_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::GivenNameMatch }
+
+        # @!attribute given_name_match_score
+        #   Similarity score (0-99) for the given name. Returned only on a non-match.
+        #
+        #   @return [Integer, nil]
+        optional :given_name_match_score, Integer
+
+        # @!attribute locality_match
+        #   Whether the locality matched the operator's record.
+        #
+        #   @return [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::LocalityMatch, nil]
+        optional :locality_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::LocalityMatch }
+
+        # @!attribute locality_match_score
+        #   Similarity score (0-99) for the locality. Returned only on a non-match.
+        #
+        #   @return [Integer, nil]
+        optional :locality_match_score, Integer
+
+        # @!attribute operator
+        #   The mobile operator that answered the match.
+        #
+        #   @return [String, nil]
+        optional :operator, String
+
+        # @!attribute phone_number
+        #   The phone number that was matched, in E.164 format.
+        #
+        #   @return [String, nil]
+        optional :phone_number, String
+
+        # @!attribute postal_code_match
+        #   Whether the postal code matched the operator's record. Compared exactly; never
+        #   scored.
+        #
+        #   @return [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::PostalCodeMatch, nil]
+        optional :postal_code_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::PostalCodeMatch }
+
+        # @!attribute region_match
+        #   Whether the region matched the operator's record.
+        #
+        #   @return [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::RegionMatch, nil]
+        optional :region_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::RegionMatch }
+
+        # @!attribute region_match_score
+        #   Similarity score (0-99) for the region. Returned only on a non-match.
+        #
+        #   @return [Integer, nil]
+        optional :region_match_score, Integer
+
+        # @!attribute request_id
+        #   A string that identifies this specific request. Report it back to us to help us
+        #   diagnose your issues.
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!method initialize(address_match: nil, address_match_score: nil, birthdate_match: nil, country_code: nil, country_match: nil, email_match: nil, email_match_score: nil, family_name_match: nil, family_name_match_score: nil, given_name_match: nil, given_name_match_score: nil, locality_match: nil, locality_match_score: nil, operator: nil, phone_number: nil, postal_code_match: nil, region_match: nil, region_match_score: nil, request_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::Intel::KYCMatchResponse} for more details.
+        #
+        #   The per-attribute match result. Each `<attribute>_match` field is one of `true`,
+        #   `false`, or `not_available` (the operator could not answer for that attribute).
+        #   Fuzzy attributes additionally return a `<attribute>_match_score` (0-99
+        #   similarity) when they do not match exactly; the score is omitted on a match or
+        #   when `not_available`.
+        #
+        #   @param address_match [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::AddressMatch] Whether the street address matched the operator's record.
+        #
+        #   @param address_match_score [Integer] Similarity score (0-99) for the address. Returned only on a non-match.
+        #
+        #   @param birthdate_match [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::BirthdateMatch] Whether the date of birth matched the operator's record. Compared exactly; never
+        #
+        #   @param country_code [String] The country code of the phone number.
+        #
+        #   @param country_match [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::CountryMatch] Whether the country matched the operator's record. Compared exactly; never score
+        #
+        #   @param email_match [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::EmailMatch] Whether the email address matched the operator's record.
+        #
+        #   @param email_match_score [Integer] Similarity score (0-99) for the email. Returned only on a non-match.
+        #
+        #   @param family_name_match [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::FamilyNameMatch] Whether the family name matched the operator's record.
+        #
+        #   @param family_name_match_score [Integer] Similarity score (0-99) for the family name. Returned only on a non-match.
+        #
+        #   @param given_name_match [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::GivenNameMatch] Whether the given name matched the operator's record.
+        #
+        #   @param given_name_match_score [Integer] Similarity score (0-99) for the given name. Returned only on a non-match.
+        #
+        #   @param locality_match [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::LocalityMatch] Whether the locality matched the operator's record.
+        #
+        #   @param locality_match_score [Integer] Similarity score (0-99) for the locality. Returned only on a non-match.
+        #
+        #   @param operator [String] The mobile operator that answered the match.
+        #
+        #   @param phone_number [String] The phone number that was matched, in E.164 format.
+        #
+        #   @param postal_code_match [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::PostalCodeMatch] Whether the postal code matched the operator's record. Compared exactly; never s
+        #
+        #   @param region_match [Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::RegionMatch] Whether the region matched the operator's record.
+        #
+        #   @param region_match_score [Integer] Similarity score (0-99) for the region. Returned only on a non-match.
+        #
+        #   @param request_id [String] A string that identifies this specific request. Report it back to us to help us
+
+        # Whether the street address matched the operator's record.
+        #
+        # @see PreludeSDK::Models::Intel::KYCMatchResponse#address_match
+        module AddressMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE = :true
+          FALSE = :false
+          NOT_AVAILABLE = :not_available
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether the date of birth matched the operator's record. Compared exactly; never
+        # scored.
+        #
+        # @see PreludeSDK::Models::Intel::KYCMatchResponse#birthdate_match
+        module BirthdateMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE = :true
+          FALSE = :false
+          NOT_AVAILABLE = :not_available
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether the country matched the operator's record. Compared exactly; never
+        # scored.
+        #
+        # @see PreludeSDK::Models::Intel::KYCMatchResponse#country_match
+        module CountryMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE = :true
+          FALSE = :false
+          NOT_AVAILABLE = :not_available
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether the email address matched the operator's record.
+        #
+        # @see PreludeSDK::Models::Intel::KYCMatchResponse#email_match
+        module EmailMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE = :true
+          FALSE = :false
+          NOT_AVAILABLE = :not_available
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether the family name matched the operator's record.
+        #
+        # @see PreludeSDK::Models::Intel::KYCMatchResponse#family_name_match
+        module FamilyNameMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE = :true
+          FALSE = :false
+          NOT_AVAILABLE = :not_available
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether the given name matched the operator's record.
+        #
+        # @see PreludeSDK::Models::Intel::KYCMatchResponse#given_name_match
+        module GivenNameMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE = :true
+          FALSE = :false
+          NOT_AVAILABLE = :not_available
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether the locality matched the operator's record.
+        #
+        # @see PreludeSDK::Models::Intel::KYCMatchResponse#locality_match
+        module LocalityMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE = :true
+          FALSE = :false
+          NOT_AVAILABLE = :not_available
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether the postal code matched the operator's record. Compared exactly; never
+        # scored.
+        #
+        # @see PreludeSDK::Models::Intel::KYCMatchResponse#postal_code_match
+        module PostalCodeMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE = :true
+          FALSE = :false
+          NOT_AVAILABLE = :not_available
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether the region matched the operator's record.
+        #
+        # @see PreludeSDK::Models::Intel::KYCMatchResponse#region_match
+        module RegionMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE = :true
+          FALSE = :false
+          NOT_AVAILABLE = :not_available
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_reply_params.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#reply
+    class NotifyReplyParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute reply_to
+      #   The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
+      #   the `inbound.message.received` webhook event.
+      #
+      #   @return [String]
+      required :reply_to, String
+
+      # @!attribute text
+      #   The reply message body sent as a free-form WhatsApp text.
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute to
+      #   The recipient's phone number in E.164 format. Must match the phone number that
+      #   sent the original inbound message.
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute callback_url
+      #   The URL where webhooks will be sent for delivery events of this reply.
+      #
+      #   @return [String, nil]
+      optional :callback_url, String
+
+      # @!attribute correlation_id
+      #   A user-defined identifier to correlate this reply with your internal systems. It
+      #   is returned in the response and any webhook events that refer to this message.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!method initialize(reply_to:, text:, to:, callback_url: nil, correlation_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::NotifyReplyParams} for more details.
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_reply_response.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#reply
+    class NotifyReplyResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The reply message identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The reply creation date in RFC3339 format.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute reply_to
+      #   The inbound message ID this reply was sent in response to.
+      #
+      #   @return [String]
+      required :reply_to, String
+
+      # @!attribute text
+      #   The reply message body that was sent.
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute to
+      #   The recipient's phone number in E.164 format.
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute callback_url
+      #   The callback URL where webhooks will be sent.
+      #
+      #   @return [String, nil]
+      optional :callback_url, String
+
+      # @!attribute correlation_id
+      #   The user-defined correlation identifier echoed back from the request.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!method initialize(id:, created_at:, reply_to:, text:, to:, callback_url: nil, correlation_id: nil)
+      #   @param id [String] The reply message identifier.
+      #
+      #   @param created_at [Time] The reply creation date in RFC3339 format.
+      #
+      #   @param reply_to [String] The inbound message ID this reply was sent in response to.
+      #
+      #   @param text [String] The reply message body that was sent.
+      #
+      #   @param to [String] The recipient's phone number in E.164 format.
+      #
+      #   @param callback_url [String] The callback URL where webhooks will be sent.
+      #
+      #   @param correlation_id [String] The user-defined correlation identifier echoed back from the request.
+    end
+  end
+end