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

data/rbi/prelude_sdk/resources/notify.rbi

@@ -0,0 +1,218 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    class Notify
+      # Retrieve a specific subscription management configuration by its ID.
+      sig do
+        params(
+          config_id: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::NotifyGetSubscriptionConfigResponse)
+      end
+      def get_subscription_config(
+        # The subscription configuration ID
+        config_id,
+        request_options: {}
+      )
+      end
+
+      # Retrieve the current subscription status for a specific phone number within a
+      # subscription configuration.
+      sig do
+        params(
+          phone_number: String,
+          config_id: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse)
+      end
+      def get_subscription_phone_number(
+        # The phone number in E.164 format (e.g., +33612345678)
+        phone_number,
+        # The subscription configuration ID
+        config_id:,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a paginated list of subscription management configurations for your
+      # account.
+      #
+      # Each configuration represents a subscription management setup with phone numbers
+      # for receiving opt-out/opt-in requests and a callback URL for webhook events.
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::NotifyListSubscriptionConfigsResponse)
+      end
+      def list_subscription_configs(
+        # Pagination cursor from the previous response
+        cursor: nil,
+        # Maximum number of configurations to return per page
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a paginated list of subscription events (status changes) for a specific
+      # phone number within a subscription configuration.
+      #
+      # Events are ordered by timestamp in descending order (most recent first).
+      sig do
+        params(
+          phone_number: String,
+          config_id: String,
+          cursor: String,
+          limit: Integer,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(
+          PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse
+        )
+      end
+      def list_subscription_phone_number_events(
+        # Path param: The phone number in E.164 format (e.g., +33612345678)
+        phone_number,
+        # Path param: The subscription configuration ID
+        config_id:,
+        # Query param: Pagination cursor from the previous response
+        cursor: nil,
+        # Query param: Maximum number of events to return per page
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a paginated list of phone numbers and their subscription statuses for a
+      # specific subscription configuration.
+      #
+      # You can optionally filter by subscription state (SUB or UNSUB).
+      sig do
+        params(
+          config_id: String,
+          cursor: String,
+          limit: Integer,
+          state:
+            PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::OrSymbol,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(
+          PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse
+        )
+      end
+      def list_subscription_phone_numbers(
+        # The subscription configuration ID
+        config_id,
+        # Pagination cursor from the previous response
+        cursor: nil,
+        # Maximum number of phone numbers to return per page
+        limit: nil,
+        # Filter by subscription state
+        state: nil,
+        request_options: {}
+      )
+      end
+
+      # Send transactional and marketing messages to your users via SMS and WhatsApp
+      # with automatic compliance enforcement.
+      sig do
+        params(
+          template_id: String,
+          to: String,
+          callback_url: String,
+          correlation_id: String,
+          expires_at: Time,
+          from: String,
+          locale: String,
+          preferred_channel:
+            PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
+          schedule_at: Time,
+          variables: T::Hash[Symbol, String],
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::NotifySendResponse)
+      end
+      def send_(
+        # The template identifier configured by your Customer Success team.
+        template_id:,
+        # The recipient's phone number in E.164 format.
+        to:,
+        # The URL where webhooks will be sent for message delivery events.
+        callback_url: nil,
+        # A user-defined identifier to correlate this message with your internal systems.
+        # It is returned in the response and any webhook events that refer to this
+        # message.
+        correlation_id: nil,
+        # The message expiration date in RFC3339 format. The message will not be sent if
+        # this time is reached.
+        expires_at: nil,
+        # The Sender ID. Must be approved for your account.
+        from: nil,
+        # 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, the default
+        # set on the template will be used.
+        locale: nil,
+        # The preferred channel to be used in priority for message delivery. If the
+        # channel is unavailable, the system will fallback to other available channels.
+        preferred_channel: nil,
+        # Schedule the message for future delivery in RFC3339 format. Marketing messages
+        # can be scheduled up to 90 days in advance and will be automatically adjusted for
+        # compliance with local time window restrictions.
+        schedule_at: nil,
+        # The variables to be replaced in the template.
+        variables: nil,
+        request_options: {}
+      )
+      end
+
+      # Send the same message to multiple recipients in a single request.
+      sig do
+        params(
+          template_id: String,
+          to: T::Array[String],
+          callback_url: String,
+          correlation_id: String,
+          expires_at: Time,
+          from: String,
+          locale: String,
+          preferred_channel:
+            PreludeSDK::NotifySendBatchParams::PreferredChannel::OrSymbol,
+          schedule_at: Time,
+          variables: T::Hash[Symbol, String],
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::NotifySendBatchResponse)
+      end
+      def send_batch(
+        # The template identifier configured by your Customer Success team.
+        template_id:,
+        # The list of recipients' phone numbers in E.164 format.
+        to:,
+        # The URL where webhooks will be sent for delivery events.
+        callback_url: nil,
+        # A user-defined identifier to correlate this request with your internal systems.
+        correlation_id: nil,
+        # The message expiration date in RFC3339 format. Messages will not be sent after
+        # this time.
+        expires_at: nil,
+        # The Sender ID. Must be approved for your account.
+        from: nil,
+        # A BCP-47 formatted locale string.
+        locale: nil,
+        # Preferred channel for delivery. If unavailable, automatic fallback applies.
+        preferred_channel: nil,
+        # Schedule delivery in RFC3339 format. Marketing sends may be adjusted to comply
+        # with local time windows.
+        schedule_at: nil,
+        # The variables to be replaced in the template.
+        variables: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/resources/transactional.rbi

@@ -3,7 +3,8 @@
 module PreludeSDK
   module Resources
     class Transactional
-      # Send a transactional message to your user.
+      # Legacy route maintained for backward compatibility. Migrate to `/v2/notify`
+      # instead.
       sig do
         params(
           template_id: String,
@@ -13,6 +14,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(PreludeSDK::Models::TransactionalSendResponse)
@@ -37,6 +40,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: {}

data/rbi/prelude_sdk/resources/verification_management.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+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.
+      sig do
+        params(
+          action:
+            PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::OrSymbol,
+          phone_number: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(
+          PreludeSDK::Models::VerificationManagementDeletePhoneNumberResponse
+        )
+      end
+      def delete_phone_number(
+        # The action type - either "allow" or "block"
+        action,
+        # An E.164 formatted phone number to remove from the list.
+        phone_number:,
+        request_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.
+      sig do
+        params(
+          action:
+            PreludeSDK::VerificationManagementListPhoneNumbersParams::Action::OrSymbol,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(
+          PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse
+        )
+      end
+      def list_phone_numbers(
+        # The action type - either "allow" or "block"
+        action,
+        request_options: {}
+      )
+      end
+
+      # Retrieve sender IDs list.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      sig do
+        params(request_options: PreludeSDK::RequestOptions::OrHash).returns(
+          PreludeSDK::Models::VerificationManagementListSenderIDsResponse
+        )
+      end
+      def list_sender_ids(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.
+      sig do
+        params(
+          action:
+            PreludeSDK::VerificationManagementSetPhoneNumberParams::Action::OrSymbol,
+          phone_number: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(
+          PreludeSDK::Models::VerificationManagementSetPhoneNumberResponse
+        )
+      end
+      def set_phone_number(
+        # The action type - either "allow" or "block"
+        action,
+        # An E.164 formatted phone number to add to the list.
+        phone_number:,
+        request_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.
+      sig do
+        params(
+          sender_id: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(
+          PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse
+        )
+      end
+      def submit_sender_id(
+        # The sender ID to add.
+        sender_id:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/prelude_sdk/client.rbs

@@ -12,10 +12,14 @@ module PreludeSDK
 
     attr_reader lookup: PreludeSDK::Resources::Lookup
 
+    attr_reader notify: PreludeSDK::Resources::Notify
+
     attr_reader transactional: PreludeSDK::Resources::Transactional
 
     attr_reader verification: PreludeSDK::Resources::Verification
 
+    attr_reader verification_management: PreludeSDK::Resources::VerificationManagement
+
     attr_reader watch: PreludeSDK::Resources::Watch
 
     private def auth_headers: -> ::Hash[String, String]

data/sig/prelude_sdk/errors.rbs

@@ -21,11 +21,14 @@ module PreludeSDK
 
       attr_accessor status: Integer?
 
+      attr_accessor headers: ::Hash[String, String]?
+
       attr_accessor body: top?
 
       def initialize: (
         url: URI::Generic,
         ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
         ?body: Object?,
         ?request: nil,
         ?response: nil,
@@ -37,6 +40,7 @@ module PreludeSDK
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -48,6 +52,7 @@ module PreludeSDK
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -59,6 +64,7 @@ module PreludeSDK
       def self.for: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,
@@ -68,6 +74,7 @@ module PreludeSDK
       def initialize: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,

data/sig/prelude_sdk/file_part.rbs

@@ -14,7 +14,7 @@ module PreludeSDK
 
     def initialize: (
       Pathname | StringIO | IO | String content,
-      ?filename: String?,
+      ?filename: (Pathname | String)?,
       ?content_type: String?
     ) -> void
   end

data/sig/prelude_sdk/internal/transport/base_client.rbs

@@ -87,6 +87,8 @@ module PreludeSDK
 
         private def auth_headers: -> ::Hash[String, String]
 
+        private def user_agent: -> String
+
         private def generate_idempotency_key: -> String
 
         private def build_request: (

data/sig/prelude_sdk/internal/transport/pooled_net_requester.rbs

@@ -17,7 +17,10 @@ module PreludeSDK
 
         DEFAULT_MAX_CONNECTIONS: Integer
 
-        def self.connect: (URI::Generic url) -> top
+        def self.connect: (
+          cert_store: OpenSSL::X509::Store,
+          url: URI::Generic
+        ) -> top
 
         def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
 

data/sig/prelude_sdk/models/notify_get_subscription_config_params.rbs

@@ -0,0 +1,15 @@
+module PreludeSDK
+  module Models
+    type notify_get_subscription_config_params =
+      {  } & PreludeSDK::Internal::Type::request_parameters
+
+    class NotifyGetSubscriptionConfigParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: PreludeSDK::request_opts) -> void
+
+      def to_hash: -> { request_options: PreludeSDK::RequestOptions }
+    end
+  end
+end

data/sig/prelude_sdk/models/notify_get_subscription_config_response.rbs

@@ -0,0 +1,95 @@
+module PreludeSDK
+  module Models
+    type notify_get_subscription_config_response =
+      {
+        id: String,
+        callback_url: String,
+        created_at: Time,
+        messages: PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::Messages,
+        name: String,
+        updated_at: Time,
+        mo_phone_numbers: ::Array[PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber]
+      }
+
+    class NotifyGetSubscriptionConfigResponse < PreludeSDK::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor callback_url: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor messages: PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::Messages
+
+      attr_accessor name: String
+
+      attr_accessor updated_at: Time
+
+      attr_reader mo_phone_numbers: ::Array[PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber]?
+
+      def mo_phone_numbers=: (
+        ::Array[PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber]
+      ) -> ::Array[PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber]
+
+      def initialize: (
+        id: String,
+        callback_url: String,
+        created_at: Time,
+        messages: PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::Messages,
+        name: String,
+        updated_at: Time,
+        ?mo_phone_numbers: ::Array[PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber]
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        callback_url: String,
+        created_at: Time,
+        messages: PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::Messages,
+        name: String,
+        updated_at: Time,
+        mo_phone_numbers: ::Array[PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber]
+      }
+
+      type messages =
+        { help_message: String, start_message: String, stop_message: String }
+
+      class Messages < PreludeSDK::Internal::Type::BaseModel
+        attr_reader help_message: String?
+
+        def help_message=: (String) -> String
+
+        attr_reader start_message: String?
+
+        def start_message=: (String) -> String
+
+        attr_reader stop_message: String?
+
+        def stop_message=: (String) -> String
+
+        def initialize: (
+          ?help_message: String,
+          ?start_message: String,
+          ?stop_message: String
+        ) -> void
+
+        def to_hash: -> {
+          help_message: String,
+          start_message: String,
+          stop_message: String
+        }
+      end
+
+      type mo_phone_number = { country_code: String, phone_number: String }
+
+      class MoPhoneNumber < PreludeSDK::Internal::Type::BaseModel
+        attr_accessor country_code: String
+
+        attr_accessor phone_number: String
+
+        def initialize: (country_code: String, phone_number: String) -> void
+
+        def to_hash: -> { country_code: String, phone_number: String }
+      end
+    end
+  end
+end

data/sig/prelude_sdk/models/notify_get_subscription_phone_number_params.rbs

@@ -0,0 +1,23 @@
+module PreludeSDK
+  module Models
+    type notify_get_subscription_phone_number_params =
+      { config_id: String } & PreludeSDK::Internal::Type::request_parameters
+
+    class NotifyGetSubscriptionPhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      attr_accessor config_id: String
+
+      def initialize: (
+        config_id: String,
+        ?request_options: PreludeSDK::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        config_id: String,
+        request_options: PreludeSDK::RequestOptions
+      }
+    end
+  end
+end

data/sig/prelude_sdk/models/notify_get_subscription_phone_number_response.rbs

@@ -0,0 +1,71 @@
+module PreludeSDK
+  module Models
+    type notify_get_subscription_phone_number_response =
+      {
+        config_id: String,
+        phone_number: String,
+        source: PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::source,
+        state: PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::state,
+        updated_at: Time,
+        reason: String
+      }
+
+    class NotifyGetSubscriptionPhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
+      attr_accessor config_id: String
+
+      attr_accessor phone_number: String
+
+      attr_accessor source: PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::source
+
+      attr_accessor state: PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::state
+
+      attr_accessor updated_at: Time
+
+      attr_reader reason: String?
+
+      def reason=: (String) -> String
+
+      def initialize: (
+        config_id: String,
+        phone_number: String,
+        source: PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::source,
+        state: PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::state,
+        updated_at: Time,
+        ?reason: String
+      ) -> void
+
+      def to_hash: -> {
+        config_id: String,
+        phone_number: String,
+        source: PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::source,
+        state: PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::state,
+        updated_at: Time,
+        reason: String
+      }
+
+      type source = :MO_KEYWORD | :API | :CSV_IMPORT | :CARRIER_DISCONNECT
+
+      module Source
+        extend PreludeSDK::Internal::Type::Enum
+
+        MO_KEYWORD: :MO_KEYWORD
+        API: :API
+        CSV_IMPORT: :CSV_IMPORT
+        CARRIER_DISCONNECT: :CARRIER_DISCONNECT
+
+        def self?.values: -> ::Array[PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::source]
+      end
+
+      type state = :SUB | :UNSUB
+
+      module State
+        extend PreludeSDK::Internal::Type::Enum
+
+        SUB: :SUB
+        UNSUB: :UNSUB
+
+        def self?.values: -> ::Array[PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::state]
+      end
+    end
+  end
+end