prelude-sdk 0.1.0.pre.alpha.3 → 0.1.0

data/lib/prelude_sdk/resources/verification_management.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Resources
+    class VerificationManagement
+      # Remove a phone number from the allow or block list.
+      #
+      # This operation is idempotent - re-deleting the same phone number will not result
+      # in errors. If the phone number does not exist in the specified list, the
+      # operation will succeed without making any changes.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      #
+      # @overload delete_phone_number(action, phone_number:, request_options: {})
+      #
+      # @param action [Symbol, PreludeSDK::Models::VerificationManagementDeletePhoneNumberParams::Action] The action type - either "allow" or "block"
+      #
+      # @param phone_number [String] An E.164 formatted phone number to remove from the list.
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::VerificationManagementDeletePhoneNumberResponse]
+      #
+      # @see PreludeSDK::Models::VerificationManagementDeletePhoneNumberParams
+      def delete_phone_number(action, params)
+        parsed, options = PreludeSDK::VerificationManagementDeletePhoneNumberParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: ["v2/verification/management/phone-numbers/%1$s", action],
+          body: parsed,
+          model: PreludeSDK::Models::VerificationManagementDeletePhoneNumberResponse,
+          options: options
+        )
+      end
+
+      # Retrieve the list of phone numbers in the allow or block list.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      #
+      # @overload list_phone_numbers(action, request_options: {})
+      #
+      # @param action [Symbol, PreludeSDK::Models::VerificationManagementListPhoneNumbersParams::Action] The action type - either "allow" or "block"
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse]
+      #
+      # @see PreludeSDK::Models::VerificationManagementListPhoneNumbersParams
+      def list_phone_numbers(action, params = {})
+        @client.request(
+          method: :get,
+          path: ["v2/verification/management/phone-numbers/%1$s", action],
+          model: PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieve sender IDs list.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      #
+      # @overload list_sender_ids(request_options: {})
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::VerificationManagementListSenderIDsResponse]
+      #
+      # @see PreludeSDK::Models::VerificationManagementListSenderIDsParams
+      def list_sender_ids(params = {})
+        @client.request(
+          method: :get,
+          path: "v2/verification/management/sender-id",
+          model: PreludeSDK::Models::VerificationManagementListSenderIDsResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Add a phone number to the allow or block list.
+      #
+      # This operation is idempotent - re-adding the same phone number will not result
+      # in duplicate entries or errors. If the phone number already exists in the
+      # specified list, the operation will succeed without making any changes.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      #
+      # @overload set_phone_number(action, phone_number:, request_options: {})
+      #
+      # @param action [Symbol, PreludeSDK::Models::VerificationManagementSetPhoneNumberParams::Action] The action type - either "allow" or "block"
+      #
+      # @param phone_number [String] An E.164 formatted phone number to add to the list.
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::VerificationManagementSetPhoneNumberResponse]
+      #
+      # @see PreludeSDK::Models::VerificationManagementSetPhoneNumberParams
+      def set_phone_number(action, params)
+        parsed, options = PreludeSDK::VerificationManagementSetPhoneNumberParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v2/verification/management/phone-numbers/%1$s", action],
+          body: parsed,
+          model: PreludeSDK::Models::VerificationManagementSetPhoneNumberResponse,
+          options: options
+        )
+      end
+
+      # This endpoint allows you to submit a new sender ID for verification purposes.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      #
+      # @overload submit_sender_id(sender_id:, request_options: {})
+      #
+      # @param sender_id [String] The sender ID to add.
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse]
+      #
+      # @see PreludeSDK::Models::VerificationManagementSubmitSenderIDParams
+      def submit_sender_id(params)
+        parsed, options = PreludeSDK::VerificationManagementSubmitSenderIDParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v2/verification/management/sender-id",
+          body: parsed,
+          model: PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [PreludeSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/prelude_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PreludeSDK
-  VERSION = "0.1.0.pre.alpha.3"
+  VERSION = "0.1.0"
 end

data/lib/prelude_sdk.rb

@@ -9,6 +9,7 @@ require "erb"
 require "etc"
 require "json"
 require "net/http"
+require "openssl"
 require "pathname"
 require "rbconfig"
 require "securerandom"
@@ -58,6 +59,16 @@ require_relative "prelude_sdk/models/verification_check_params"
 require_relative "prelude_sdk/models/verification_check_response"
 require_relative "prelude_sdk/models/verification_create_params"
 require_relative "prelude_sdk/models/verification_create_response"
+require_relative "prelude_sdk/models/verification_management_delete_phone_number_params"
+require_relative "prelude_sdk/models/verification_management_delete_phone_number_response"
+require_relative "prelude_sdk/models/verification_management_list_phone_numbers_params"
+require_relative "prelude_sdk/models/verification_management_list_phone_numbers_response"
+require_relative "prelude_sdk/models/verification_management_list_sender_ids_params"
+require_relative "prelude_sdk/models/verification_management_list_sender_ids_response"
+require_relative "prelude_sdk/models/verification_management_set_phone_number_params"
+require_relative "prelude_sdk/models/verification_management_set_phone_number_response"
+require_relative "prelude_sdk/models/verification_management_submit_sender_id_params"
+require_relative "prelude_sdk/models/verification_management_submit_sender_id_response"
 require_relative "prelude_sdk/models/watch_predict_params"
 require_relative "prelude_sdk/models/watch_predict_response"
 require_relative "prelude_sdk/models/watch_send_events_params"
@@ -68,4 +79,5 @@ require_relative "prelude_sdk/models"
 require_relative "prelude_sdk/resources/lookup"
 require_relative "prelude_sdk/resources/transactional"
 require_relative "prelude_sdk/resources/verification"
+require_relative "prelude_sdk/resources/verification_management"
 require_relative "prelude_sdk/resources/watch"

data/manifest.yaml

@@ -6,6 +6,7 @@ dependencies:
   - etc
   - json
   - net/http
+  - openssl
   - pathname
   - rbconfig
   - securerandom

data/rbi/prelude_sdk/client.rbi

@@ -23,6 +23,9 @@ module PreludeSDK
     sig { returns(PreludeSDK::Resources::Verification) }
     attr_reader :verification
 
+    sig { returns(PreludeSDK::Resources::VerificationManagement) }
+    attr_reader :verification_management
+
     sig { returns(PreludeSDK::Resources::Watch) }
     attr_reader :watch
 

data/rbi/prelude_sdk/errors.rbi

@@ -33,6 +33,9 @@ module PreludeSDK
       sig { returns(T.nilable(Integer)) }
       attr_accessor :status
 
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
       sig { returns(T.nilable(T.anything)) }
       attr_accessor :body
 
@@ -41,6 +44,7 @@ module PreludeSDK
         params(
           url: URI::Generic,
           status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
@@ -50,6 +54,7 @@ module PreludeSDK
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -70,6 +75,7 @@ module PreludeSDK
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -79,6 +85,7 @@ module PreludeSDK
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -93,6 +100,7 @@ module PreludeSDK
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -102,6 +110,7 @@ module PreludeSDK
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,13 +125,22 @@ module PreludeSDK
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil)
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
 
       sig { returns(Integer) }
@@ -133,13 +151,22 @@ module PreludeSDK
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil)
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
     end
 

data/rbi/prelude_sdk/file_part.rbi

@@ -27,7 +27,7 @@ module PreludeSDK
     sig do
       params(
         content: T.any(Pathname, StringIO, IO, String),
-        filename: T.nilable(String),
+        filename: T.nilable(T.any(Pathname, String)),
         content_type: T.nilable(String)
       ).returns(T.attached_class)
     end

data/rbi/prelude_sdk/internal/transport/base_client.rbi

@@ -85,10 +85,9 @@ module PreludeSDK
 
           # @api private
           sig do
-            params(
-              status: Integer,
-              headers: T.any(T::Hash[String, String], Net::HTTPHeader)
-            ).returns(T::Boolean)
+            params(status: Integer, headers: T::Hash[String, String]).returns(
+              T::Boolean
+            )
           end
           def should_retry?(status, headers:)
           end
@@ -99,7 +98,7 @@ module PreludeSDK
               request:
                 PreludeSDK::Internal::Transport::BaseClient::RequestInput,
               status: Integer,
-              response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+              response_headers: T::Hash[String, String]
             ).returns(PreludeSDK::Internal::Transport::BaseClient::RequestInput)
           end
           def follow_redirect(request, status:, response_headers:)
@@ -179,6 +178,11 @@ module PreludeSDK
         private def auth_headers
         end
 
+        # @api private
+        sig { returns(String) }
+        private def user_agent
+        end
+
         # @api private
         sig { returns(String) }
         private def generate_idempotency_key

data/rbi/prelude_sdk/internal/transport/pooled_net_requester.rbi

@@ -26,8 +26,12 @@ module PreludeSDK
 
         class << self
           # @api private
-          sig { params(url: URI::Generic).returns(Net::HTTP) }
-          def connect(url)
+          sig do
+            params(cert_store: OpenSSL::X509::Store, url: URI::Generic).returns(
+              Net::HTTP
+            )
+          end
+          def connect(cert_store:, url:)
           end
 
           # @api private

data/rbi/prelude_sdk/internal/type/base_model.rbi

@@ -31,7 +31,7 @@ module PreludeSDK
           #
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
-          sig { params(child: T.self_type).void }
+          sig { params(child: PreludeSDK::Internal::Type::BaseModel).void }
           def inherited(child)
           end
 
@@ -276,9 +276,13 @@ module PreludeSDK
 
         # Create a new instance of a model.
         sig do
-          params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(
-            T.attached_class
-          )
+          params(
+            data:
+              T.any(
+                T::Hash[Symbol, T.anything],
+                PreludeSDK::Internal::Type::BaseModel
+              )
+          ).returns(T.attached_class)
         end
         def self.new(data = {})
         end

data/rbi/prelude_sdk/internal/type/base_page.rbi

@@ -30,7 +30,7 @@ module PreludeSDK
           params(
             client: PreludeSDK::Internal::Transport::BaseClient,
             req: PreludeSDK::Internal::Transport::BaseClient::RequestComponents,
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             page_data: T.anything
           ).void
         end

data/rbi/prelude_sdk/internal/util.rbi

@@ -361,7 +361,7 @@ module PreludeSDK
         # Assumes each chunk in stream has `Encoding::BINARY`.
         sig do
           params(
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             stream: T::Enumerable[String],
             suppress_error: T::Boolean
           ).returns(T.anything)

data/rbi/prelude_sdk/models/transactional_send_params.rbi

@@ -62,6 +62,32 @@ module PreludeSDK
       sig { params(locale: String).void }
       attr_writer :locale
 
+      # The preferred delivery channel for the message. When specified, the system will
+      # prioritize sending via the requested channel if the template is configured for
+      # it.
+      #
+      # If not specified and the template is configured for WhatsApp, the message will
+      # be sent via WhatsApp first, with automatic fallback to SMS if WhatsApp delivery
+      # is unavailable.
+      #
+      # Supported channels: `sms`, `rcs`, `whatsapp`.
+      sig do
+        returns(
+          T.nilable(
+            PreludeSDK::TransactionalSendParams::PreferredChannel::OrSymbol
+          )
+        )
+      end
+      attr_reader :preferred_channel
+
+      sig do
+        params(
+          preferred_channel:
+            PreludeSDK::TransactionalSendParams::PreferredChannel::OrSymbol
+        ).void
+      end
+      attr_writer :preferred_channel
+
       # The variables to be replaced in the template.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :variables
@@ -78,6 +104,8 @@ module PreludeSDK
           expires_at: String,
           from: String,
           locale: String,
+          preferred_channel:
+            PreludeSDK::TransactionalSendParams::PreferredChannel::OrSymbol,
           variables: T::Hash[Symbol, String],
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -102,6 +130,16 @@ module PreludeSDK
         # code of the phone number. If the language specified doesn't exist, the default
         # set on the template will be used.
         locale: nil,
+        # The preferred delivery channel for the message. When specified, the system will
+        # prioritize sending via the requested channel if the template is configured for
+        # it.
+        #
+        # If not specified and the template is configured for WhatsApp, the message will
+        # be sent via WhatsApp first, with automatic fallback to SMS if WhatsApp delivery
+        # is unavailable.
+        #
+        # Supported channels: `sms`, `rcs`, `whatsapp`.
+        preferred_channel: nil,
         # The variables to be replaced in the template.
         variables: nil,
         request_options: {}
@@ -118,6 +156,8 @@ module PreludeSDK
             expires_at: String,
             from: String,
             locale: String,
+            preferred_channel:
+              PreludeSDK::TransactionalSendParams::PreferredChannel::OrSymbol,
             variables: T::Hash[Symbol, String],
             request_options: PreludeSDK::RequestOptions
           }
@@ -125,6 +165,51 @@ module PreludeSDK
       end
       def to_hash
       end
+
+      # The preferred delivery channel for the message. When specified, the system will
+      # prioritize sending via the requested channel if the template is configured for
+      # it.
+      #
+      # If not specified and the template is configured for WhatsApp, the message will
+      # be sent via WhatsApp first, with automatic fallback to SMS if WhatsApp delivery
+      # is unavailable.
+      #
+      # Supported channels: `sms`, `rcs`, `whatsapp`.
+      module PreferredChannel
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, PreludeSDK::TransactionalSendParams::PreferredChannel)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SMS =
+          T.let(
+            :sms,
+            PreludeSDK::TransactionalSendParams::PreferredChannel::TaggedSymbol
+          )
+        RCS =
+          T.let(
+            :rcs,
+            PreludeSDK::TransactionalSendParams::PreferredChannel::TaggedSymbol
+          )
+        WHATSAPP =
+          T.let(
+            :whatsapp,
+            PreludeSDK::TransactionalSendParams::PreferredChannel::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::TransactionalSendParams::PreferredChannel::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end