prelude-sdk 0.1.0 → 0.3.0

data/rbi/prelude_sdk/models/notify_send_batch_response.rbi

@@ -0,0 +1,440 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifySendBatchResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::NotifySendBatchResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # Number of failed sends.
+      sig { returns(Integer) }
+      attr_accessor :error_count
+
+      # The per-recipient result of the bulk send.
+      sig do
+        returns(T::Array[PreludeSDK::Models::NotifySendBatchResponse::Result])
+      end
+      attr_accessor :results
+
+      # Number of successful sends.
+      sig { returns(Integer) }
+      attr_accessor :success_count
+
+      # Total number of recipients.
+      sig { returns(Integer) }
+      attr_accessor :total_count
+
+      # The callback URL used for this bulk request, if any.
+      sig { returns(T.nilable(String)) }
+      attr_reader :callback_url
+
+      sig { params(callback_url: String).void }
+      attr_writer :callback_url
+
+      # A string that identifies this specific request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      # The template identifier used for this bulk request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :template_id
+
+      sig { params(template_id: String).void }
+      attr_writer :template_id
+
+      # The variables used for this bulk request.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :variables
+
+      sig { params(variables: T::Hash[Symbol, String]).void }
+      attr_writer :variables
+
+      sig do
+        params(
+          error_count: Integer,
+          results:
+            T::Array[
+              PreludeSDK::Models::NotifySendBatchResponse::Result::OrHash
+            ],
+          success_count: Integer,
+          total_count: Integer,
+          callback_url: String,
+          request_id: String,
+          template_id: String,
+          variables: T::Hash[Symbol, String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Number of failed sends.
+        error_count:,
+        # The per-recipient result of the bulk send.
+        results:,
+        # Number of successful sends.
+        success_count:,
+        # Total number of recipients.
+        total_count:,
+        # The callback URL used for this bulk request, if any.
+        callback_url: nil,
+        # A string that identifies this specific request.
+        request_id: nil,
+        # The template identifier used for this bulk request.
+        template_id: nil,
+        # The variables used for this bulk request.
+        variables: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            error_count: Integer,
+            results:
+              T::Array[PreludeSDK::Models::NotifySendBatchResponse::Result],
+            success_count: Integer,
+            total_count: Integer,
+            callback_url: String,
+            request_id: String,
+            template_id: String,
+            variables: T::Hash[Symbol, String]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Result < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::NotifySendBatchResponse::Result,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The recipient's phone number in E.164 format.
+        sig { returns(String) }
+        attr_accessor :phone_number
+
+        # Whether the message was accepted for delivery.
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        # Present only if success is false.
+        sig do
+          returns(
+            T.nilable(
+              PreludeSDK::Models::NotifySendBatchResponse::Result::Error
+            )
+          )
+        end
+        attr_reader :error
+
+        sig do
+          params(
+            error:
+              PreludeSDK::Models::NotifySendBatchResponse::Result::Error::OrHash
+          ).void
+        end
+        attr_writer :error
+
+        # Present only if success is true.
+        sig do
+          returns(
+            T.nilable(
+              PreludeSDK::Models::NotifySendBatchResponse::Result::Message
+            )
+          )
+        end
+        attr_reader :message
+
+        sig do
+          params(
+            message:
+              PreludeSDK::Models::NotifySendBatchResponse::Result::Message::OrHash
+          ).void
+        end
+        attr_writer :message
+
+        sig do
+          params(
+            phone_number: String,
+            success: T::Boolean,
+            error:
+              PreludeSDK::Models::NotifySendBatchResponse::Result::Error::OrHash,
+            message:
+              PreludeSDK::Models::NotifySendBatchResponse::Result::Message::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The recipient's phone number in E.164 format.
+          phone_number:,
+          # Whether the message was accepted for delivery.
+          success:,
+          # Present only if success is false.
+          error: nil,
+          # Present only if success is true.
+          message: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              phone_number: String,
+              success: T::Boolean,
+              error: PreludeSDK::Models::NotifySendBatchResponse::Result::Error,
+              message:
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Error < PreludeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Error,
+                PreludeSDK::Internal::AnyHash
+              )
+            end
+
+          # The error code.
+          sig { returns(T.nilable(String)) }
+          attr_reader :code
+
+          sig { params(code: String).void }
+          attr_writer :code
+
+          # A human-readable error message.
+          sig { returns(T.nilable(String)) }
+          attr_reader :message
+
+          sig { params(message: String).void }
+          attr_writer :message
+
+          # Present only if success is false.
+          sig do
+            params(code: String, message: String).returns(T.attached_class)
+          end
+          def self.new(
+            # The error code.
+            code: nil,
+            # A human-readable error message.
+            message: nil
+          )
+          end
+
+          sig { override.returns({ code: String, message: String }) }
+          def to_hash
+          end
+        end
+
+        class Message < PreludeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message,
+                PreludeSDK::Internal::AnyHash
+              )
+            end
+
+          # The message identifier.
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          # The correlation identifier for the message.
+          sig { returns(T.nilable(String)) }
+          attr_reader :correlation_id
+
+          sig { params(correlation_id: String).void }
+          attr_writer :correlation_id
+
+          # The message creation date in RFC3339 format.
+          sig { returns(T.nilable(Time)) }
+          attr_reader :created_at
+
+          sig { params(created_at: Time).void }
+          attr_writer :created_at
+
+          # 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.
+          sig do
+            returns(
+              T.nilable(
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :encoding
+
+          sig do
+            params(
+              encoding:
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::OrSymbol
+            ).void
+          end
+          attr_writer :encoding
+
+          # 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.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :estimated_segment_count
+
+          sig { params(estimated_segment_count: Integer).void }
+          attr_writer :estimated_segment_count
+
+          # The message expiration date in RFC3339 format.
+          sig { returns(T.nilable(Time)) }
+          attr_reader :expires_at
+
+          sig { params(expires_at: Time).void }
+          attr_writer :expires_at
+
+          # The Sender ID used for this message.
+          sig { returns(T.nilable(String)) }
+          attr_reader :from
+
+          sig { params(from: String).void }
+          attr_writer :from
+
+          # The locale used for the message, if any.
+          sig { returns(T.nilable(String)) }
+          attr_reader :locale
+
+          sig { params(locale: String).void }
+          attr_writer :locale
+
+          # When the message will actually be sent in RFC3339 format with timezone offset.
+          sig { returns(T.nilable(Time)) }
+          attr_reader :schedule_at
+
+          sig { params(schedule_at: Time).void }
+          attr_writer :schedule_at
+
+          # The recipient's phone number in E.164 format.
+          sig { returns(T.nilable(String)) }
+          attr_reader :to
+
+          sig { params(to: String).void }
+          attr_writer :to
+
+          # Present only if success is true.
+          sig do
+            params(
+              id: String,
+              correlation_id: String,
+              created_at: Time,
+              encoding:
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::OrSymbol,
+              estimated_segment_count: Integer,
+              expires_at: Time,
+              from: String,
+              locale: String,
+              schedule_at: Time,
+              to: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The message identifier.
+            id: nil,
+            # The correlation identifier for the message.
+            correlation_id: nil,
+            # The message creation date in RFC3339 format.
+            created_at: nil,
+            # 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.
+            encoding: nil,
+            # 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.
+            estimated_segment_count: nil,
+            # The message expiration date in RFC3339 format.
+            expires_at: nil,
+            # The Sender ID used for this message.
+            from: nil,
+            # The locale used for the message, if any.
+            locale: nil,
+            # When the message will actually be sent in RFC3339 format with timezone offset.
+            schedule_at: nil,
+            # The recipient's phone number in E.164 format.
+            to: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                correlation_id: String,
+                created_at: Time,
+                encoding:
+                  PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::TaggedSymbol,
+                estimated_segment_count: Integer,
+                expires_at: Time,
+                from: String,
+                locale: String,
+                schedule_at: Time,
+                to: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # 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.
+          module Encoding
+            extend PreludeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            GSM_7 =
+              T.let(
+                :"GSM-7",
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::TaggedSymbol
+              )
+            UCS_2 =
+              T.let(
+                :"UCS-2",
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/notify_send_params.rbi

@@ -0,0 +1,249 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifySendParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(PreludeSDK::NotifySendParams, PreludeSDK::Internal::AnyHash)
+        end
+
+      # The template identifier configured by your Customer Success team.
+      sig { returns(String) }
+      attr_accessor :template_id
+
+      # The recipient's phone number in E.164 format.
+      sig { returns(String) }
+      attr_accessor :to
+
+      # The URL where webhooks will be sent for message delivery events.
+      sig { returns(T.nilable(String)) }
+      attr_reader :callback_url
+
+      sig { params(callback_url: String).void }
+      attr_writer :callback_url
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # A document to attach to the message. Only supported on WhatsApp templates that
+      # have a document header.
+      sig { returns(T.nilable(PreludeSDK::NotifySendParams::Document)) }
+      attr_reader :document
+
+      sig do
+        params(document: PreludeSDK::NotifySendParams::Document::OrHash).void
+      end
+      attr_writer :document
+
+      # The message expiration date in RFC3339 format. The message will not be sent if
+      # this time is reached.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :expires_at
+
+      sig { params(expires_at: Time).void }
+      attr_writer :expires_at
+
+      # The Sender ID. Must be approved for your account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :from
+
+      sig { params(from: String).void }
+      attr_writer :from
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+
+      sig { params(locale: String).void }
+      attr_writer :locale
+
+      # The preferred channel to be used in priority for message delivery. If the
+      # channel is unavailable, the system will fallback to other available channels.
+      sig do
+        returns(
+          T.nilable(PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol)
+        )
+      end
+      attr_reader :preferred_channel
+
+      sig do
+        params(
+          preferred_channel:
+            PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol
+        ).void
+      end
+      attr_writer :preferred_channel
+
+      # 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.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :schedule_at
+
+      sig { params(schedule_at: Time).void }
+      attr_writer :schedule_at
+
+      # The variables to be replaced in the template.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :variables
+
+      sig { params(variables: T::Hash[Symbol, String]).void }
+      attr_writer :variables
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            template_id: String,
+            to: String,
+            callback_url: String,
+            correlation_id: String,
+            document: PreludeSDK::NotifySendParams::Document,
+            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
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::NotifySendParams::Document,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The filename to display for the document.
+        sig { returns(String) }
+        attr_accessor :filename
+
+        # The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
+        sig { returns(String) }
+        attr_accessor :url
+
+        # A document to attach to the message. Only supported on WhatsApp templates that
+        # have a document header.
+        sig { params(filename: String, url: String).returns(T.attached_class) }
+        def self.new(
+          # The filename to display for the document.
+          filename:,
+          # The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
+          url:
+        )
+        end
+
+        sig { override.returns({ filename: String, url: String }) }
+        def to_hash
+        end
+      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
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, PreludeSDK::NotifySendParams::PreferredChannel)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SMS =
+          T.let(
+            :sms,
+            PreludeSDK::NotifySendParams::PreferredChannel::TaggedSymbol
+          )
+        WHATSAPP =
+          T.let(
+            :whatsapp,
+            PreludeSDK::NotifySendParams::PreferredChannel::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::NotifySendParams::PreferredChannel::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end