prelude-sdk 0.1.0 → 0.2.0

data/rbi/prelude_sdk/models/notify_list_subscription_configs_response.rbi

@@ -0,0 +1,286 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifyListSubscriptionConfigsResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::NotifyListSubscriptionConfigsResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # A list of subscription management configurations.
+      sig do
+        returns(
+          T::Array[
+            PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config
+          ]
+        )
+      end
+      attr_accessor :configs
+
+      # 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(
+          configs:
+            T::Array[
+              PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::OrHash
+            ],
+          next_cursor: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A list of subscription management configurations.
+        configs:,
+        # Pagination cursor for the next page of results. Omitted if there are no more
+        # pages.
+        next_cursor: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            configs:
+              T::Array[
+                PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config
+              ],
+            next_cursor: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Config < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The subscription configuration ID.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The URL to call when subscription status changes.
+        sig { returns(String) }
+        attr_accessor :callback_url
+
+        # The date and time when the configuration was created.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The subscription messages configuration.
+        sig do
+          returns(
+            PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::Messages
+          )
+        end
+        attr_reader :messages
+
+        sig do
+          params(
+            messages:
+              PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::Messages::OrHash
+          ).void
+        end
+        attr_writer :messages
+
+        # The human-readable name for the subscription configuration.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The date and time when the configuration was last updated.
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        # A list of phone numbers for receiving inbound messages.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::MoPhoneNumber
+              ]
+            )
+          )
+        end
+        attr_reader :mo_phone_numbers
+
+        sig do
+          params(
+            mo_phone_numbers:
+              T::Array[
+                PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::MoPhoneNumber::OrHash
+              ]
+          ).void
+        end
+        attr_writer :mo_phone_numbers
+
+        sig do
+          params(
+            id: String,
+            callback_url: String,
+            created_at: Time,
+            messages:
+              PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::Messages::OrHash,
+            name: String,
+            updated_at: Time,
+            mo_phone_numbers:
+              T::Array[
+                PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::MoPhoneNumber::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The subscription configuration ID.
+          id:,
+          # The URL to call when subscription status changes.
+          callback_url:,
+          # The date and time when the configuration was created.
+          created_at:,
+          # The subscription messages configuration.
+          messages:,
+          # The human-readable name for the subscription configuration.
+          name:,
+          # The date and time when the configuration was last updated.
+          updated_at:,
+          # A list of phone numbers for receiving inbound messages.
+          mo_phone_numbers: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              callback_url: String,
+              created_at: Time,
+              messages:
+                PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::Messages,
+              name: String,
+              updated_at: Time,
+              mo_phone_numbers:
+                T::Array[
+                  PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::MoPhoneNumber
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Messages < PreludeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::Messages,
+                PreludeSDK::Internal::AnyHash
+              )
+            end
+
+          # Message sent when user requests help.
+          sig { returns(T.nilable(String)) }
+          attr_reader :help_message
+
+          sig { params(help_message: String).void }
+          attr_writer :help_message
+
+          # Message sent when user subscribes.
+          sig { returns(T.nilable(String)) }
+          attr_reader :start_message
+
+          sig { params(start_message: String).void }
+          attr_writer :start_message
+
+          # Message sent when user unsubscribes.
+          sig { returns(T.nilable(String)) }
+          attr_reader :stop_message
+
+          sig { params(stop_message: String).void }
+          attr_writer :stop_message
+
+          # The subscription messages configuration.
+          sig do
+            params(
+              help_message: String,
+              start_message: String,
+              stop_message: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Message sent when user requests help.
+            help_message: nil,
+            # Message sent when user subscribes.
+            start_message: nil,
+            # Message sent when user unsubscribes.
+            stop_message: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                help_message: String,
+                start_message: String,
+                stop_message: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class MoPhoneNumber < PreludeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::MoPhoneNumber,
+                PreludeSDK::Internal::AnyHash
+              )
+            end
+
+          # The ISO 3166-1 alpha-2 country code.
+          sig { returns(String) }
+          attr_accessor :country_code
+
+          # The phone number in E.164 format for long codes, or short code format for short
+          # codes.
+          sig { returns(String) }
+          attr_accessor :phone_number
+
+          sig do
+            params(country_code: String, phone_number: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The ISO 3166-1 alpha-2 country code.
+            country_code:,
+            # The phone number in E.164 format for long codes, or short code format for short
+            # codes.
+            phone_number:
+          )
+          end
+
+          sig do
+            override.returns({ country_code: String, phone_number: String })
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/notify_list_subscription_phone_number_events_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifyListSubscriptionPhoneNumberEventsParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::NotifyListSubscriptionPhoneNumberEventsParams,
+            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 events to return per page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          config_id: String,
+          cursor: String,
+          limit: Integer,
+          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 events to return per page
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            config_id: String,
+            cursor: String,
+            limit: Integer,
+            request_options: PreludeSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/notify_list_subscription_phone_number_events_response.rbi

@@ -0,0 +1,259 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifyListSubscriptionPhoneNumberEventsResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # A list of subscription events (status changes) ordered by timestamp descending.
+      sig do
+        returns(
+          T::Array[
+            PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event
+          ]
+        )
+      end
+      attr_accessor :events
+
+      # 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(
+          events:
+            T::Array[
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::OrHash
+            ],
+          next_cursor: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A list of subscription events (status changes) ordered by timestamp descending.
+        events:,
+        # Pagination cursor for the next page of results. Omitted if there are no more
+        # pages.
+        next_cursor: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            events:
+              T::Array[
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event
+              ],
+            next_cursor: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Event < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event,
+              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::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source::TaggedSymbol
+          )
+        end
+        attr_accessor :source
+
+        # The subscription state after this event:
+        #
+        # - `SUB` - Subscribed (user can receive marketing messages)
+        # - `UNSUB` - Unsubscribed (user has opted out)
+        sig do
+          returns(
+            PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::State::TaggedSymbol
+          )
+        end
+        attr_accessor :state
+
+        # The date and time when the event occurred.
+        sig { returns(Time) }
+        attr_accessor :timestamp
+
+        # 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::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source::OrSymbol,
+            state:
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::State::OrSymbol,
+            timestamp: 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 after this event:
+          #
+          # - `SUB` - Subscribed (user can receive marketing messages)
+          # - `UNSUB` - Unsubscribed (user has opted out)
+          state:,
+          # The date and time when the event occurred.
+          timestamp:,
+          # 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::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source::TaggedSymbol,
+              state:
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::State::TaggedSymbol,
+              timestamp: 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::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MO_KEYWORD =
+            T.let(
+              :MO_KEYWORD,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source::TaggedSymbol
+            )
+          API =
+            T.let(
+              :API,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source::TaggedSymbol
+            )
+          CSV_IMPORT =
+            T.let(
+              :CSV_IMPORT,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source::TaggedSymbol
+            )
+          CARRIER_DISCONNECT =
+            T.let(
+              :CARRIER_DISCONNECT,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The subscription state after this event:
+        #
+        # - `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::NotifyListSubscriptionPhoneNumberEventsResponse::Event::State
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SUB =
+            T.let(
+              :SUB,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::State::TaggedSymbol
+            )
+          UNSUB =
+            T.let(
+              :UNSUB,
+              PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::State::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::State::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end