prelude-sdk 0.1.0 → 0.2.0

data/lib/prelude_sdk/models/notify_send_params.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#send_
+    class NotifySendParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute template_id
+      #   The template identifier configured by your Customer Success team.
+      #
+      #   @return [String]
+      required :template_id, String
+
+      # @!attribute to
+      #   The recipient's phone number in E.164 format.
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute callback_url
+      #   The URL where webhooks will be sent for message delivery events.
+      #
+      #   @return [String, nil]
+      optional :callback_url, String
+
+      # @!attribute correlation_id
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute expires_at
+      #   The message expiration date in RFC3339 format. The message will not be sent if
+      #   this time is reached.
+      #
+      #   @return [Time, nil]
+      optional :expires_at, Time
+
+      # @!attribute from
+      #   The Sender ID. Must be approved for your account.
+      #
+      #   @return [String, nil]
+      optional :from, String
+
+      # @!attribute locale
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!attribute preferred_channel
+      #   The preferred channel to be used in priority for message delivery. If the
+      #   channel is unavailable, the system will fallback to other available channels.
+      #
+      #   @return [Symbol, PreludeSDK::Models::NotifySendParams::PreferredChannel, nil]
+      optional :preferred_channel, enum: -> { PreludeSDK::NotifySendParams::PreferredChannel }
+
+      # @!attribute schedule_at
+      #   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.
+      #
+      #   @return [Time, nil]
+      optional :schedule_at, Time
+
+      # @!attribute variables
+      #   The variables to be replaced in the template.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :variables, PreludeSDK::Internal::Type::HashOf[String]
+
+      # @!method initialize(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::NotifySendParams} for more details.
+      #
+      #   @param template_id [String] The template identifier configured by your Customer Success team.
+      #
+      #   @param to [String] The recipient's phone number in E.164 format.
+      #
+      #   @param callback_url [String] The URL where webhooks will be sent for message delivery events.
+      #
+      #   @param correlation_id [String] A user-defined identifier to correlate this message with your internal systems.
+      #
+      #   @param expires_at [Time] The message expiration date in RFC3339 format. The message will not be sent if t
+      #
+      #   @param from [String] The Sender ID. Must be approved for your account.
+      #
+      #   @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
+      #
+      #   @param preferred_channel [Symbol, PreludeSDK::Models::NotifySendParams::PreferredChannel] The preferred channel to be used in priority for message delivery. If the channe
+      #
+      #   @param schedule_at [Time] Schedule the message for future delivery in RFC3339 format. Marketing messages c
+      #
+      #   @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # The preferred channel to be used in priority for message delivery. If the
+      # channel is unavailable, the system will fallback to other available channels.
+      module PreferredChannel
+        extend PreludeSDK::Internal::Type::Enum
+
+        SMS = :sms
+        WHATSAPP = :whatsapp
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_send_response.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#send_
+    class NotifySendResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The message identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The message creation date in RFC3339 format.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute expires_at
+      #   The message expiration date in RFC3339 format.
+      #
+      #   @return [Time]
+      required :expires_at, Time
+
+      # @!attribute template_id
+      #   The template identifier.
+      #
+      #   @return [String]
+      required :template_id, String
+
+      # @!attribute to
+      #   The recipient's phone number in E.164 format.
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute variables
+      #   The variables to be replaced in the template.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :variables, PreludeSDK::Internal::Type::HashOf[String]
+
+      # @!attribute callback_url
+      #   The callback URL where webhooks will be sent.
+      #
+      #   @return [String, nil]
+      optional :callback_url, String
+
+      # @!attribute correlation_id
+      #   A user-defined identifier to correlate this message with your internal systems.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute from
+      #   The Sender ID used for this message.
+      #
+      #   @return [String, nil]
+      optional :from, String
+
+      # @!attribute schedule_at
+      #   When the message will actually be sent in RFC3339 format with timezone offset.
+      #   For marketing messages, this may differ from the requested schedule_at due to
+      #   automatic compliance adjustments.
+      #
+      #   @return [Time, nil]
+      optional :schedule_at, Time
+
+      # @!method initialize(id:, created_at:, expires_at:, template_id:, to:, variables:, callback_url: nil, correlation_id: nil, from: nil, schedule_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::NotifySendResponse} for more details.
+      #
+      #   @param id [String] The message identifier.
+      #
+      #   @param created_at [Time] The message creation date in RFC3339 format.
+      #
+      #   @param expires_at [Time] The message expiration date in RFC3339 format.
+      #
+      #   @param template_id [String] The template identifier.
+      #
+      #   @param to [String] The recipient's phone number in E.164 format.
+      #
+      #   @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
+      #
+      #   @param callback_url [String] The callback URL where webhooks will be sent.
+      #
+      #   @param correlation_id [String] A user-defined identifier to correlate this message with your internal systems.
+      #
+      #   @param from [String] The Sender ID used for this message.
+      #
+      #   @param schedule_at [Time] When the message will actually be sent in RFC3339 format with timezone offset. F
+    end
+  end
+end

data/lib/prelude_sdk/models.rb

@@ -41,6 +41,21 @@ module PreludeSDK
 
   LookupLookupParams = PreludeSDK::Models::LookupLookupParams
 
+  NotifyGetSubscriptionConfigParams = PreludeSDK::Models::NotifyGetSubscriptionConfigParams
+
+  NotifyGetSubscriptionPhoneNumberParams = PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberParams
+
+  NotifyListSubscriptionConfigsParams = PreludeSDK::Models::NotifyListSubscriptionConfigsParams
+
+  NotifyListSubscriptionPhoneNumberEventsParams =
+    PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsParams
+
+  NotifyListSubscriptionPhoneNumbersParams = PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams
+
+  NotifySendBatchParams = PreludeSDK::Models::NotifySendBatchParams
+
+  NotifySendParams = PreludeSDK::Models::NotifySendParams
+
   TransactionalSendParams = PreludeSDK::Models::TransactionalSendParams
 
   VerificationCheckParams = PreludeSDK::Models::VerificationCheckParams

data/lib/prelude_sdk/resources/notify.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Resources
+    class Notify
+      # Retrieve a specific subscription management configuration by its ID.
+      #
+      # @overload get_subscription_config(config_id, request_options: {})
+      #
+      # @param config_id [String] The subscription configuration ID
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::NotifyGetSubscriptionConfigResponse]
+      #
+      # @see PreludeSDK::Models::NotifyGetSubscriptionConfigParams
+      def get_subscription_config(config_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v2/notify/management/subscriptions/%1$s", config_id],
+          model: PreludeSDK::Models::NotifyGetSubscriptionConfigResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieve the current subscription status for a specific phone number within a
+      # subscription configuration.
+      #
+      # @overload get_subscription_phone_number(phone_number, config_id:, request_options: {})
+      #
+      # @param phone_number [String] The phone number in E.164 format (e.g., +33612345678)
+      #
+      # @param config_id [String] The subscription configuration ID
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse]
+      #
+      # @see PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberParams
+      def get_subscription_phone_number(phone_number, params)
+        parsed, options = PreludeSDK::NotifyGetSubscriptionPhoneNumberParams.dump_request(params)
+        config_id =
+          parsed.delete(:config_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["v2/notify/management/subscriptions/%1$s/phone_numbers/%2$s", config_id, phone_number],
+          model: PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse,
+          options: 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.
+      #
+      # @overload list_subscription_configs(cursor: nil, limit: nil, request_options: {})
+      #
+      # @param cursor [String] Pagination cursor from the previous response
+      #
+      # @param limit [Integer] Maximum number of configurations to return per page
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::NotifyListSubscriptionConfigsResponse]
+      #
+      # @see PreludeSDK::Models::NotifyListSubscriptionConfigsParams
+      def list_subscription_configs(params = {})
+        parsed, options = PreludeSDK::NotifyListSubscriptionConfigsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v2/notify/management/subscriptions",
+          query: parsed,
+          model: PreludeSDK::Models::NotifyListSubscriptionConfigsResponse,
+          options: 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).
+      #
+      # @overload list_subscription_phone_number_events(phone_number, config_id:, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param phone_number [String] Path param: The phone number in E.164 format (e.g., +33612345678)
+      #
+      # @param config_id [String] Path param: The subscription configuration ID
+      #
+      # @param cursor [String] Query param: Pagination cursor from the previous response
+      #
+      # @param limit [Integer] Query param: Maximum number of events to return per page
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse]
+      #
+      # @see PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsParams
+      def list_subscription_phone_number_events(phone_number, params)
+        parsed, options = PreludeSDK::NotifyListSubscriptionPhoneNumberEventsParams.dump_request(params)
+        config_id =
+          parsed.delete(:config_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: [
+            "v2/notify/management/subscriptions/%1$s/phone_numbers/%2$s/events",
+            config_id,
+            phone_number
+          ],
+          query: parsed,
+          model: PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse,
+          options: 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).
+      #
+      # @overload list_subscription_phone_numbers(config_id, cursor: nil, limit: nil, state: nil, request_options: {})
+      #
+      # @param config_id [String] The subscription configuration ID
+      #
+      # @param cursor [String] Pagination cursor from the previous response
+      #
+      # @param limit [Integer] Maximum number of phone numbers to return per page
+      #
+      # @param state [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams::State] Filter by subscription state
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse]
+      #
+      # @see PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams
+      def list_subscription_phone_numbers(config_id, params = {})
+        parsed, options = PreludeSDK::NotifyListSubscriptionPhoneNumbersParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["v2/notify/management/subscriptions/%1$s/phone_numbers", config_id],
+          query: parsed,
+          model: PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {PreludeSDK::Models::NotifySendParams} for more details.
+      #
+      # Send transactional and marketing messages to your users via SMS and WhatsApp
+      # with automatic compliance enforcement.
+      #
+      # @overload send_(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
+      #
+      # @param template_id [String] The template identifier configured by your Customer Success team.
+      #
+      # @param to [String] The recipient's phone number in E.164 format.
+      #
+      # @param callback_url [String] The URL where webhooks will be sent for message delivery events.
+      #
+      # @param correlation_id [String] A user-defined identifier to correlate this message with your internal systems.
+      #
+      # @param expires_at [Time] The message expiration date in RFC3339 format. The message will not be sent if t
+      #
+      # @param from [String] The Sender ID. Must be approved for your account.
+      #
+      # @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
+      #
+      # @param preferred_channel [Symbol, PreludeSDK::Models::NotifySendParams::PreferredChannel] The preferred channel to be used in priority for message delivery. If the channe
+      #
+      # @param schedule_at [Time] Schedule the message for future delivery in RFC3339 format. Marketing messages c
+      #
+      # @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::NotifySendResponse]
+      #
+      # @see PreludeSDK::Models::NotifySendParams
+      def send_(params)
+        parsed, options = PreludeSDK::NotifySendParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v2/notify",
+          body: parsed,
+          model: PreludeSDK::Models::NotifySendResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {PreludeSDK::Models::NotifySendBatchParams} for more details.
+      #
+      # Send the same message to multiple recipients in a single request.
+      #
+      # @overload send_batch(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
+      #
+      # @param template_id [String] The template identifier configured by your Customer Success team.
+      #
+      # @param to [Array<String>] The list of recipients' phone numbers in E.164 format.
+      #
+      # @param callback_url [String] The URL where webhooks will be sent for delivery events.
+      #
+      # @param correlation_id [String] A user-defined identifier to correlate this request with your internal systems.
+      #
+      # @param expires_at [Time] The message expiration date in RFC3339 format. Messages will not be sent after t
+      #
+      # @param from [String] The Sender ID. Must be approved for your account.
+      #
+      # @param locale [String] A BCP-47 formatted locale string.
+      #
+      # @param preferred_channel [Symbol, PreludeSDK::Models::NotifySendBatchParams::PreferredChannel] Preferred channel for delivery. If unavailable, automatic fallback applies.
+      #
+      # @param schedule_at [Time] Schedule delivery in RFC3339 format. Marketing sends may be adjusted to comply w
+      #
+      # @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
+      #
+      # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PreludeSDK::Models::NotifySendBatchResponse]
+      #
+      # @see PreludeSDK::Models::NotifySendBatchParams
+      def send_batch(params)
+        parsed, options = PreludeSDK::NotifySendBatchParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v2/notify/batch",
+          body: parsed,
+          model: PreludeSDK::Models::NotifySendBatchResponse,
+          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"
+  VERSION = "0.2.0"
 end

data/lib/prelude_sdk.rb

@@ -3,6 +3,7 @@
 # Standard libraries.
 # rubocop:disable Lint/RedundantRequireStatement
 require "English"
+require "base64"
 require "cgi"
 require "date"
 require "erb"
@@ -53,6 +54,20 @@ require_relative "prelude_sdk/internal/transport/pooled_net_requester"
 require_relative "prelude_sdk/client"
 require_relative "prelude_sdk/models/lookup_lookup_params"
 require_relative "prelude_sdk/models/lookup_lookup_response"
+require_relative "prelude_sdk/models/notify_get_subscription_config_params"
+require_relative "prelude_sdk/models/notify_get_subscription_config_response"
+require_relative "prelude_sdk/models/notify_get_subscription_phone_number_params"
+require_relative "prelude_sdk/models/notify_get_subscription_phone_number_response"
+require_relative "prelude_sdk/models/notify_list_subscription_configs_params"
+require_relative "prelude_sdk/models/notify_list_subscription_configs_response"
+require_relative "prelude_sdk/models/notify_list_subscription_phone_number_events_params"
+require_relative "prelude_sdk/models/notify_list_subscription_phone_number_events_response"
+require_relative "prelude_sdk/models/notify_list_subscription_phone_numbers_params"
+require_relative "prelude_sdk/models/notify_list_subscription_phone_numbers_response"
+require_relative "prelude_sdk/models/notify_send_batch_params"
+require_relative "prelude_sdk/models/notify_send_batch_response"
+require_relative "prelude_sdk/models/notify_send_params"
+require_relative "prelude_sdk/models/notify_send_response"
 require_relative "prelude_sdk/models/transactional_send_params"
 require_relative "prelude_sdk/models/transactional_send_response"
 require_relative "prelude_sdk/models/verification_check_params"
@@ -77,6 +92,7 @@ require_relative "prelude_sdk/models/watch_send_feedbacks_params"
 require_relative "prelude_sdk/models/watch_send_feedbacks_response"
 require_relative "prelude_sdk/models"
 require_relative "prelude_sdk/resources/lookup"
+require_relative "prelude_sdk/resources/notify"
 require_relative "prelude_sdk/resources/transactional"
 require_relative "prelude_sdk/resources/verification"
 require_relative "prelude_sdk/resources/verification_management"

data/manifest.yaml

@@ -1,5 +1,6 @@
 dependencies:
   - English
+  - base64
   - cgi
   - date
   - erb

data/rbi/prelude_sdk/client.rbi

@@ -17,6 +17,9 @@ module PreludeSDK
     sig { returns(PreludeSDK::Resources::Lookup) }
     attr_reader :lookup
 
+    sig { returns(PreludeSDK::Resources::Notify) }
+    attr_reader :notify
+
     sig { returns(PreludeSDK::Resources::Transactional) }
     attr_reader :transactional
 

data/rbi/prelude_sdk/models/notify_get_subscription_config_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifyGetSubscriptionConfigParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::NotifyGetSubscriptionConfigParams,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: PreludeSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: PreludeSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end