prelude-sdk 0.1.0 → 0.2.0

data/rbi/prelude_sdk/models/notify_get_subscription_config_response.rbi

@@ -0,0 +1,224 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifyGetSubscriptionConfigResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::NotifyGetSubscriptionConfigResponse,
+            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::NotifyGetSubscriptionConfigResponse::Messages
+        )
+      end
+      attr_reader :messages
+
+      sig do
+        params(
+          messages:
+            PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::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::NotifyGetSubscriptionConfigResponse::MoPhoneNumber
+            ]
+          )
+        )
+      end
+      attr_reader :mo_phone_numbers
+
+      sig do
+        params(
+          mo_phone_numbers:
+            T::Array[
+              PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber::OrHash
+            ]
+        ).void
+      end
+      attr_writer :mo_phone_numbers
+
+      sig do
+        params(
+          id: String,
+          callback_url: String,
+          created_at: Time,
+          messages:
+            PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::Messages::OrHash,
+          name: String,
+          updated_at: Time,
+          mo_phone_numbers:
+            T::Array[
+              PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::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::NotifyGetSubscriptionConfigResponse::Messages,
+            name: String,
+            updated_at: Time,
+            mo_phone_numbers:
+              T::Array[
+                PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber
+              ]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Messages < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::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::NotifyGetSubscriptionConfigResponse::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 { override.returns({ country_code: String, phone_number: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/notify_get_subscription_phone_number_params.rbi

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

data/rbi/prelude_sdk/models/notify_get_subscription_phone_number_response.rbi

@@ -0,0 +1,199 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifyGetSubscriptionPhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse,
+            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::NotifyGetSubscriptionPhoneNumberResponse::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::NotifyGetSubscriptionPhoneNumberResponse::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::NotifyGetSubscriptionPhoneNumberResponse::Source::OrSymbol,
+          state:
+            PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::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::NotifyGetSubscriptionPhoneNumberResponse::Source::TaggedSymbol,
+            state:
+              PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::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::NotifyGetSubscriptionPhoneNumberResponse::Source
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MO_KEYWORD =
+          T.let(
+            :MO_KEYWORD,
+            PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::Source::TaggedSymbol
+          )
+        API =
+          T.let(
+            :API,
+            PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::Source::TaggedSymbol
+          )
+        CSV_IMPORT =
+          T.let(
+            :CSV_IMPORT,
+            PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::Source::TaggedSymbol
+          )
+        CARRIER_DISCONNECT =
+          T.let(
+            :CARRIER_DISCONNECT,
+            PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::Source::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::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::NotifyGetSubscriptionPhoneNumberResponse::State
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SUB =
+          T.let(
+            :SUB,
+            PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::State::TaggedSymbol
+          )
+        UNSUB =
+          T.let(
+            :UNSUB,
+            PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::State::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::State::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/notify_list_subscription_configs_params.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class NotifyListSubscriptionConfigsParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::NotifyListSubscriptionConfigsParams,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # 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 configurations to return per page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Pagination cursor from the previous response
+        cursor: nil,
+        # Maximum number of configurations to return per page
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursor: String,
+            limit: Integer,
+            request_options: PreludeSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end