prelude-sdk 0.1.0 → 0.3.0

data/rbi/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifyListSubscriptionPhoneNumbersParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::NotifyListSubscriptionPhoneNumbersParams,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :config_id
+
+      # Pagination cursor from the previous response
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # Maximum number of phone numbers to return per page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Filter by subscription state
+      sig do
+        returns(
+          T.nilable(
+            PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::OrSymbol
+          )
+        )
+      end
+      attr_reader :state
+
+      sig do
+        params(
+          state:
+            PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::OrSymbol
+        ).void
+      end
+      attr_writer :state
+
+      sig do
+        params(
+          config_id: String,
+          cursor: String,
+          limit: Integer,
+          state:
+            PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::OrSymbol,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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
+
+      sig do
+        override.returns(
+          {
+            config_id: String,
+            cursor: String,
+            limit: Integer,
+            state:
+              PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::OrSymbol,
+            request_options: PreludeSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Filter by subscription state
+      module State
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SUB =
+          T.let(
+            :SUB,
+            PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::TaggedSymbol
+          )
+        UNSUB =
+          T.let(
+            :UNSUB,
+            PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/notify_list_subscription_phone_numbers_response.rbi

@@ -0,0 +1,259 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifyListSubscriptionPhoneNumbersResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # A list of phone numbers and their subscription statuses.
+      sig do
+        returns(
+          T::Array[
+            PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber
+          ]
+        )
+      end
+      attr_accessor :phone_numbers
+
+      # Pagination cursor for the next page of results. Omitted if there are no more
+      # pages.
+      sig { returns(T.nilable(String)) }
+      attr_reader :next_cursor
+
+      sig { params(next_cursor: String).void }
+      attr_writer :next_cursor
+
+      sig do
+        params(
+          phone_numbers:
+            T::Array[
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::OrHash
+            ],
+          next_cursor: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A list of phone numbers and their subscription statuses.
+        phone_numbers:,
+        # Pagination cursor for the next page of results. Omitted if there are no more
+        # pages.
+        next_cursor: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            phone_numbers:
+              T::Array[
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber
+              ],
+            next_cursor: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class PhoneNumber < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The subscription configuration ID.
+        sig { returns(String) }
+        attr_accessor :config_id
+
+        # The phone number in E.164 format.
+        sig { returns(String) }
+        attr_accessor :phone_number
+
+        # How the subscription state was changed:
+        #
+        # - `MO_KEYWORD` - User sent a keyword (STOP/START)
+        # - `API` - Changed via API
+        # - `CSV_IMPORT` - Imported from CSV
+        # - `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
+        sig do
+          returns(
+            PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source::TaggedSymbol
+          )
+        end
+        attr_accessor :source
+
+        # The subscription state:
+        #
+        # - `SUB` - Subscribed (user can receive marketing messages)
+        # - `UNSUB` - Unsubscribed (user has opted out)
+        sig do
+          returns(
+            PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::State::TaggedSymbol
+          )
+        end
+        attr_accessor :state
+
+        # The date and time when the subscription status was last updated.
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        # Additional context about the state change (e.g., the keyword that was sent).
+        sig { returns(T.nilable(String)) }
+        attr_reader :reason
+
+        sig { params(reason: String).void }
+        attr_writer :reason
+
+        sig do
+          params(
+            config_id: String,
+            phone_number: String,
+            source:
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source::OrSymbol,
+            state:
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::State::OrSymbol,
+            updated_at: Time,
+            reason: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The subscription configuration ID.
+          config_id:,
+          # The phone number in E.164 format.
+          phone_number:,
+          # How the subscription state was changed:
+          #
+          # - `MO_KEYWORD` - User sent a keyword (STOP/START)
+          # - `API` - Changed via API
+          # - `CSV_IMPORT` - Imported from CSV
+          # - `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
+          source:,
+          # The subscription state:
+          #
+          # - `SUB` - Subscribed (user can receive marketing messages)
+          # - `UNSUB` - Unsubscribed (user has opted out)
+          state:,
+          # The date and time when the subscription status was last updated.
+          updated_at:,
+          # Additional context about the state change (e.g., the keyword that was sent).
+          reason: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              config_id: String,
+              phone_number: String,
+              source:
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source::TaggedSymbol,
+              state:
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::State::TaggedSymbol,
+              updated_at: Time,
+              reason: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # How the subscription state was changed:
+        #
+        # - `MO_KEYWORD` - User sent a keyword (STOP/START)
+        # - `API` - Changed via API
+        # - `CSV_IMPORT` - Imported from CSV
+        # - `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
+        module Source
+          extend PreludeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MO_KEYWORD =
+            T.let(
+              :MO_KEYWORD,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source::TaggedSymbol
+            )
+          API =
+            T.let(
+              :API,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source::TaggedSymbol
+            )
+          CSV_IMPORT =
+            T.let(
+              :CSV_IMPORT,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source::TaggedSymbol
+            )
+          CARRIER_DISCONNECT =
+            T.let(
+              :CARRIER_DISCONNECT,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The subscription state:
+        #
+        # - `SUB` - Subscribed (user can receive marketing messages)
+        # - `UNSUB` - Unsubscribed (user has opted out)
+        module State
+          extend PreludeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::State
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SUB =
+            T.let(
+              :SUB,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::State::TaggedSymbol
+            )
+          UNSUB =
+            T.let(
+              :UNSUB,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::State::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::State::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/notify_send_batch_params.rbi

@@ -0,0 +1,241 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifySendBatchParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::NotifySendBatchParams,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # The template identifier configured by your Customer Success team.
+      sig { returns(String) }
+      attr_accessor :template_id
+
+      # The list of recipients' phone numbers in E.164 format.
+      sig { returns(T::Array[String]) }
+      attr_accessor :to
+
+      # The URL where webhooks will be sent for 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 request with your internal systems.
+      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::NotifySendBatchParams::Document)) }
+      attr_reader :document
+
+      sig do
+        params(
+          document: PreludeSDK::NotifySendBatchParams::Document::OrHash
+        ).void
+      end
+      attr_writer :document
+
+      # The message expiration date in RFC3339 format. Messages will not be sent after
+      # this time.
+      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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+
+      sig { params(locale: String).void }
+      attr_writer :locale
+
+      # Preferred channel for delivery. If unavailable, automatic fallback applies.
+      sig do
+        returns(
+          T.nilable(
+            PreludeSDK::NotifySendBatchParams::PreferredChannel::OrSymbol
+          )
+        )
+      end
+      attr_reader :preferred_channel
+
+      sig do
+        params(
+          preferred_channel:
+            PreludeSDK::NotifySendBatchParams::PreferredChannel::OrSymbol
+        ).void
+      end
+      attr_writer :preferred_channel
+
+      # Schedule delivery in RFC3339 format. Marketing sends may be adjusted to comply
+      # with local time windows.
+      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: 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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            template_id: String,
+            to: T::Array[String],
+            callback_url: String,
+            correlation_id: String,
+            document: PreludeSDK::NotifySendBatchParams::Document,
+            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
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::NotifySendBatchParams::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
+
+      # Preferred channel for delivery. If unavailable, automatic fallback applies.
+      module PreferredChannel
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, PreludeSDK::NotifySendBatchParams::PreferredChannel)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SMS =
+          T.let(
+            :sms,
+            PreludeSDK::NotifySendBatchParams::PreferredChannel::TaggedSymbol
+          )
+        WHATSAPP =
+          T.let(
+            :whatsapp,
+            PreludeSDK::NotifySendBatchParams::PreferredChannel::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::NotifySendBatchParams::PreferredChannel::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end