prelude-sdk 0.1.0 → 0.3.0

data/lib/prelude_sdk/models/notify_send_batch_response.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#send_batch
+    class NotifySendBatchResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute error_count
+      #   Number of failed sends.
+      #
+      #   @return [Integer]
+      required :error_count, Integer
+
+      # @!attribute results
+      #   The per-recipient result of the bulk send.
+      #
+      #   @return [Array<PreludeSDK::Models::NotifySendBatchResponse::Result>]
+      required :results,
+               -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::NotifySendBatchResponse::Result] }
+
+      # @!attribute success_count
+      #   Number of successful sends.
+      #
+      #   @return [Integer]
+      required :success_count, Integer
+
+      # @!attribute total_count
+      #   Total number of recipients.
+      #
+      #   @return [Integer]
+      required :total_count, Integer
+
+      # @!attribute callback_url
+      #   The callback URL used for this bulk request, if any.
+      #
+      #   @return [String, nil]
+      optional :callback_url, String
+
+      # @!attribute request_id
+      #   A string that identifies this specific request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute template_id
+      #   The template identifier used for this bulk request.
+      #
+      #   @return [String, nil]
+      optional :template_id, String
+
+      # @!attribute variables
+      #   The variables used for this bulk request.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :variables, PreludeSDK::Internal::Type::HashOf[String]
+
+      # @!method initialize(error_count:, results:, success_count:, total_count:, callback_url: nil, request_id: nil, template_id: nil, variables: nil)
+      #   @param error_count [Integer] Number of failed sends.
+      #
+      #   @param results [Array<PreludeSDK::Models::NotifySendBatchResponse::Result>] The per-recipient result of the bulk send.
+      #
+      #   @param success_count [Integer] Number of successful sends.
+      #
+      #   @param total_count [Integer] Total number of recipients.
+      #
+      #   @param callback_url [String] The callback URL used for this bulk request, if any.
+      #
+      #   @param request_id [String] A string that identifies this specific request.
+      #
+      #   @param template_id [String] The template identifier used for this bulk request.
+      #
+      #   @param variables [Hash{Symbol=>String}] The variables used for this bulk request.
+
+      class Result < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute phone_number
+        #   The recipient's phone number in E.164 format.
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!attribute success
+        #   Whether the message was accepted for delivery.
+        #
+        #   @return [Boolean]
+        required :success, PreludeSDK::Internal::Type::Boolean
+
+        # @!attribute error
+        #   Present only if success is false.
+        #
+        #   @return [PreludeSDK::Models::NotifySendBatchResponse::Result::Error, nil]
+        optional :error, -> { PreludeSDK::Models::NotifySendBatchResponse::Result::Error }
+
+        # @!attribute message
+        #   Present only if success is true.
+        #
+        #   @return [PreludeSDK::Models::NotifySendBatchResponse::Result::Message, nil]
+        optional :message, -> { PreludeSDK::Models::NotifySendBatchResponse::Result::Message }
+
+        # @!method initialize(phone_number:, success:, error: nil, message: nil)
+        #   @param phone_number [String] The recipient's phone number in E.164 format.
+        #
+        #   @param success [Boolean] Whether the message was accepted for delivery.
+        #
+        #   @param error [PreludeSDK::Models::NotifySendBatchResponse::Result::Error] Present only if success is false.
+        #
+        #   @param message [PreludeSDK::Models::NotifySendBatchResponse::Result::Message] Present only if success is true.
+
+        # @see PreludeSDK::Models::NotifySendBatchResponse::Result#error
+        class Error < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute code
+          #   The error code.
+          #
+          #   @return [String, nil]
+          optional :code, String
+
+          # @!attribute message
+          #   A human-readable error message.
+          #
+          #   @return [String, nil]
+          optional :message, String
+
+          # @!method initialize(code: nil, message: nil)
+          #   Present only if success is false.
+          #
+          #   @param code [String] The error code.
+          #
+          #   @param message [String] A human-readable error message.
+        end
+
+        # @see PreludeSDK::Models::NotifySendBatchResponse::Result#message
+        class Message < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The message identifier.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute correlation_id
+          #   The correlation identifier for the message.
+          #
+          #   @return [String, nil]
+          optional :correlation_id, String
+
+          # @!attribute created_at
+          #   The message creation date in RFC3339 format.
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute encoding
+          #   The SMS encoding type based on message content. GSM-7 supports standard
+          #   characters (up to 160 chars per segment), while UCS-2 supports Unicode including
+          #   emoji (up to 70 chars per segment). Only present for SMS messages.
+          #
+          #   @return [Symbol, PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding, nil]
+          optional :encoding, enum: -> { PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding }
+
+          # @!attribute estimated_segment_count
+          #   The estimated number of SMS segments for this message. This value is not
+          #   contractual; the actual segment count will be determined after the SMS is sent
+          #   by the provider. Only present for SMS messages.
+          #
+          #   @return [Integer, nil]
+          optional :estimated_segment_count, Integer
+
+          # @!attribute expires_at
+          #   The message expiration date in RFC3339 format.
+          #
+          #   @return [Time, nil]
+          optional :expires_at, Time
+
+          # @!attribute from
+          #   The Sender ID used for this message.
+          #
+          #   @return [String, nil]
+          optional :from, String
+
+          # @!attribute locale
+          #   The locale used for the message, if any.
+          #
+          #   @return [String, nil]
+          optional :locale, String
+
+          # @!attribute schedule_at
+          #   When the message will actually be sent in RFC3339 format with timezone offset.
+          #
+          #   @return [Time, nil]
+          optional :schedule_at, Time
+
+          # @!attribute to
+          #   The recipient's phone number in E.164 format.
+          #
+          #   @return [String, nil]
+          optional :to, String
+
+          # @!method initialize(id: nil, correlation_id: nil, created_at: nil, encoding: nil, estimated_segment_count: nil, expires_at: nil, from: nil, locale: nil, schedule_at: nil, to: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PreludeSDK::Models::NotifySendBatchResponse::Result::Message} for more details.
+          #
+          #   Present only if success is true.
+          #
+          #   @param id [String] The message identifier.
+          #
+          #   @param correlation_id [String] The correlation identifier for the message.
+          #
+          #   @param created_at [Time] The message creation date in RFC3339 format.
+          #
+          #   @param encoding [Symbol, PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding] The SMS encoding type based on message content. GSM-7 supports standard characte
+          #
+          #   @param estimated_segment_count [Integer] The estimated number of SMS segments for this message. This value is not contrac
+          #
+          #   @param expires_at [Time] The message expiration date in RFC3339 format.
+          #
+          #   @param from [String] The Sender ID used for this message.
+          #
+          #   @param locale [String] The locale used for the message, if any.
+          #
+          #   @param schedule_at [Time] When the message will actually be sent in RFC3339 format with timezone offset.
+          #
+          #   @param to [String] The recipient's phone number in E.164 format.
+
+          # The SMS encoding type based on message content. GSM-7 supports standard
+          # characters (up to 160 chars per segment), while UCS-2 supports Unicode including
+          # emoji (up to 70 chars per segment). Only present for SMS messages.
+          #
+          # @see PreludeSDK::Models::NotifySendBatchResponse::Result::Message#encoding
+          module Encoding
+            extend PreludeSDK::Internal::Type::Enum
+
+            GSM_7 = :"GSM-7"
+            UCS_2 = :"UCS-2"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_send_params.rb

@@ -0,0 +1,149 @@
+# 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 document
+      #   A document to attach to the message. Only supported on WhatsApp templates that
+      #   have a document header.
+      #
+      #   @return [PreludeSDK::Models::NotifySendParams::Document, nil]
+      optional :document, -> { PreludeSDK::NotifySendParams::Document }
+
+      # @!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, document: 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 document [PreludeSDK::Models::NotifySendParams::Document] A document to attach to the message. Only supported on WhatsApp templates that h
+      #
+      #   @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}]
+
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute filename
+        #   The filename to display for the document.
+        #
+        #   @return [String]
+        required :filename, String
+
+        # @!attribute url
+        #   The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(filename:, url:)
+        #   A document to attach to the message. Only supported on WhatsApp templates that
+        #   have a document header.
+        #
+        #   @param filename [String] The filename to display for the document.
+        #
+        #   @param url [String] The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
+      end
+
+      # 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,129 @@
+# 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 encoding
+      #   The SMS encoding type based on message content. GSM-7 supports standard
+      #   characters (up to 160 chars per segment), while UCS-2 supports Unicode including
+      #   emoji (up to 70 chars per segment). Only present for SMS messages.
+      #
+      #   @return [Symbol, PreludeSDK::Models::NotifySendResponse::Encoding, nil]
+      optional :encoding, enum: -> { PreludeSDK::Models::NotifySendResponse::Encoding }
+
+      # @!attribute estimated_segment_count
+      #   The estimated number of SMS segments for this message. This value is not
+      #   contractual; the actual segment count will be determined after the SMS is sent
+      #   by the provider. Only present for SMS messages.
+      #
+      #   @return [Integer, nil]
+      optional :estimated_segment_count, Integer
+
+      # @!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, encoding: nil, estimated_segment_count: 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 encoding [Symbol, PreludeSDK::Models::NotifySendResponse::Encoding] The SMS encoding type based on message content. GSM-7 supports standard characte
+      #
+      #   @param estimated_segment_count [Integer] The estimated number of SMS segments for this message. This value is not contrac
+      #
+      #   @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
+
+      # The SMS encoding type based on message content. GSM-7 supports standard
+      # characters (up to 160 chars per segment), while UCS-2 supports Unicode including
+      # emoji (up to 70 chars per segment). Only present for SMS messages.
+      #
+      # @see PreludeSDK::Models::NotifySendResponse#encoding
+      module Encoding
+        extend PreludeSDK::Internal::Type::Enum
+
+        GSM_7 = :"GSM-7"
+        UCS_2 = :"UCS-2"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/transactional_send_params.rb

@@ -33,6 +33,13 @@ module PreludeSDK
       #   @return [String, nil]
       optional :correlation_id, String
 
+      # @!attribute document
+      #   A document to attach to the message. Only supported on WhatsApp templates that
+      #   have a document header.
+      #
+      #   @return [PreludeSDK::Models::TransactionalSendParams::Document, nil]
+      optional :document, -> { PreludeSDK::TransactionalSendParams::Document }
+
       # @!attribute expires_at
       #   The message expiration date.
       #
@@ -74,7 +81,7 @@ module PreludeSDK
       #   @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, variables: nil, request_options: {})
+      # @!method initialize(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, variables: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::TransactionalSendParams} for more details.
       #
@@ -86,6 +93,8 @@ module PreludeSDK
       #
       #   @param correlation_id [String] A user-defined identifier to correlate this transactional message with. It is re
       #
+      #   @param document [PreludeSDK::Models::TransactionalSendParams::Document] A document to attach to the message. Only supported on WhatsApp templates that h
+      #
       #   @param expires_at [String] The message expiration date.
       #
       #   @param from [String] The Sender ID.
@@ -98,6 +107,28 @@ module PreludeSDK
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
 
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute filename
+        #   The filename to display for the document.
+        #
+        #   @return [String]
+        required :filename, String
+
+        # @!attribute url
+        #   The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(filename:, url:)
+        #   A document to attach to the message. Only supported on WhatsApp templates that
+        #   have a document header.
+        #
+        #   @param filename [String] The filename to display for the document.
+        #
+        #   @param url [String] The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
+      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.