prelude-sdk 0.1.0 → 0.3.0

data/rbi/prelude_sdk/resources/notify.rbi

@@ -0,0 +1,227 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    # Send transactional and marketing messages with compliance enforcement.
+    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,
+          document: PreludeSDK::NotifySendParams::Document::OrHash,
+          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,
+        # A document to attach to the message. Only supported on WhatsApp templates that
+        # have a document header.
+        document: 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,
+          document: PreludeSDK::NotifySendBatchParams::Document::OrHash,
+          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,
+        # A document to attach to the message. Only supported on WhatsApp templates that
+        # have a document header.
+        document: 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

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Send transactional messages (deprecated - use Notify API instead).
     class Transactional
       # Legacy route maintained for backward compatibility. Migrate to `/v2/notify`
       # instead.
@@ -11,6 +12,7 @@ module PreludeSDK
           to: String,
           callback_url: String,
           correlation_id: String,
+          document: PreludeSDK::TransactionalSendParams::Document::OrHash,
           expires_at: String,
           from: String,
           locale: String,
@@ -31,6 +33,9 @@ module PreludeSDK
         # returned in the response and any webhook events that refer to this
         # transactionalmessage.
         correlation_id: nil,
+        # A document to attach to the message. Only supported on WhatsApp templates that
+        # have a document header.
+        document: nil,
         # The message expiration date.
         expires_at: nil,
         # The Sender ID.

data/rbi/prelude_sdk/resources/verification.rbi

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Verify phone numbers.
     class Verification
       # Create a new verification for a specific phone number. If another non-expired
       # verification exists (the request is performed within the verification window),

data/rbi/prelude_sdk/resources/verification_management.rbi

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Verify phone numbers.
     class VerificationManagement
       # Remove a phone number from the allow or block list.
       #

data/rbi/prelude_sdk/resources/watch.rbi

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Evaluate email addresses and phone numbers for trustworthiness.
     class Watch
       # Predict the outcome of a verification based on Prelude’s anti-fraud system.
       sig do

data/sig/prelude_sdk/client.rbs

@@ -12,6 +12,8 @@ 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

data/sig/prelude_sdk/internal/util.rbs

@@ -106,6 +106,16 @@ module PreludeSDK
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/prelude_sdk/models/lookup_lookup_params.rbs

@@ -1,13 +1,18 @@
 module PreludeSDK
   module Models
     type lookup_lookup_params =
-      { type: ::Array[PreludeSDK::Models::LookupLookupParams::type_] }
+      {
+        phone_number: String,
+        type: ::Array[PreludeSDK::Models::LookupLookupParams::type_]
+      }
       & PreludeSDK::Internal::Type::request_parameters
 
     class LookupLookupParams < PreludeSDK::Internal::Type::BaseModel
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
+      attr_accessor phone_number: String
+
       attr_reader type: ::Array[PreludeSDK::Models::LookupLookupParams::type_]?
 
       def type=: (
@@ -15,11 +20,13 @@ module PreludeSDK
       ) -> ::Array[PreludeSDK::Models::LookupLookupParams::type_]
 
       def initialize: (
+        phone_number: String,
         ?type: ::Array[PreludeSDK::Models::LookupLookupParams::type_],
         ?request_options: PreludeSDK::request_opts
       ) -> void
 
       def to_hash: -> {
+        phone_number: String,
         type: ::Array[PreludeSDK::Models::LookupLookupParams::type_],
         request_options: PreludeSDK::RequestOptions
       }

data/sig/prelude_sdk/models/notify_get_subscription_config_params.rbs

@@ -0,0 +1,23 @@
+module PreludeSDK
+  module Models
+    type notify_get_subscription_config_params =
+      { config_id: String } & PreludeSDK::Internal::Type::request_parameters
+
+    class NotifyGetSubscriptionConfigParams < 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_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,28 @@
+module PreludeSDK
+  module Models
+    type notify_get_subscription_phone_number_params =
+      { config_id: String, phone_number: 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
+
+      attr_accessor phone_number: String
+
+      def initialize: (
+        config_id: String,
+        phone_number: String,
+        ?request_options: PreludeSDK::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        config_id: String,
+        phone_number: 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

data/sig/prelude_sdk/models/notify_list_subscription_configs_params.rbs

@@ -0,0 +1,32 @@
+module PreludeSDK
+  module Models
+    type notify_list_subscription_configs_params =
+      { cursor: String, limit: Integer }
+      & PreludeSDK::Internal::Type::request_parameters
+
+    class NotifyListSubscriptionConfigsParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      attr_reader cursor: String?
+
+      def cursor=: (String) -> String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      def initialize: (
+        ?cursor: String,
+        ?limit: Integer,
+        ?request_options: PreludeSDK::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        cursor: String,
+        limit: Integer,
+        request_options: PreludeSDK::RequestOptions
+      }
+    end
+  end
+end